IBM Z HMC Prometheus Exporter
The IBM Z HMC Prometheus Exporter is a Prometheus exporter written in Python that retrieves metrics from the IBM Z Hardware Management Console (HMC) and exports them to the Prometheus monitoring system.
The exporter supports all metrics provided by the Z HMC and in addition a number of useful metrics that are based on properties of HMC resources (e.g. memory or CPU weight of LPARs). The resource property based metrics are obtained in the background via change notifications emitted by the HMC and via asynchronous retrieval for properties where change notifications are not supported. This keeps the time for providing the metric data to Prometheus short (sub-second to a few seconds).
The exporter attempts to stay up as much as possible, for example it performs automatic session renewals with the HMC if the logon session expires, and it survives HMC reboots and automatically picks up metrics collection again once the HMC come back up.
Documentation
Quickstart
-
If not yet available, install the "pipx" command as described in https://pipx.pypa.io/stable/installation/.
-
Without having any virtual Python environment active, install the exporter as follows:
$ pipx install zhmc-prometheus-exporter
That makes the
zhmc_prometheus_exportercommand available in the PATH, without having to activate any virtual Python environment. -
Provide a config file for use by the exporter.
The exporter config file tells the exporter which HMC to talk to for obtaining metrics, and which userid and password to use for logging on to the HMC.
It also defines whether HTTP or HTTPS is used for Prometheus, and HTTPS related certificates and keys.
Finally, it defines which metric groups to fetch and to provide to Prometheus.
Download the sample exporter config file as
config.yamland edit that copy accordingly.For details, see Exporter config file.
-
Run the exporter as follows:
$ zhmc_prometheus_exporter -c config.yaml Exporter is up and running on port 9291
Depending on the number of CPCs managed by your HMC, and dependent on how many metrics are enabled, it will take some time until the exporter reports to be up and running. You can see what it does in the mean time by using the
-voption. Subsequent requests to the exporter will be sub-second. -
Direct your web browser at http://localhost:9291 (or https://localhost:9291 when using HTTPS) to see the exported Prometheus metrics. Refreshing the browser will update the metrics.
Reporting issues
If you encounter a problem, please report it as an issue on GitHub.
License
This package is licensed under the Apache 2.0 License.
3 maintainers
Metadata
3 maintainers
Release files for zhmc-prometheus-exporter 2.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| zhmc_prometheus_exporter-2.4.0.tar.gz | 202.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zhmc_prometheus_exporter-2.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 307.4 kB
Release files / zhmc_prometheus_exporter-2.4.0.tar.gz
| Download URL | zhmc_prometheus_exporter-2.4.0.tar.gz |
|---|---|
| Size | 202.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5807a1ee8d6185530b9ebc3ce7dcd623333e86a551117234b6dbfb15bd50f3e5
|
|
BLAKE2b-256 checksum How to use checksums |
75d9276eb7f1c8254de1e2766645c8d4564582804d856b95060d83fe525f5c21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 8, 2026.
Transparency logRelease files / zhmc_prometheus_exporter-2.4.0-py3-none-any.whl
| Download URL | zhmc_prometheus_exporter-2.4.0-py3-none-any.whl |
|---|---|
| Size | 104.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3b9d4e007dfa67464e16ce14d3a4f0ec0ec1fe77b020ef12e66ae128b22bf568
|
|
BLAKE2b-256 checksum How to use checksums |
26de531bfa37159594e503ef619f32f328c46e2a70620525fca0b1905b6ed69a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 8, 2026.
Transparency log
