ansible-collection-prometheus/roles/blackbox_exporter/README.md
Christian Brabandt 742ce8b3ae
enhancement(blackbox): add skip_install variable
This is similar to prometheus_skip_install variable and does what the
name says: when set, it won't try to re-download blackbox_exporter
binary

Also, fix a small typo in the preflight task.

Signed-off-by: Christian Brabandt <cb@256bit.org>
2023-03-21 15:34:17 +01:00

2.9 KiB

blackbox logo

Ansible Role: Blackbox Exporter

Description

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

Requirements

  • Ansible >= 2.7 (It might work on previous versions, but we cannot guarantee it)
  • gnu-tar on Mac deployer host (brew install gnu-tar)

Role Variables

All variables which can be overridden are stored in defaults/main.yml file as well as in table below.

Name Default Value Description
blackbox_exporter_version 0.18.0 Blackbox exporter package version
blackbox_exporter_skip_install false Blackbox exporter installation tasks gets skipped when set to true.
blackbox_exporter_binary_url `"https://github.com/prometheus/blackbox_exporter/releases/download/v{{ blackbox_exporter_version }}/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] default(ansible_architecture) }}.tar.gz"`
blackbox_exporter_web_listen_address 0.0.0.0:9115 Address on which blackbox exporter will be listening
blackbox_exporter_cli_flags {} Additional configuration flags passed to blackbox exporter binary at startup
blackbox_exporter_configuration_modules http_2xx: { prober: http, timeout: 5s, http: '' }

Example

Playbook

- hosts: all
  become: true
  roles:
    - prometheus.prometheus.blackbox-exporter

Demo site

We provide demo site for full monitoring solution based on prometheus and grafana. Repository with code and links to running instances is available on github and site is hosted on DigitalOcean.

Local Testing

The preferred way of locally testing the role is to use Docker and molecule (v3.x). You will have to install Docker on your system. See "Get started" for a Docker package suitable to for your system. Running your tests is as simple as executing molecule test.

Continuous Intergation

Combining molecule and circle CI allows us to test how new PRs will behave when used with multiple ansible versions and multiple operating systems. This also allows use to create test scenarios for different role configurations. As a result we have a quite large test matrix which can take more time than local testing, so please be patient.

Contributing

See contributor guideline.

Troubleshooting

See troubleshooting.

License

This project is licensed under MIT License. See LICENSE for more details.