Application capable to export hardware sensor data from Ironic nodes to a Prometheus Server.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Mark Goddard c932c72969 Add versions to release notes series 3 weeks ago
doc Release Notes support 2 months ago
ironic_prometheus_exporter Add metrics descriptions 1 month ago
releasenotes Add versions to release notes series 3 weeks ago
.gitignore Release Notes support 2 months ago
.gitreview Migrate to opendev infra 3 months ago
.stestr.conf Initial version for Prometheus File Driver 6 months ago
.zuul.yaml Release Notes support 2 months ago
CONTRIBUTING.md Initial commit 7 months ago
DCO Initial commit 7 months ago
LICENSE Initial commit 7 months ago
README.rst Migrate to opendev infra 3 months ago
requirements.txt Migrate to opendev infra 3 months ago
setup.cfg build universal wheels 2 months ago
setup.py Migrate to opendev infra 3 months ago
test-requirements.txt Updates for Prometheus Exporter 6 months ago
tox.ini Release Notes support 2 months ago

README.rst

Ironic Prometheus Exporter

Overview

Tool to expose hardware sensor data in the Prometheus format through an HTTP endpoint.

The hardware sensor data come from bare metal machines deployed using OpenStack Bare Metal Service (ironic).

Installation

1 - Install ironic-prometheus-exporter :

$ pip install --user ironic-prometheus-exporter

2- Verify if the driver is installed :

$ pip install entry_point_inspector --user <user>
$ epi group show oslo.messaging.notify.drivers
  • Output in case of a successful instalation: prometheus_exporter is listed in the Name column and the Error column should be empty.
  • Output in case of an unsuccessful instalation: prometheus_exporter is listed in the Name column and the Error column will have more information.

Configuration

After install the driver you will need to update the ironic.conf and add the following information:

[conductor]
send_sensor_data=true

[oslo_messaging_notifications]
driver = prometheus_exporter
transport_url = fake://
location=/tmp/ironic_prometheus_exporter

Running exporter application

The Flask Application is responsible to merge all the metrics files present in the directory set in [oslo_messaging_notifications]/location.

Note

If you want to deploy in production please check the Flask documentation

To run the Flask Application follow the steps listed below: 1 - open the repository directory :

$ cd ironic-prometheus-exporter/

2- set the FLASK_* environment variables and the location of the ironic.conf file. :

$ export IRONIC_CONFIG=/etc/ironic/ironic.conf
$ export FLASK_APP=ironic_prometheus_exporter/app/exporter.py
$ export FLASK_RUN_HOST=$HOST_IP
$ export FLASK_RUN_PORT=5000

3- run the Flask Application :

$ python -m flask run &

Running under uWSGI

Reproduce the Steps 1 and 2 (You don't need to set FLASK_APP variable) and run the command below: :

$ uwsgi --plugin python --http-socket ${FLASK_RUN_HOST}:${FLASK_RUN_PORT} --module ironic_prometheus_exporter.app.wsgi:application

Contributing