This is documentation for the next version of Grafana Alloy Documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana Alloybreadcrumb arrow Referencebreadcrumb arrow Componentsbreadcrumb arrow prometheusbreadcrumb arrow prometheus.exporter.consul
General availability (GA) Open source

prometheus.exporter.consul

The prometheus.exporter.consul component embeds the consul_exporter for collecting metrics from a Consul installation.

Usage

alloy 
prometheus.exporter.consul "<LABEL>" {
}

Arguments

You can use the following arguments with prometheus.exporter.consul:

NameTypeDescriptionDefaultRequired
allow_staleboolAllows any Consul server (non-leader) to service a read.trueno
ca_filestringFile path to a PEM-encoded certificate authority used to validate the authenticity of a server certificate.no
cert_filestringFile path to a PEM-encoded certificate used with the private key to verify the exporter’s authenticity.no
concurrent_request_limitstringLimit the maximum number of concurrent requests to consul, 0 means no limit.no
generate_health_summaryboolCollects information about each registered service and exports consul_catalog_service_node_healthy.trueno
insecure_skip_verifyboolDisable TLS host verification.falseno
key_filestringFile path to a PEM-encoded private key used with the certificate to verify the exporter’s authenticity.no
kv_filterstringOnly store keys that match this regular expression pattern.".*"no
kv_prefixstringPrefix under which to look for KV pairs.no
require_consistentboolForces the read to be fully consistent.no
server_namestringWhen provided, this overrides the hostname for the TLS certificate. It can be used to ensure that the certificate name matches the hostname you declare.no
serverstringAddress (host and port) of the Consul instance to connect to. This could be a local Alloy (localhost:8500), or the address of a Consul server."http://localhost:8500"no
timeoutdurationTimeout on HTTP requests to consul."500ms"no

Blocks

The prometheus.exporter.consul component doesn’t support any blocks. You can configure this component with arguments.

Exported fields

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

NameTypeDescription
targetslist(map(string))The targets that can be used to collect exporter metrics.

For example, the targets can either be passed to a discovery.relabel component to rewrite the targets’ label sets or to a prometheus.scrape component that collects the exposed metrics.

The exported targets use the configured in-memory traffic address specified by the run command.

Component health

prometheus.exporter.consul is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.consul doesn’t expose any component-specific debug information.

Debug metrics

prometheus.exporter.consul doesn’t expose any component-specific debug metrics.

Example

The following example uses a prometheus.scrape component to collect metrics from prometheus.exporter.consul:

alloy 
prometheus.exporter.consul "example" {
  server = "https://consul.example.com:8500"
}

// Configure a prometheus.scrape component to collect consul metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.consul.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}

Replace the following:

  • <PROMETHEUS_REMOTE_WRITE_URL>: The URL of the Prometheus remote_write compatible server to send metrics to.
  • <USERNAME>: The username to use for authentication to the remote_write API.
  • <PASSWORD>: The password to use for authentication to the remote_write API.

Compatible components

prometheus.exporter.consul has exports that can be consumed by the following components:

Note

Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.