Grafana Agent Flow mode Reference Components prometheus.exporter.​consul
Open source


The prometheus.exporter.consul component embeds consul_exporter for collecting metrics from a consul instal.


prometheus.exporter.consul "LABEL" {


The following arguments can be used to configure the exporter’s behavior. All arguments are optional. Omitted fields take their default values.

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

Exported fields

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

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

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

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 does not expose any component-specific debug information.

Debug metrics

prometheus.exporter.consul does not expose any component-specific debug metrics.


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

prometheus.exporter.consul "example" {
  server = ""

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