/hass-openmetrics

Home Assistant integration for OpenMetrics providers

Primary LanguagePythonMIT LicenseMIT

OpenMetrics Home Assistant Integration

GitHub Release GitHub Activity License HACS

Integration to integrate with OpenMetrics and Prometheus exposition format providers.

The OpenMetrics specification defines a standard for exposing metrics in a text-based format. This integration supports both the OpenMetrics format and the Prometheus exposition format, which is a widely adopted format for exposing metrics. The library used to process the data is coming from the Python client repository of Prometheus.

Example applications that provide metrics data in supported formats:

This integration allows you to monitor various metrics from OpenMetrics and Prometheus exposition format providers within Home Assistant.

Features

  • Monitor CPU, memory, disk, network, and uptime metrics of hosts and containers.
  • Support for multiple metrics providers.
  • Multi-container support for container metrics providers.
  • Basic authentication support.
  • SSL/TLS support.
  • Dynamic sources management for multi-container metrics providers.
  • Dynamic metrics management.
  • Configurable scan interval for sensor data updates.

Installation

  1. Add this repository as a custom repository to HACS: Add Repository
  2. Use HACS to install the integration.
  3. Restart Home Assistant.
  4. Set up the integration using the UI: Add Integration

Development and maintenance

I basically created this integration for my personal purpose. As it fulfils all my current needs I won't develop it further for now.
However, as long as I am using this integration in my Home Assistant setup I will maintain it actively.

Contributions are welcome

If you want to contribute to this integration, please read the Contribution guidelines

Providing translations for other languages

If you would like to use the integration in another language, you can help out by providing the necessary translations in custom_components/openmetrics/translations/ and open a pull request with the changes.