mirror of
https://github.com/nikdoof/homeassistant-prometheus-query.git
synced 2025-12-18 21:19:20 +00:00
4fbe9c5660
Fix lfasci/homeassistant-prometheus-query#5 Goal is to make a first pass to allow to be exposed in the energy dashboard. This requires usage of HA version 2021.9 (which is beta at time of writing) if we want to allow total_increase state_class
43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
# homeassistant-prometheus-query
|
|
Inspired from homeassitant Command line Sensor this sensor take values from [Prometheus](https://prometheus.io/) metrics using [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) query . It allow to specify one or more query creating a sensors for each query.
|
|
|
|
## Configuration
|
|
|
|
To enable it, add the following lines to your `configuration.yaml`:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: prometheus_query
|
|
name: Temperature Pisa
|
|
prometheus_url: http://localhost:9090
|
|
prometheus_query: temperature{location="Pisa",province="PI",region="Tuscany"}
|
|
unit_of_measurement: "°C"
|
|
state_class: total_increasing
|
|
```
|
|
|
|
### Configuration Variables
|
|
|
|
- name
|
|
|
|
(string)(Required) Name of the sensor..
|
|
|
|
- prometheus_url
|
|
|
|
(string)(Required) the url of your Prometheus server
|
|
|
|
- prometheus_query
|
|
|
|
(string)(Required) the PromQL query to retrieve sensor
|
|
|
|
- unit_of_measurement
|
|
|
|
(string)(Optional) Defines the unit of measurement of the sensor, if any.
|
|
|
|
- state_class
|
|
|
|
(string)(Optional) Defines the type of sensor. `measurement` for metrics that are gauges,
|
|
`total_increasing` for metrics that are counters.
|
|
|
|
It's a custom component so it must be downloaded under /custom_components folder.
|