Prometheus exporter written in Python, to export SAP HANA database metrics. The project is based in the official prometheus exporter: prometheus_client.
-
A running and reachable SAP HANA database. Running the exporter in the same machine where the HANA database is running is recommended. Ideally each database should be monitored by one exporter.
-
A SAP HANA Connector, for that, you have two options:
The installation of the connector is covered in the Installation section.
The exporter uses an additional file to know the metrics that are going to be exported. Here more information about the metrics file.
Note: The usage of a virtual environment is recommended.
cd hanadb_exporter # project root folder
virtualenv virt
source virt/bin/activate
# uncomment one of the next two options
# pip install pyhdb
# pip install path-to-hdbcli-N.N.N.tar.gaz
pip install .
# pip install -e . # To install in development mode
# deactivate # to exit from the virtualenv
If you prefer, you can install a RPM package for the PyHDB SAP HANA connector doing (example for Tumbleweed, but available for other versions):
# All the command must be executed as root user
zypper addrepo https://download.opensuse.org/repositories/network:/ha-clustering:/Factory/openSUSE_Tumbleweed/network:ha-clustering:Factory.repo
zypper ref
zypper in python3-PyHDB
- Create the
config.jsonconfiguration file. An example ofconfig.jsonavailable in config.json.example. Here the most important items in the configuration file:
exposition_port: Port where the prometheus exporter will be exposed (8001 by default).hana.host: Address of the SAP HANA database.hana.port: Port where the SAP HANA database is exposed.hana.user: An existing user with access right to the SAP HANA database.hana.password: Password of an existing user.logging.config_file: Python logging system configuration file (by default WARN and ERROR level messages will be sent to the syslog)logging.log_file: Logging file (/var/log/hanadb_exporter.log by default)
The logging configuration file follows the python standard logging system style: Python logging.
Using the default configuration file, it will redirect the logs to the file assigned in the json configuration file and to the syslog (only logging level up to WARNING).
- Start the exporter by running the following command:
hanadb_exporter -c config.json -m metrics.json
# Or
python3 hanadb_exporter/main.py -c config.json -m metrics.json
The hanadb_exporter can be executed using systemd. For that, the best option is to install the
project using a rpm package. This can be done following the next steps (this example is for tumbleweed):
# All the command must be executed as root user
# The hanadb_exporter uses the prometheus_client for python. You can find it on the ha-clustering:Factory Repository.
zypper addrepo https://download.opensuse.org/repositories/network:/ha-clustering:/Factory/openSUSE_Tumbleweed/network:ha-clustering:Factory.repo
zypper addrepo https://download.opensuse.org/repositories/server:/monitoring/openSUSE_Tumbleweed/server:monitoring.repo
zypper ref
zypper in hanadb_exporter
Even using this way, the SAP HANA database connector package must be installed independently (see Installation).
After that we need to create the configuration file as /etc/hanadb_exporter/my-exporter.json (the name is relevant as we will use it to start the daemon).
The config.json.example can be used as example (the example file is
stored in /etc/hanadb_exporter folder too).
The default metrics file is stored in /etc/hanadb_exporter/metrics.json.
The logging configuration file can be updated as well to customize it (stored in /etc/hanadb_exporter/logging_config.ini)
Now, the exporter can be started as a daemon. As we can have multiple hanadb_exporter instances running in one machine, the service is created using a template file, so an extra information must be given to systemd (this is done adding the @ keyword after the service name together with the name of the configuration file created previously in /etc/hanadb_exporter/{name}.json):
# All the command must be executed as root user
systemctl start hanadb_exporter@my-exporter
# Check the status with
systemctl status hanadb_exporter@my-exporter
See the LICENSE file for license rights and limitations.
- Kristoffer Gronlund (kgronlund@suse.com)
- Xabier Arbulu Insausti (xarbulu@suse.com)
- Ayoub Belarbi (abelarbi@suse.com)
- Diego Akechi (dakechi@suse.com)
Pull request preferred reviewers for this project:
- Kristoffer Gronlund (kgronlund@suse.com)
- Xabier Arbulu Insausti (xarbulu@suse.com)
- Ayoub Belarbi (abelarbi@suse.com)
https://prometheus.io/docs/instrumenting/writing_exporters/
https://prometheus.io/docs/practices/naming/
http://sap.optimieren.de/hana/hana/html/sys_statistics_views.html