Consul Exporter

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:

  1.   # Enables the consul_exporter integration, allowing the Agent to automatically
  2.   # collect system metrics from the configured consul server address
  3.   [enabled: <boolean> | default = false]
  5.   # Sets an explicit value for the instance label when the integration is
  6.   # self-scraped. Overrides inferred values.
  7.   #
  8.   # The default value for this integration is inferred from the hostname portion
  9.   # of the server URL.
  10.   [instance: <string>]
  12.   # Automatically collect metrics from this integration. If disabled,
  13.   # the consul_exporter integration will be run but not scraped and thus not
  14.   # remote-written. Metrics for the integration will be exposed at
  15.   # /integrations/consul_exporter/metrics and can be scraped by an external
  16.   # process.
  17.   [scrape_integration: <boolean> | default = <integrations_config.scrape_integrations>]
  19.   # How often should the metrics be collected? Defaults to
  20.   # prometheus.global.scrape_interval.
  21.   [scrape_interval: <duration> | default = <global_config.scrape_interval>]
  23.   # The timeout before considering the scrape a failure. Defaults to
  24.   # prometheus.global.scrape_timeout.
  25.   [scrape_timeout: <duration> | default = <global_config.scrape_timeout>]
  27.   # Allows for relabeling labels on the target.
  28.   relabel_configs:
  29.     [- <relabel_config> ... ]
  31.   # Relabel metrics coming from the integration, allowing to drop series
  32.   # from the integration that you don't care about.
  33.   metric_relabel_configs:
  34.     [ - <relabel_config> ... ]
  36.   # How frequent to truncate the WAL for this integration.
  37.   [wal_truncate_frequency: <duration> | default = "60m"]
  39.   # Monitor the exporter itself and include those metrics in the results.
  40.   [include_exporter_metrics: <bool> | default = false]
  42.   #
  43.   # Exporter-specific configuration options
  44.   #
  46.   # Prefix from which to expose key/value pairs.
  47.   [kv_prefix: <string> | default = ""]
  49.   # Regex that determines which keys to expose.
  50.   [kv_filter: <string> | default = ".*"]
  52.   # Generate a health summary for each service instance. Needs n+1 queries to
  53.   # collect all information.
  54.   [generate_health_summary: <bool> | default = true]
  56.   # HTTP API address of a Consul server or agent. Prefix with https:// to
  57.   # connect using HTTPS.
  58.   [server: <string> | default = "http://localhost:8500"]
  60.   # Disable TLS host verification.
  61.   [insecure_skip_verify: <bool> | default = false]
  63.   # File path to a PEM-encoded certificate authority used to validate the
  64.   # authenticity of a server certificate.
  65.   [ca_file: <string> | default = ""]
  67.   # File path to a PEM-encoded certificate used with the private key to verify
  68.   # the exporter's authenticity.
  69.   [cert_file: <string> | default = ""]
  71.   # File path to a PEM-encoded private key used with the certificate to verify
  72.   # the exporter's authenticity.
  73.   [key_file: <string> | default = ""]
  75.   # When provided, this overrides the hostname for the TLS certificate. It can
  76.   # be used to ensure that the certificate name matches the hostname we declare.
  77.   [server_name: <string> | default = ""]
  79.   # Timeout on HTTP requests to the Consul API.
  80.   [timeout: <duration> | default = "500ms"]
  82.   # Limit the maximum number of concurrent requests to consul. 0 means no limit.
  83.   [concurrent_request_limit: <int> | default = 0]
  85.   # Allows any Consul server (non-leader) to service a read.
  86.   [allow_stale: <bool> | default = true]
  88.   # Forces the read to be fully consistent.
  89.   [require_consistent: <bool> | default = false]

采集的指标列表

  1. consul_memberlist_tcp : irate(consul_memberlist_tcp{host="$consul"}[1m])
  2. consul_memberlist_udp : irate(consul_memberlist_udp{host="$consul"}[1m])
  3. consul_raft_apply[30s]) : delta(consul_raft_apply[30s])
  4. consul_raft_commitTime : consul_raft_commitTime
  5. consul_raft_leader_dispatchLog : consul_raft_leader_dispatchLog
  6. consul_raft_leader_lastcontact : consul_raft_leader_lastcontact
  7. consul_raft_leader_lastcontact_count : consul_raft_leader_lastcontact_count
  8. consul_raft_replication_appendEntries_rpc : consul_raft_replication_appendEntries_rpc
  9. consul_raft_replication_heartbeat : consul_raft_replication_heartbeat
  10. consul_rpc_query : delta(consul_rpc_query{host="$consul"}[30s])
  11. consul_serf_coordinate_adjustment_ms : consul_serf_coordinate_adjustment_ms{host="$consul"}
  12. labels) : COUNT (changes(consul_memberlist_gossep_sum[1m]) > 0) BY (labels)
  13. node_cpu : sum(irate(node_cpu{mode="idle", host="$consul"}[1m])) * 100 / count_scalar(node_cpu{mode="user", host="$consul"})
  14. node_load1 : node_load1{host="$consul"}
  15. node_load15 : node_load15{host="$consul"}
  16. node_load5 : node_load5{host="$consul"}