prometheus.prometheus.elasticsearch_exporter role – Prometheus Elasticsearch Exporter

Note

This role is part of the prometheus.prometheus collection (version 0.27.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.elasticsearch_exporter.

Entry point main – Prometheus Elasticsearch Exporter

Synopsis

Parameters

Parameter

Comments

elasticsearch_exporter_basic_auth_users

dictionary

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

elasticsearch_exporter_binary_install_dir

string

Advanced

Directory to install elasticsearch_exporter binary

Default: "/usr/local/bin"

elasticsearch_exporter_binary_url

string

URL of the elasticsearch exporter binaries .tar.gz file

Default: "https://github.com/{{ _elasticsearch_exporter_repo }}/releases/download/v{{ elasticsearch_exporter_version }}/elasticsearch_exporter-{{ elasticsearch_exporter_version }}.{{ ansible_facts['system'] | lower }}-{{ _elasticsearch_exporter_go_ansible_arch }}.tar.gz"

elasticsearch_exporter_checksums_url

string

URL of the elasticsearch exporter checksums file

Default: "https://github.com/{{ _elasticsearch_exporter_repo }}/releases/download/v{{ elasticsearch_exporter_version }}/sha256sums.txt"

elasticsearch_exporter_config_dir

string

Path to directory with elasticsearch_exporter configuration

Default: "/etc/elasticsearch_exporter"

elasticsearch_exporter_disabled_collectors

list / elements=string

List of disabled collectors.

By default elasticsearch_exporter disables collectors listed here.

elasticsearch_exporter_enabled_collectors

list / elements=string

List of dicts defining additionally enabled collectors and their configuration.

It adds collectors to those enabled by default.

Default: ["systemd", {"textfile": {"directory": "{{ elasticsearch_exporter_textfile_dir }}"}}]

elasticsearch_exporter_extra_args

string

Advanced

Elasticsearch exporter cli extra arguments to be added to systemd unit

Default: []

elasticsearch_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in elasticsearch_exporter docs.

elasticsearch_exporter_local_cache_path

string

Local path to stash the archive and its extraction

Default: "/tmp/elasticsearch_exporter-{{ ansible_facts['system'] | lower }}-{{ _elasticsearch_exporter_go_ansible_arch }}/{{ elasticsearch_exporter_version }}"

elasticsearch_exporter_system_group

string

Advanced

System group for elasticsearch exporter

Default: "elastic-exp"

elasticsearch_exporter_system_user

string

Advanced

Elasticsearch exporter user

Default: "elastic-exp"

elasticsearch_exporter_textfile_dir

string

Directory used by the Textfile Collector.

To get permissions to write metrics in this directory, users must be in elastic-exp system group.

Note: More information in TROUBLESHOOTING.md guide.

Default: "/var/lib/elasticsearch_exporter"

elasticsearch_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in elasticsearch_exporter docs.

elasticsearch_exporter_version

string

Elasticsearch exporter package version. Also accepts latest as parameter.

Default: "1.8.0"

elasticsearch_exporter_web_disable_exporter_metrics

boolean

Exclude metrics about the exporter itself (promhttp_*, process_*, go_*).

Choices:

  • false ← (default)

  • true

elasticsearch_exporter_web_listen_address

string

Address on which elasticsearch exporter will listen

Default: "0.0.0.0:9114"

elasticsearch_exporter_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Prometheus Community