mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-25 20:36:50 +00:00
88 lines
3.0 KiB
Markdown
88 lines
3.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Prometheus"
|
|
description: "Record events in Prometheus."
|
|
date: 2017-06-25 08:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
logo: prometheus.png
|
|
footer: true
|
|
ha_category: "History"
|
|
ha_release: 0.49
|
|
---
|
|
|
|
The `prometheus` component exposes metrics in a format which [Prometheus](https://prometheus.io/) can read.
|
|
|
|
To use the `prometheus` component in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
prometheus:
|
|
```
|
|
|
|
{% configuration %}
|
|
namespace:
|
|
description: 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)
|
|
required: false
|
|
type: string
|
|
filter:
|
|
description: Filtering directives for the components which should be included or excluded from recording.
|
|
required: false
|
|
type: list
|
|
keys:
|
|
exclude:
|
|
description: Excluded from recording.
|
|
required: false
|
|
type: list
|
|
keys:
|
|
entities:
|
|
description: The list of entity ids to be excluded from recording.
|
|
required: false
|
|
type: list
|
|
domains:
|
|
description: The list of domains to be excluded from recording.
|
|
required: false
|
|
type: list
|
|
include:
|
|
description: Included in recordings. If set, all other entities will not be recorded. Values set by the **exclude** option will prevail.
|
|
required: false
|
|
type: list
|
|
keys:
|
|
entities:
|
|
description: The list of entity ids to be included from recordings.
|
|
required: false
|
|
type: list
|
|
domains:
|
|
description: The list of domains to be included from recordings.
|
|
required: false
|
|
type: list
|
|
{% endconfiguration %}
|
|
|
|
You can then configure Prometheus to fetch metrics from Home Assistant by adding to its `scrape_configs` configuration.
|
|
|
|
```yaml
|
|
# 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](https://github.com/prometheus/client_python) 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.
|