core/homeassistant/components/prometheus
Joost Lekkerkerker 11f00895f7
Add legacy to integrations that have not moved to the UI (#131171)
2024-11-22 19:33:50 +01:00
..
README.md
__init__.py Unexport unavailable metrics in Prometheus (#125492) 2024-10-29 17:56:54 +01:00
manifest.json Add legacy to integrations that have not moved to the UI (#131171) 2024-11-22 19:33:50 +01:00

README.md

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