From c5888160134c61b5a54d66a972e73e6be5b90f82 Mon Sep 17 00:00:00 2001 From: Jan Grewe Date: Tue, 30 Aug 2022 00:55:58 +0200 Subject: [PATCH] Add Prometheus metrics relabeling (#2238) Co-authored-by: Jan Grewe --- components/prometheus.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/components/prometheus.rst b/components/prometheus.rst index 315e23b10..37b9dd0b0 100644 --- a/components/prometheus.rst +++ b/components/prometheus.rst @@ -29,6 +29,7 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **include_internal** (*Optional*, boolean): Whether ``internal`` entities should be displayed on the web interface. Defaults to ``false``. +- **relabel** (*Optional*): Override metric labels. See :ref:`prometheus-relabel` .. note:: @@ -41,6 +42,32 @@ Configuration variables: static_configs: - targets: [] +Metric Relabeling +----------------- + +ESPHome allows you to do some basic relabeling of Prometheus metrics. +This is useful if you want to have different metric names or IDs than those shown in Home Assistant or the web interface. + +You can relabel metric name or ID labels by adding a ``relabel`` block in the ``prometheus`` configuration, +and then adding a block with ``id`` and/or ``name`` fields for each sensor whose labels your want to override. + +.. _prometheus-relabel: + +``relabel`` +*********** + +Set the the ``id`` and ``name`` label values of the Prometheus metric for the sensor with the specified ID. + +.. code-block:: yaml + + # Example configuration entry + prometheus: + relabel: + my_voltage_sensor: + id: angry_pixies + name: "Angry Pixies" + + See Also --------