/ansible-blackbox-exporter

Blackbox prober exporter

Primary LanguageShellMIT LicenseMIT

blackbox logo

Ansible Role: Blackbox Exporter

Build Status License Ansible Role GitHub tag IRC

Description

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

Requirements

  • Ansible >= 2.5 (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.13.0 Blackbox exporter package version
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:
    - cloudalchemy.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 (v2.x). You will have to install Docker on your system. See "Get started" for a Docker package suitable to for your system. We are using tox to simplify process of testing on multiple ansible versions. To install tox execute:

pip install tox

To run tests on all ansible versions (WARNING: this can take some time)

tox

To run a custom molecule command on custom environment with only default test scenario:

tox -e py27-ansible25 -- molecule test -s default

For more information about molecule go to their docs.

If you would like to run tests on remote docker host just specify DOCKER_HOST variable before running tox tests.

Travis CI

Combining molecule and travis 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 (42 parallel role executions in case of ansible-prometheus) which will take more time than local testing, so please be patient.

Contributing

See contributor guideline.

License

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