openstack/ironic-prometheus-exporter
Code Issues Proposed changes
Application capable to export hardware sensor data from Ironic nodes to a Prometheus Server.
24 Commits 10 Branches 32 Tags 1.3 MiB
Python 95.6%
Shell 4.4%
41ee7fd6da
Go to file
Iury Gregory Melo Ferreira 41ee7fd6da Migrate to opendev infra 
- Adds `.gitreview` to allow `git review` usage
- Adds `.zuul.yaml` for initial jobs to run on CI
- Changes `setup.py` to follow the OpenStack format
- Adds `setup.cfg` with the information that was
in the old `setup.py`
- Removes `verify_installation.py`
- Updates `README` with newer information
- Removes uWSGI from requirements.txt

Change-Id: Id247c4eebf9dec94556b500866a360d6c24b9a92
2019-07-11 12:50:32 +02:00
ironic_prometheus_exporter Move to client_python from Prometheus 2019-04-30 17:53:54 +02:00
.gitignore Updates for Prometheus Exporter 2019-04-08 13:24:34 +02:00
.gitreview Migrate to opendev infra 2019-07-11 12:50:32 +02:00
.stestr.conf Initial version for Prometheus File Driver 2019-03-26 09:55:27 +01:00
.zuul.yaml Migrate to opendev infra 2019-07-11 12:50:32 +02:00
CONTRIBUTING.md Initial commit 2019-03-19 17:25:52 +01:00
DCO Initial commit 2019-03-19 17:25:52 +01:00
LICENSE Initial commit 2019-03-19 17:25:52 +01:00
README.rst Migrate to opendev infra 2019-07-11 12:50:32 +02:00
requirements.txt Migrate to opendev infra 2019-07-11 12:50:32 +02:00
setup.cfg Migrate to opendev infra 2019-07-11 12:50:32 +02:00
setup.py Migrate to opendev infra 2019-07-11 12:50:32 +02:00
test-requirements.txt Updates for Prometheus Exporter 2019-04-08 13:24:34 +02:00
tox.ini Updates for Prometheus Exporter 2019-04-08 13:24:34 +02:00

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