---
title: "Home Assistant integration | Grafana Cloud documentation"
description: "Learn about Home Assistant Grafana Cloud integration."
---

> For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt).

# Home Assistant integration for Grafana Cloud

Home Assistant is an open-source software platform designed for home automation, which enables users to control and monitor various devices and services in their home through a single, user-friendly interface. Home Assistant can run on a variety of devices, including Raspberry Pi, and can integrate with other popular home automation platforms like Amazon Alexa and Google Assistant. This integration connects your Home Assistant instance to Grafana cloud to visualize metrics through a pre-built dashboard.

This integration includes 1 pre-built dashboard to help monitor and visualize Home Assistant metrics.

## Before you begin

In order for the integration to work, you must configure the [in-built Prometheus exporter for Home Assistant](https://www.home-assistant.io/integrations/prometheus/).

At minimum you’ll need to add the `prometheus:` directive to your `configuration.yaml` file:

![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```none
# Example configuration.yaml entry
prometheus:
```

You will also need to create a [long-lived access token](https://www.home-assistant.io/docs/authentication/) which will be used to authenticate Alloy with Home Assistant.

## Install Home Assistant integration for Grafana Cloud

1. In your Grafana Cloud stack, click **Connections** in the left-hand menu.
2. Find **Home Assistant** and click its tile to open the integration.
3. Review the prerequisites in the **Configuration Details** tab and set up Grafana Alloy to send Home Assistant metrics to your Grafana Cloud instance.
4. Click **Install** to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your Home Assistant setup.

## Configuration snippets for Grafana Alloy

### Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your Home Assistant instances, **manually** copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

### Advanced metrics snippets

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
discovery.relabel "metrics_integrations_integrations_hass" {
	targets = [{
		__address__ = "localhost:8123",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_hass" {
	targets      = discovery.relabel.metrics_integrations_integrations_hass.output
	forward_to   = [prometheus.remote_write.metrics_service.receiver]
	job_name     = "integrations/hass"
	metrics_path = "/api/prometheus"
	scheme       = "https"

	authorization {
		type        = "Bearer"
		credentials = "<your long lived HASS API token>"
	}
}
```

To monitor your Home Assistant instance, you must use a [discovery.relabel](/docs/alloy/latest/reference/components/discovery.relabel/) component to discover your Home Assistant Prometheus endpoint and apply appropriate labels, followed by a [prometheus.scrape](/docs/alloy/latest/reference/components/prometheus.scrape) component to scrape it.

Configure the following properties within each `discovery.relabel` component:

- `__address__`: The address to your Home Assistant Prometheus metrics endpoint.
- `instance` label: `constants.hostname` sets the `instance` label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Home Assistant instance.

If you have multiple Home Assistant servers to scrape, configure one `discovery.relabel` for each and scrape them by including each under `targets` within the `prometheus.scrape` component.

## Dashboards

The Home Assistant integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

- Home Assistant

## Metrics

The most important metrics provided by the Home Assistant integration, which are used on the pre-built dashboard, are as follows:

- .\*battery\_level
- .\*battery\_level\_percent
- .\*battery\_percent
- .\*binary\_sensor\_state
- .\*climate\_action
- .\*current\_temperature\_c
- .\*entity\_available
- .\*humidifier\_target\_humidity\_percent
- .\*humidity\_percent
- .\*input\_boolean\_state
- .\*last\_updated\_time\_seconds
- .\*light\_state
- .\*lock\_state
- .\*sensor\_unit\_.+
- .\*switch\_state
- .\*temperature\_c

## Changelog

md ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```md
# 1.0.0 - December 2025

* Chore: Fix incorrect semver to 1.0.0. No further changes

# 0.0.4 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.3 - January 2023

* Update mixin to latest version:
  - Addressed lint warnings from mixtool

# 0.0.2 - January 2022

* Added `homeassistant` as default metrics prefix

# 0.0.1 - June 2021

* Initial release
```

## Cost

By connecting your Home Assistant instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see [Active series and dpm usage](/docs/grafana-cloud/fundamentals/active-series-and-dpm/) and [Cloud tier pricing](/products/cloud/pricing/).