Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/txxa/hass-openmetrics
Home Assistant integration for OpenMetrics providers
https://github.com/txxa/hass-openmetrics
hacs hacs-custom hacs-integration home-assistant home-assistant-custom home-assistant-integration openmetrics
Last synced: 2 days ago
JSON representation
Home Assistant integration for OpenMetrics providers
- Host: GitHub
- URL: https://github.com/txxa/hass-openmetrics
- Owner: txxa
- License: mit
- Created: 2024-08-08T20:22:17.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T19:43:23.000Z (11 days ago)
- Last Synced: 2024-09-20T12:51:58.235Z (7 days ago)
- Topics: hacs, hacs-custom, hacs-integration, home-assistant, home-assistant-custom, home-assistant-integration, openmetrics
- Language: Python
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenMetrics Home Assistant Integration
[](https://github.com/txxa/hass-openmetrics/releases)
[](https://github.com/txxa/hass-openmetrics/commits/main)
[](LICENSE)
[](https://hacs.xyz/docs/faq/custom_repositories)
_Integration to integrate with OpenMetrics and Prometheus exposition format providers._
The [OpenMetrics specification](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md) 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](https://github.com/prometheus/client_python/blob/master/prometheus_client/) of Prometheus.
Example applications that provide metrics data in supported formats:
- [Prometheus](https://prometheus.io/)
- [Thanos](https://thanos.io/)
- [Cortex](https://cortexmetrics.io/)
- [Node Exporter](https://github.com/prometheus/node_exporter)
- [cAdvisor](https://github.com/google/cadvisor)
- [Blackbox Exporter](https://github.com/prometheus/blackbox_exporter)
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: [](https://my.home-assistant.io/redirect/hacs_repository/?owner=txxa&repository=hass-openmetrics&category=integration)
2. Use HACS to install the integration.
3. Restart Home Assistant.
4. Set up the integration using the UI: [](https://my.home-assistant.io/redirect/config_flow_start/?domain=openmetrics)
## 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](CONTRIBUTING.md)
### 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/](./custom_components/openmetrics/translations/) and open a pull request with the changes.