IBM Z HMC Prometheus Exporter

Contents:

  • 1. Introduction
    • 1.1. What this package provides
    • 1.2. Supported environments
    • 1.3. Reporting issues
    • 1.4. License
  • 2. Installation
    • 2.1. Steps
    • 2.2. Installation using pipx
    • 2.3. Installation into a virtual Python environment
    • 2.4. Installation into a system Python
    • 2.5. Installation on a system without Internet access
    • 2.6. Setting up the HMC
    • 2.7. Setting up firewalls or proxies
  • 3. Usage
    • 3.1. zhmc_prometheus_exporter command
    • 3.2. Running in a Docker container
    • 3.3. Size of log files and terminal output
    • 3.4. Using HMC certificates
    • 3.5. Communication with Prometheus
    • 3.6. Exported metric concepts
    • 3.7. Available metrics
    • 3.8. Labels on exported metrics
    • 3.9. Exporter config file
      • 3.9.1. Format of exporter config file
      • 3.9.2. Migration of exporter config file to version 2 format
      • 3.9.3. Sample exporter config file
    • 3.10. Metric definition file
    • 3.11. Sample output to Prometheus
    • 3.12. Demo setup with Grafana
    • 3.13. Logging
      • 3.13.1. Logging to the System Log
    • 3.14. Performance
  • 4. Trouble shooting
    • 4.1. Permission error with exporter config file
    • 4.2. Exporter config file not found
    • 4.3. YAML syntax error in exporter config file
    • 4.4. YAML validation error in exporter config file
    • 4.5. Timeout
    • 4.6. Authentication error
    • 4.7. Warning: Skipping metric or metric group
  • 5. Development
    • 5.1. Repository
    • 5.2. Code of Conduct
    • 5.3. Contributing
    • 5.4. Making a change
    • 5.5. Format of commit messages
    • 5.6. Releasing a version
    • 5.7. Starting a new version
    • 5.8. Building the distribution archives
    • 5.9. Building the documentation
    • 5.10. Testing
    • 5.11. Format of metric definition file
  • 6. Appendix
    • 6.1. Troubleshooting
    • 6.2. Glossary
    • 6.3. Bibliography
  • 7. Change log
    • 7.1. Version 2.1.1
    • 7.2. Version 2.1.0
    • 7.3. Version 2.0.0
    • 7.4. Version 1.7.0
    • 7.5. Version 1.6.0
    • 7.6. Version 1.5.0
    • 7.7. Version 1.4.0
    • 7.8. Version 1.3.0
    • 7.9. Version 1.2.0
    • 7.10. Version 1.1.0
    • 7.11. Version 1.0.0
    • 7.12. Version 0.7.0
    • 7.13. Version 0.6.0
    • 7.14. Version 0.5.0
    • 7.15. Version 0.4.1
    • 7.16. Version 0.4.0
    • 7.17. Version 0.3.0
    • 7.18. Version 0.2.0
    • 7.19. Version 0.1.2
    • 7.20. Version 0.1.1
    • 7.21. Version 0.1.0
IBM Z HMC Prometheus Exporter
  • Search

© Copyright 2018, IBM Corp.

Built with Sphinx using a theme provided by Read the Docs.