mirror of
https://github.com/nikdoof/homeassistant-prometheus-query.git
synced 2025-12-20 22:09:23 +00:00
48 lines
1.4 KiB
Markdown
48 lines
1.4 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: measurement
|
|
device_class: temperature
|
|
```
|
|
|
|
### 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.
|
|
|
|
- device_class
|
|
|
|
(string)(Optional) Defines the sensor icon for dashboard. `temperature | power | battery` for metrics that are gauges
|
|
|
|
It's a custom component so it must be downloaded under /custom_components folder.
|