prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter

Note

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

Entry point main – Deploy and manage Prometheus blackbox exporter

Synopsis

  • Deploy and manage Prometheus blackbox exporter which allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP and ICMP.

Parameters

Parameter

Comments

blackbox_exporter_binary_install_dir

string

Advanced

Directory to install blackbox_exporter binary

Default: "/usr/local/bin"

blackbox_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 blackbox_exporter binary is stored on the host where ansible is run.

This overrides the blackbox_exporter_version parameter

blackbox_exporter_binary_url

string

URL of the blackbox_exporter binaries .tar.gz file

Default: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}.tar.gz"

blackbox_exporter_checksums_url

string

URL of the blackbox exporter checksums file

Default: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/sha256sums.txt"

blackbox_exporter_cli_flags

dictionary

Additional configuration flags passed to blackbox exporter binary at startup

blackbox_exporter_config_dir

string

Directory where the blackbox exporter configuration file is placed

Default: "/etc"

blackbox_exporter_configuration_modules

dictionary

Endpoints configuration

Default: {"http_2xx": {"http": {"method": "GET", "valid_status_codes": []}, "prober": "http", "timeout": "5s"}}

blackbox_exporter_group

string

The group the exporter runs as

Default: "blackbox-exp"

blackbox_exporter_skip_install

boolean

Blackbox exporter installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

blackbox_exporter_user

string

The user the exporter runs as

Default: "blackbox-exp"

blackbox_exporter_version

string

Blackbox exporter package version. Also accepts latest as parameter.

Default: "0.24.0"

blackbox_exporter_web_listen_address

string

Address on which blackbox exporter will be listening

Default: "0.0.0.0:9115"

Authors

  • Prometheus Community