diff --git a/homeassistant/components/prometheus/README.md b/homeassistant/components/prometheus/README.md new file mode 100644 index 0000000000000000000000000000000000000000..64a6bdc48855eef8fb7bfe9dd4b90975bb704e6f --- /dev/null +++ b/homeassistant/components/prometheus/README.md @@ -0,0 +1,15 @@ +# 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](https://prometheus.io/docs/practices/naming/). +* 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).