3. Trouble shooting

This section describes some issues and how to resolve them. If you encounter an issue that is not covered here, see Reporting issues.

3.1. Permission error with YAML file

Example:

$ zhmc_prometheus_exporter
Error: Permission error reading HMC credentials file ...

You don’t have permission to read from the HMC credentials file or metric definition file. Change the permissions with chmod, check man chmod if you are unfamiliar with it.

3.2. YAML file not found

Example:

$ zhmc_prometheus_exporter
Error: Cannot find HMC credentials file ...

The HMC credentials file or the metric definition file does not exist.

You need to create them as described in Quickstart.

3.3. YAML syntax error

Example:

$ zhmc_prometheus_exporter
Error: YAML error reading HMC credentials file ...

The HMC credentials file or the metric definition file breaks the syntax rules of the YAML specification.

Compare your HMC credentials file or metric definition file with the samples from the examples folder, see Quickstart for more information. You can also check the YAML specification.

3.4. YAML validation error

Example:

$ zhmc_prometheus_exporter
Error: Validation of HMC credentials file ...

There are additional elements in the HMC credentials file or metric definition file, or required elements are missing, or other validation rules are violated.

Compare your HMC credentials file or metric definition file with the samples from the examples folder, see Quickstart for more information.

3.5. Timeout

Example:

$ zhmc_prometheus_exporter
Error: Connection error ...: Max retries exceeded ... Connection to ... timed out.

Ensure that you have network connectivity to the HMC that is specified in the HMC credentials file.

3.6. Authentication error

Example:

$ zhmc_prometheus_exporter
Error: Authentication error returned from the HMC at ... HTTP authentication failed with 403,0: Login failed

Wrong username or password in the HMC credentials file. Check if you can access the HMC with this username-password combination.

3.7. Warning: Skipping metric or metric group

Example:

$ zhmc_prometheus_exporter
...: UserWarning: Skipping metric group 'new-metric-group' returned by the HMC that is
  not defined in the 'metric_groups' section of metric definition file metrics.yaml
  warnings.warn(warning_str % (metric, filename))

$ zhmc_prometheus_exporter
...: UserWarning: Skipping metric 'new-metric' of metric group 'new-metric-group'
  returned by the HMC that is not defined in the 'metrics' section of metric
  definition file metrics.yaml
  warnings.warn(warning_str % (metric, filename))

If the HMC implements new metrics, or if the metric definition file misses a metric or metric group, the exporter issues this warning to make you aware of that.