module.string.md

---

title: module.string
labels:
  stage: beta

---

module.string

{{< docs/shared lookup="flow/stability/beta.md" source="agent" >}}

module.string is a module loader component. A module loader is a Grafana Agent Flow component which retrieves a [module][] and runs the components defined inside of it.

[module]: {{< relref "../../concepts/modules.md" >}}

Usage

module.string "LABEL" {
  content = CONTENT

  arguments {
    MODULE_ARGUMENT_1 = VALUE_1
    MODULE_ARGUMENT_2 = VALUE_2
    ...
  }
}

Arguments

The following arguments are supported:

Name	Type	Description	Default	Required
content	secret or string	The contents of the module to load as a secret or string.		yes

content is a string that contains the configuration of the module to load. content is typically loaded by using the exports of another component. For example,

• local.file.LABEL.content

• remote.http.LABEL.content

• remote.s3.LABEL.content

Blocks

The following blocks are supported inside the definition of module.string:

Hierarchy	Block	Description	Required
arguments	arguments	Arguments to pass to the module.	no

arguments block

The arguments block specifies the list of values to pass to the loaded module.

The attributes provided in the arguments block are validated based on the [argument blocks][] defined in the module source:

• If a module source marks one of its arguments as required, it must be provided as an attribute in the arguments block of the module loader.

• Attributes in the argument block of the module loader will be rejected if they are not defined in the module source.

[argument blocks]: {{< relref "../config-blocks/argument.md" >}}

Exported fields

The following fields are exported and can be referenced by other components:

Name	Type	Description
exports	map(any)	The exports of the Module loader.

exports exposes the export config block inside a module. It can be accessed from the parent config via module.string.LABEL.exports.EXPORT_LABEL.

Values in exports correspond to [export blocks][] defined in the module source.

[export blocks]: {{< relref "../config-blocks/export.md" >}}

Component health

module.string is reported as healthy if the most recent load of the module was successful.

If the module is not loaded successfully, the current health displays as unhealthy and the health includes the error from loading the module.

Debug information

module.string does not expose any component-specific debug information.

Debug metrics

module.string does not expose any component-specific debug metrics.

Example

In this example, we pass credentials from a parent config to a module which loads a prometheus.remote_write component. The exports of the prometheus.remote_write component are exposed to parent config, allowing the parent config to pass metrics to it.

Parent:

local.file "metrics" {
  filename = "/path/to/prometheus_remote_write_module.river"
}

module.string "metrics" {
  content = local.file.metrics.content

  arguments {
    username = env("PROMETHEUS_USERNAME")
    password = env("PROMETHEUS_PASSWORD")
  }
}

prometheus.exporter.unix { }

prometheus.scrape "local_agent" {
  targets         = prometheus.exporter.unix.targets
  forward_to      = [module.string.metrics.exports.prometheus_remote_write.receiver]
  scrape_interval = "10s"
}

Module:

argument "username" { }

argument "password" { }

export "prometheus_remote_write" {
  value = prometheus.remote_write.grafana_cloud
}

prometheus.remote_write "grafana_cloud" {
  endpoint {
    url = "https://prometheus-us-central1.grafana.net/api/prom/push"

    basic_auth {
      username = argument.username.value
      password = argument.password.value
    }
  }
}