Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DanCech authored Feb 8, 2024
1 parent 3b86d81 commit 41031ff
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions grafana_cloud/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Home Assistant Add-on: Grafana Cloud

Easily export Home Assistant stats to Grafana Cloud
![Supports aarch64 Architecture][aarch64-shield]
![Supports amd64 Architecture][amd64-shield]

Easily export Home Assistant stats to Grafana Cloud.

## About

This addon makes it easy to export Home Assistant metrics and logs to Grafana Cloud
This addon makes it easy to export Home Assistant metrics and logs to [Grafana Cloud][grafana-cloud]

It will gather stats from your Home Assistant install and export them to Grafana Cloud where you can build beautiful custom dashboards.
It will gather stats from your Home Assistant install using the [Grafana Agent][grafana-agent] and export them to Grafana Cloud where you can build beautiful custom dashboards.

## Setup

Expand All @@ -20,7 +23,7 @@ prometheus:

If you would like to define the specific stats you would like to expose, you can follow the instructions in the Prometheus [integration docs](https://www.home-assistant.io/integrations/prometheus/).

To configure the Grafana Cloud addon, first create a [Grafana Cloud](https://grafana.com/products/cloud/) account and set up your stack.
To configure the Grafana Cloud addon, first create a [Grafana Cloud][grafana-cloud] account and set up your stack.

Copy the stack name, and paste it into the stack name field in the addon configuration.

Expand All @@ -34,17 +37,19 @@ Next you need to create a new Access Policy:
- Logs: write
- Stacks: read

![Create Access Policy](images/create-access-policy.png)
![Create Access Policy](https://github.com/grafana/home-assistant-addons/raw/main/grafana_cloud/images/create-access-policy.png)

Finally, add a token to the policy.

Copy the token, and paste it into the token field in the addon configuration.

![Create Access Token](images/create-access-token.png)
![Create Access Token](https://github.com/grafana/home-assistant-addons/raw/main/grafana_cloud/images/create-access-token.png)

After saving the configuration, start the addon and it will begin exporting logs and metrics to Grafana Cloud
After saving the configuration, start the addon and it will begin exporting logs and metrics to Grafana Cloud.

[grafana]: https://grafana.com
[grafana-cloud]: https://grafana.com/products/cloud/
[grafana-agent]: https://grafana.com/docs/agent/latest/
[integration]: https://grafana.com/solutions/home-assistant/monitor/
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg

0 comments on commit 41031ff

Please sign in to comment.