prometheus.prometheus.consul_exporter role – Prometheus consul Exporter

Note

This role is part of the prometheus.prometheus collection (version 0.26.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install prometheus.prometheus.

To use it in a playbook, specify: prometheus.prometheus.consul_exporter.

Entry point main – Prometheus consul Exporter

Synopsis

Parameters

Parameter

Comments

consul_exporter_agent_only

boolean

Only export metrics about services registered on local agent

Choices:

  • false ← (default)

  • true

consul_exporter_allow_stale

boolean

Allows any Consul server (non-leader) to service a read

Choices:

  • false ← (default)

  • true

consul_exporter_basic_auth_users

dictionary

Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.

consul_exporter_binary_install_dir

string

Advanced

Directory to install binaries

Default: "/usr/local/bin"

consul_exporter_binary_url

string

URL of the consul_exporter binaries .tar.gz file

Default: "https://github.com/{{ _consul_exporter_repo }}/releases/download/v{{ consul_exporter_version }}/consul_exporter-{{ consul_exporter_version }}.{{ ansible_facts['system'] | lower }}-{{ _consul_exporter_go_ansible_arch }}.tar.gz"

consul_exporter_checksums_url

string

URL of the consul_exporter checksums file

Default: "https://github.com/{{ _consul_exporter_repo }}/releases/download/v{{ consul_exporter_version }}/sha256sums.txt"

consul_exporter_config_dir

string

Path to directory with consul_exporter configuration

Default: "/etc/consul_exporter"

consul_exporter_health_summary

boolean

Generate a health summary for each service instance. Needs n+1 queries to collect all information.

Choices:

  • false ← (default)

  • true

consul_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in consul_exporter docs.

consul_exporter_kv_filter

string

Regex that determines which keys to expose

consul_exporter_kv_prefix

string

Prefix from which to expose key/value pairs

consul_exporter_local_cache_path

string

Local path to stash the archive and its extraction

Default: "/tmp/consul_exporter-{{ ansible_facts['system'] | lower }}-{{ _consul_exporter_go_ansible_arch }}/{{ consul_exporter_version }}"

consul_exporter_log_format

string

Output format of log messages

Choices:

  • "logfmt" ← (default)

  • "json"

consul_exporter_log_level

string

Only log messages with the given severity or above

Choices:

  • "debug"

  • "info" ← (default)

  • "warn"

  • "error"

consul_exporter_meta_filter

string

Regex that determines which meta keys to expose

consul_exporter_request_limit

string

Limit the maximum number of concurrent requests to consul, 0 means no limit

Default: 0

consul_exporter_require_consistent

boolean

Forces the read to be fully consistent

Choices:

  • false ← (default)

  • true

consul_exporter_server

string

HTTP API address of a Consul server or agent.

Default: "http://localhost:8500"

consul_exporter_system_group

string

Advanced

System group for consul_exporter

Default: "consul-exp"

consul_exporter_system_user

string

Advanced

consul exporter user

Default: "consul-exp"

consul_exporter_timeout

string

Timeout on HTTP requests to the Consul API

Default: "500ms"

consul_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in consul_exporter docs.

consul_exporter_version

string

consul exporter package version. Also accepts latest as parameter.

Default: "0.13.0"

consul_exporter_web_listen_address

string

Address on which consul_exporter will listen

Default: "0.0.0.0:9107"

consul_exporter_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Prometheus Community