prometheus.prometheus.node_exporter role – Prometheus Node Exporter

Note

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

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.node_exporter.

Entry point main – Prometheus Node Exporter

Synopsis

Parameters

Parameter

Comments

node_exporter_archive_path

string

Local path to stash the archive and its extraction

Default: "/tmp"

node_exporter_basic_auth_users

dictionary

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

node_exporter_binary_install_dir

string

Advanced

Directory to install node_exporter binary

Default: "/usr/local/bin"

node_exporter_binary_local_dir

string

Enables the use of local packages instead of those distributed on github.

The parameter may be set to a directory where the node_exporter binary is stored on the host where ansible is run.

This overrides the node_exporter_version parameter

node_exporter_binary_url

string

URL of the node exporter binaries .tar.gz file

Default: "https://github.com/{{ _node_exporter_repo }}/releases/download/v{{ node_exporter_version }}/node_exporter-{{ node_exporter_version }}.linux-{{ go_arch }}.tar.gz"

node_exporter_checksums_url

string

URL of the node exporter checksums file

Default: "https://github.com/{{ _node_exporter_repo }}/releases/download/v{{ node_exporter_version }}/sha256sums.txt"

node_exporter_disabled_collectors

list / elements=string

List of disabled collectors.

By default node_exporter disables collectors listed here.

node_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": "{{ node_exporter_textfile_dir }}"}}]

node_exporter_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in node_exporter docs.

node_exporter_skip_install

boolean

Node exporter installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

node_exporter_system_group

string

Advanced

System group for node exporter

Default: "node-exp"

node_exporter_system_user

string

Advanced

Node exporter user

Default: "node-exp"

node_exporter_textfile_dir

string

Directory used by the Textfile Collector.

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

Note: More information in TROUBLESHOOTING.md guide.

Default: "/var/lib/node_exporter"

node_exporter_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in node_exporter docs.

node_exporter_version

string

Node exporter package version. Also accepts latest as parameter.

Default: "1.8.0"

node_exporter_web_disable_exporter_metrics

boolean

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

Choices:

  • false ← (default)

  • true

node_exporter_web_listen_address

string

Address on which node exporter will listen

Default: "0.0.0.0:9100"

node_exporter_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Prometheus Community