mirror of https://github.com/nikdoof/homeassistant-prometheus-query.git synced 2025-12-18 04:59:21 +00:00

Go to file

Grégoire Seux 85d4acb229 Migrate to SensorEntity base class

Goal is to be usable as a source of energy in the energy dashboard.
Starting with HA 2021.9 (still in beta), sensors will be have long term
stats and be usable in energy dashboard.
It also gives a better integration with base classes of home assistant
and decrease code in this custom component.

Change-Id: Ide1967ac181c0cf7f093cff539aae2b1cdccd9b4

2021-08-29 21:14:40 +02:00

custom_components/prometheus_query

Migrate to SensorEntity base class

2021-08-29 21:14:40 +02:00

hacs.json

Create hacs.json

2020-10-28 21:39:24 +01:00

info.md

Create info.md

2020-10-28 21:41:33 +01:00

README.md

Support state class propoerty for sensor

2021-08-29 21:14:40 +02:00

README.md

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.