mirror of
https://github.com/nikdoof/homeassistant-prometheus-query.git
synced 2025-12-17 04:29:21 +00:00
85d4acb229
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
83 lines
2.9 KiB
Python
83 lines
2.9 KiB
Python
import logging, time
|
|
import requests
|
|
import json
|
|
import voluptuous as vol
|
|
import homeassistant.helpers.config_validation as cv
|
|
from datetime import timedelta
|
|
from homeassistant.helpers.config_validation import PLATFORM_SCHEMA
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.components.sensor import SensorEntity
|
|
from homeassistant.util import Throttle
|
|
from homeassistant.const import (
|
|
CONF_NAME,
|
|
CONF_UNIT_OF_MEASUREMENT,
|
|
STATE_UNKNOWN,
|
|
)
|
|
from homeassistant.components.sensor import (
|
|
DEVICE_CLASSES_SCHEMA,
|
|
STATE_CLASSES_SCHEMA,
|
|
)
|
|
|
|
from prometheus_client import Summary
|
|
|
|
CONF_PROMETHEUS_URL = 'prometheus_url'
|
|
CONF_PROMETHEUS_QUERY = 'prometheus_query'
|
|
CONF_STATE_CLASS = 'state_class'
|
|
CONF_UNIQUE_ID = 'unique_id'
|
|
SCAN_INTERVAL = timedelta(seconds=600)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_PROMETHEUS_URL): cv.string,
|
|
vol.Required(CONF_PROMETHEUS_QUERY): cv.string,
|
|
vol.Required(CONF_NAME): cv.string,
|
|
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
|
|
vol.Optional(CONF_STATE_CLASS): STATE_CLASSES_SCHEMA,
|
|
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
|
})
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the sensor platform."""
|
|
prom_data = {
|
|
'url': str(config.get(CONF_PROMETHEUS_URL)) + "/api/v1/query",
|
|
'query': str(config.get(CONF_PROMETHEUS_QUERY)),
|
|
'name': str(config.get(CONF_NAME)),
|
|
'unit': str(config.get(CONF_UNIT_OF_MEASUREMENT)),
|
|
'state_class': str(config.get(CONF_STATE_CLASS)),
|
|
'unique_id': str(config.get(CONF_UNIQUE_ID)),
|
|
}
|
|
|
|
add_entities([PrometheusQuery(prom_data)], True)
|
|
|
|
|
|
class PrometheusQuery(SensorEntity):
|
|
"""Representation of a Sensor based on Prometheus"""
|
|
def __init__(self, prom_data):
|
|
"""Initialize the sensor."""
|
|
self._url = prom_data["url"]
|
|
self._query = prom_data["query"]
|
|
self._attr_name = prom_data["name"]
|
|
self._state = None
|
|
self._attr_native_unit_of_measurement = prom_data["unit"]
|
|
self._attr_state_class = prom_data["state_class"]
|
|
self._attr_unique_id = f"${prom_data['url']}$${prom_data['query']}"
|
|
if prom_data["unique_id"] is not None:
|
|
self._attr_unique_id = prom_data["unique_id"]
|
|
|
|
def update(self):
|
|
"""Fetch new state data for the sensor.
|
|
This is the only method that should fetch new data for Home Assistant.
|
|
"""
|
|
try:
|
|
response = requests.get(self._url, params={'query': self._query})
|
|
if (response):
|
|
results = response.json()['data']['result']
|
|
self._attr_native_value = results[0]['value'][1]
|
|
else:
|
|
self._attr_native_value = STATE_UNKNOWN
|
|
self._attr_state = self._attr_native_value
|
|
except URLCallError:
|
|
_LOGGER.error("Error when retrieving update data")
|