Prometheus


The prometheus integration exposes metrics in a format which Prometheus can read.

Configuration

To use the prometheus integration in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
prometheus:

Configuration Variables

namespacestring(Optional)

The “namespace” that will be assigned to all the Prometheus metrics. This is the prefix of the metric name. E.g., having myhass as the namespace will cause the device tracker metrics to be myhass_device_tracker_state, the switch metrics to be myhass_switch_state and so on. The default is to not add any prefix to the metrics name. (available in version 0.73.0 and later)

filterlist(Optional)

Filtering directives for the integrations which should be included or excluded from recording. (Configure Filter)

exclude_entitieslist(Optional)

The list of entity ids to be excluded from recording.

exclude_entity_globslist(Optional)

Exclude all entities matching a listed pattern (e.g., sensor.weather_*).

exclude_domainslist(Optional)

The list of domains to be excluded from recording.

include_entitieslist(Optional)

The list of entity ids to be included from recordings. If set, all other entities will not be recorded. Values set by the exclude_* option will prevail.

include_entity_globslist(Optional)

Include all entities matching a listed pattern (e.g., sensor.weather_*). If set, all other entities will not be recorded. Values set by the exclude_* option will prevail.

include_domainslist(Optional)

The list of domains to be included from recordings. If set, all other entities will not be recorded. Values set by the exclude_* option will prevail.

default_metricstring(Optional)

Metric name to use when an entity doesn’t have a unit.

Default:

uses the entity id of the entity

override_metricstring(Optional)

Metric name to use instead of unit or default metric. This will store all data points in a single metric.

component_configstring(Optional)

This attribute contains component-specific override values. See Customizing devices and services for format.

override_metricstring(Optional)

Metric name to use instead of unit or default metric. This will store all data points in a single metric.

component_config_domainstring(Optional)

This attribute contains domain-specific component override values. See Customizing devices and services for format.

override_metricstring(Optional)

Metric name to use instead of unit or default metric. This will store all data points in a single metric.

component_config_globstring(Optional)

This attribute contains component-specific override values. See Customizing devices and services for format.

override_metricstring(Optional)

Metric name to use instead of unit or default metric. This will store all data points in a single metric.

Configure Filter

By default, no entity will be excluded. To limit which entities are being exposed to Prometheus, you can use the filter parameter.

# Example filter to include specified domains and exclude specified entities
prometheus:
  filter:
    include_domains:
      - alarm_control_panel
      - light
    include_entity_globs:
      - binary_sensor.*_occupancy
    exclude_entities:
      - light.kitchen_light

Filters are applied as follows:

  1. No includes or excludes - pass all entities
  2. Includes, no excludes - only include specified entities
  3. Excludes, no includes - only exclude specified entities
  4. Both includes and excludes:
    • Include domain and/or glob patterns specified
      • If domain is included, and entity not excluded or match exclude glob pattern, pass
      • If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
      • If domain is not included, glob pattern does not match, and entity not included, fail
    • Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
      • If domain is excluded and entity not included, fail
      • If entity matches exclude glob pattern and entity not included, fail
      • If entity does not match any exclude criteria (domain, glob pattern or listed), pass
    • Neither include or exclude specifies domains or glob patterns
      • If entity is included, pass (as #2 above)
      • If entity include and exclude, the entity exclude is ignored

Full Example

Advanced configuration example:

# Advanced configuration.yaml entry
prometheus:
  namespace: hass
  component_config_glob:
    sensor.*_hum:
      override_metric: humidity_percent
    sensor.*_temp:
      override_metric: temperature_c
    sensor.temperature*:
      override_metric: temperature_c
    sensor.*_bat:
      override_metric: battery_percent
  filter:
    include_domains:
      - sensor
    exclude_entity_globs:
      - sensor.weather_*

You can then configure Prometheus to fetch metrics from Home Assistant by adding to its scrape_configs configuration.

# Example Prometheus scrape_configs entry
  - job_name: 'hass'
    scrape_interval: 60s
    metrics_path: /api/prometheus

    # Legacy api password
    params:
      api_password: ['PASSWORD']

    # Long-Lived Access Token
    bearer_token: 'your.longlived.token'

    scheme: https
    static_configs:
      - targets: ['HOSTNAME:8123']

When looking into the metrics on the Prometheus side, there will be:

  • All Home Assistant domains, which can be easily found through the common namespace prefix, if defined.
  • The client library provided metrics, which are a bunch of process_* and also a single pseudo-metric python_info which contains (not as value but as labels) information about the Python version of the client, i.e., the Home Assistant Python interpreter.

Typically, you will only be interested in the first set of metrics.