6. Appendix

6.1. Troubleshooting

The zhmcclient Troubleshooting section also applies to the exporter project.

There are no additional exporter-specific troubleshooting hints at the moment.

6.2. Glossary

Exporter

A server application for exposing metrics to Prometheus

IBM Z

IBM’s mainframe product line

Prometheus

A server application for monitoring and alerting

Z HMC

Hardware Management Console for IBM Z

Jinja2 expression

A Jinja2 expression without surrounding double curly braces.

See https://jinja.palletsprojects.com/en/stable/templates/#expressions for a description.

When putting Jinja2 expressions into YAML files, it is recommended to put the expression into double or single quotes to protect it from being interpreted as YAML. An example where that makes a difference is a Jinja2 expression that is a literal string: The Jinja2 expression 'abc' must be put into double quotes in YAML to protect the single quotes and becomes value: "'abc'".

Metric service based metrics

Metrics that are retrieved from the HMC using the “Get Metric Context” operation. For more details, see Available metrics.

Resource property based metrics

Metrics that are obtained from properties of HMC resources. For more details, see Available metrics.

6.3. Bibliography

HMC API: IBM SC27-2646-00, IBM Z Hardware Management Console Web Services API (Version 2.17.0)
HMC Security: IBM SC28-7061-00, IBM Z Hardware Management Console Security (Version 2.17.0)
HMC Help: IBM Z Hardware Management Console Help (Version 2.17.0) <https://www.ibm.com/docs/en/help-ibm-hmc-z17>