Caution
Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.
consul_exporter_config
The consul_exporter_config
block configures the consul_exporter
integration, which is an embedded version of
consul_exporter
. This allows
for the collection of consul metrics and exposing them as Prometheus metrics.
Full reference of options:
# Enables the consul_exporter integration, allowing the Agent to automatically
# collect system metrics from the configured consul server address
[enabled: <boolean> | default = false]
# Sets an explicit value for the instance label when the integration is
# self-scraped. Overrides inferred values.
#
# The default value for this integration is inferred from the hostname portion
# of the server URL.
[instance: <string>]
# Automatically collect metrics from this integration. If disabled,
# the consul_exporter integration will be run but not scraped and thus not
# remote-written. Metrics for the integration will be exposed at
# /integrations/consul_exporter/metrics and can be scraped by an external
# process.
[scrape_integration: <boolean> | default = <integrations_config.scrape_integrations>]
# How often should the metrics be collected? Defaults to
# prometheus.global.scrape_interval.
[scrape_interval: <duration> | default = <global_config.scrape_interval>]
# The timeout before considering the scrape a failure. Defaults to
# prometheus.global.scrape_timeout.
[scrape_timeout: <duration> | default = <global_config.scrape_timeout>]
# Allows for relabeling labels on the target.
relabel_configs:
[- <relabel_config> ... ]
# Relabel metrics coming from the integration, allowing to drop series
# from the integration that you don't care about.
metric_relabel_configs:
[ - <relabel_config> ... ]
# How frequent to truncate the WAL for this integration.
[wal_truncate_frequency: <duration> | default = "60m"]
#
# Exporter-specific configuration options
#
# Prefix from which to expose key/value pairs.
[kv_prefix: <string> | default = ""]
# Regex that determines which keys to expose.
[kv_filter: <string> | default = ".*"]
# Generate a health summary for each service instance. Needs n+1 queries to
# collect all information.
[generate_health_summary: <bool> | default = true]
# HTTP API address of a Consul server or agent. Prefix with https:// to
# connect using HTTPS.
[server: <string> | default = "http://localhost:8500"]
# Disable TLS host verification.
[insecure_skip_verify: <bool> | default = false]
# File path to a PEM-encoded certificate authority used to validate the
# authenticity of a server certificate.
[ca_file: <string> | default = ""]
# File path to a PEM-encoded certificate used with the private key to verify
# the exporter's authenticity.
[cert_file: <string> | default = ""]
# File path to a PEM-encoded private key used with the certificate to verify
# the exporter's authenticity.
[key_file: <string> | default = ""]
# When provided, this overrides the hostname for the TLS certificate. It can
# be used to ensure that the certificate name matches the hostname we declare.
[server_name: <string> | default = ""]
# Timeout on HTTP requests to the Consul API.
[timeout: <duration> | default = "500ms"]
# Limit the maximum number of concurrent requests to consul. 0 means no limit.
[concurrent_request_limit: <int> | default = 0]
# Allows any Consul server (non-leader) to service a read.
[allow_stale: <bool> | default = true]
# Forces the read to be fully consistent.
[require_consistent: <bool> | default = false]