evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
hass-core/homeassistant/components/prometheus/README.md
Anton Tolchanov 6ca476fe21
Add prometheus metric naming guidelines (#37149) 
* Add prometheus metric naming guidelines.

* Update homeassistant/components/prometheus/README.md

Co-authored-by: Martin Weinelt <mweinelt@users.noreply.github.com>

Co-authored-by: Martin Weinelt <mweinelt@users.noreply.github.com>
2020-07-05 19:00:37 +02:00

586 B
Raw Blame History

Prometheus integration

This integration exposes metrics in a Prometheus compatible format.

Metric naming guidelines

Please follow these guidelines while defining metrics.

  • Metric and label names should conform to Prometheus naming guidelines.
  • Domain-specific metrics should have the domain (sensor, switch, climate, etc.) as a metric name prefix.
  • Enum-like values (e.g. entity state or current mode) should be exported using a "boolean" metric (values of 0 or 1) broken down by state/mode (as a metric label).