home-assistant-grafana-relay

Grafana ❤️ Home-assistant

Listens for alerts send via webhooks from Grafana and relays them as notifications using Home-assistant. Alerts will be shown in home-assistant app and can additionally used in smart-home automations.

Configuration

Configuration is done via environment variables.

Variable	Description	Example
AUTH_TOKEN	Home-assistant auth token	LONG_LIVED_ACCESS_TOKEN
HM_SERVICE_URI	Home-assistant API endpoint	http://home.domain.tld/api/services/notify/notify
LISTEN_PORT	Port to listen on	12000
LISTEN_HOST	Adress to listen on	localhost

Home-assistant

Generate a long-lived access token in home-assistant. Tokens can be created in the profile section (https://home.domain.tld/profile).

Grafana

Create a new notification channel in grafana under https://mydomain.tld/alerting/notification/new of type webhook. Make sure to check the Include Image checkbox. As URL enter where this relay service will be listening, e.g. localhost:12000.

Example

In production you might want to write systemd service. A minimal working setup looks like this.

export AUTH_TOKEN="LONG_LIVED_ACCESS_TOKEN"
export HM_SERVICE_URI="http://home.domain.tld/api/services/notify/notify"
export LISTEN_PORT="12000"
export LISTEN_HOST="localhost"
./home-assistant-grafana-relay

Run with docker-compose

To build and run the service with docker, you can use the Dockerfile. In production you can use docker-compose to start the service automatically:

1. clone this repository
2. create .env from .env.example
3. cd home-assistant-grafana-relay
4. docker-compose up -d

NixOS module

A flake.nix file is included for compatibility with Nix Flakes for those that wish to use it as a module. A bare-minimum flake.nix would be as follows:

{
  description = "NixOS configuration";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    ha-relay.url = "github:pinpox/home-assistant-grafana-relay";
  };

  outputs = inputs@ { ha-relay, nixpkgs, ... }: {
    nixosConfigurations = {
      hostname = nixpkgs.lib.nixosSystem {
        system = "x86_64-linux";
        specialArgs = { inherit inputs; };
        modules = [
          ./configuration.nix
          ha-relay.nixosModules.ha-relay
          {
            pinpox.services.home-assistant-grafana-relay = {
              enable = true;
              listenHost = "localhost";
              listenPort = "12000";
              haUri = "https://home.domain.com/api/services/notify/notify";
              envFile = "/var/secrets/ha-envfile";
            };
          }
        ];
      };
    };
  };
}

The envfile can be used to provide the token without putting it in the nix store.

AUTH_TOKEN="LONG_LIVED_ACCESS_TOKEN"