nikdoof/homeassistant-prometheus-query
1
0
Fork 0
mirror of https://github.com/nikdoof/homeassistant-prometheus-query.git synced 2025-12-20 22:09:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
85d4acb2293e98d47b8615d415c9e4a7f35eef77
homeassistant-prometheus-query/README.md
Grégoire Seux 4fbe9c5660 Support state class propoerty for sensor 
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
2021-08-29 21:14:40 +02:00

1.3 KiB
Raw Blame History

homeassistant-prometheus-query

Inspired from homeassitant Command line Sensor this sensor take values from Prometheus metrics using PromQL 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:

# 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.