1. Introduction

1.1. What this package provides

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.

The exporter supports HTTP and HTTPS (with and without mutual TLS) for Prometheus.

1.2. Supported environments

  • Operating systems: Linux, macOS, Windows

  • Python versions: 3.8 and higher

  • HMC versions: 2.11.1 and higher

1.3. Reporting issues

If you encounter a problem, please report it as an issue on GitHub.

1.4. License

This package is licensed under the Apache 2.0 License.