https://github.com/ome/ansible-role-prometheus

Prometheus monitoring server
https://github.com/ome/ansible-role-prometheus

ansible monitoring prometheus

Last synced: 12 months ago
JSON representation

Prometheus monitoring server

• Host: GitHub
• URL: https://github.com/ome/ansible-role-prometheus
• Owner: ome
• License: bsd-2-clause
• Created: 2017-02-20T14:19:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-20T11:12:19.000Z (about 2 years ago)
• Last Synced: 2025-06-05T06:56:30.647Z (about 1 year ago)
• Topics: ansible, monitoring, prometheus
• Language: Jinja
• Homepage: https://galaxy.ansible.com/ome/prometheus
• Size: 89.8 KB
• Stars: 16
• Watchers: 6
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
Prometheus

==========

[![Actions Status](https://github.com/ome/ansible-role-prometheus/workflows/Molecule/badge.svg)](https://github.com/ome/ansible-role-prometheus/actions)

[![Ansible Role](https://img.shields.io/badge/ansible--galaxy-prometheus-blue.svg)](https://galaxy.ansible.com/ui/standalone/roles/ome/prometheus/)

Prometheus monitoring server, includes prometheus, alertmanager and blackbox-exporter.

This requires docker to be running (not handled by this role).

This role is still in development.

Parameters

----------

- `prometheus_targets`: Optional list of dictionaries of targets:

  - `group`: A list of Ansible groups (optional)

  - `hosts`: A list of hosts (optional)

  - `port`: The port to be monitored

  - `jobname`: The prometheus job-name

  - `scrape_interval`: Prometheus scrape interval (optional)

  - `metrics_path`: Path to metrics (optional)

- `prometheus_sd_targets`: Optional list of dictionaries of additional targets:

  - `groupname`: The name of the configuration target file, used to name a configuration file so must be unique

  - `group`: A list of Ansible groups (optional)

  - `hosts`: A list of hosts (optional)

  - `port`: The port to be monitored

  - `jobname`: The prometheus job-name

  This is intended to be an example.

  In practice these configuration files could be dynamically generated outside this role, prometheus will automatically reload them.

- `prometheus_custom_targets`: Optional list of dictionaries of additional targets with custom arguments, use this if you need to pass custom arguments that aren't supported by the previous two parameters.

  Each item is a [``](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config) that will be copied unchanged into the configuration.

- `prometheus_port`: External Prometheus port, set to `0` to disable, default `9090`

- `prometheus_alertmanager_port`: External Alertmanager port, set to `0` to disable, default `9093`

- `prometheus_blackboxexporter_port`: External Blackbox-exporter port, set to `0` to disable, default `9115`

- `prometheus_additional_command_args`: Additional command line arguments for prometheus

- `prometheus_alertmanager_additional_command_args`: Additional command line arguments for alertmanager

- `prometheus_additional_rules_template`: Template with additional alert rules.

  See https://awesome-prometheus-alerts.grep.to/rules for some ideas but note the labels may be different.

- `prometheus_docker_network`: Docker network for prometheus Docker applications, default `prometheus`

- `prometheus_docker_user`: User ID that prometheus should run as, default is the container default

- `prometheus_docker_data_volume`: Docker volume or host path for Prometheus data, default is a docker volume called `prometheus-data`. If this is a host path it must be writeable by `prometheus_docker_user`.

Outputs

-------

This role sets the following variables which can be used in other tasks:

- `prometheus_internal_ip`: Internal IP of the Prometheus container

- `prometheus_blackboxexporter_internal_ip`: Internal IP of the Blackbox exporter container

- `prometheus_alertmanager_internal_ip`: Internal IP of the AlertManager container

These are intended for use when you don't want to expose the container ports using standard Docker port-forwarding (set `prometheus_*port: 0`).

Example playbook

----------------

    - hosts: localhost

      roles:

      - role: ome.docker

      - role: ome.prometheus

Testing Slack alerts (manual)

-----------------------------

Change `prometheus_alertmanager_slack_webhook` in `playbook.yml` to a real Slack webhook. Run:

    molecule test --destroy never

    molecule login

    docker stop fake-metrics

Wait a few minutes, a Slack alert should be generated.

If this fails try creating a [manual alert](https://github.com/prometheus/alertmanager/issues/437#issuecomment-263413632):

    curl -H "Content-Type: application/json" -d '[{"labels":{"alertname":"TestAlert1"}}]' localhost:9093/api/v1/alerts

The molecule test also includes a disk space alert configuration.

To test this fill up at least 90% of the `/run` partition:

    molecule login

    dd if=/dev/zero of=/run/fill.space bs=1M count=...

Wait a few minutes and you should see a disk space warning.

Author Information

------------------

ome-devel@lists.openmicroscopy.org.uk