https://github.com/ananace/ruby-grafana-matrix

A Matrix notification ingress for Grafana alerting webhooks
https://github.com/ananace/ruby-grafana-matrix

grafana matrix-protocol

Last synced: 2 months ago
JSON representation

A Matrix notification ingress for Grafana alerting webhooks

• Host: GitHub
• URL: https://github.com/ananace/ruby-grafana-matrix
• Owner: ananace
• License: mit
• Created: 2018-07-27T09:24:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-16T18:48:18.000Z (about 3 years ago)
• Last Synced: 2024-10-03T09:47:52.148Z (3 months ago)
• Topics: grafana, matrix-protocol
• Language: Ruby
• Size: 70.3 KB
• Stars: 16
• Watchers: 5
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Grafana Matrix

A Grafana webhook ingress for sending Matrix notifications

Working:

- Simple notifications

- Authenticated requests

TODO:

- Proper styling

## Installation / Usage

Until a more proper release is done;  

Download the git repo, instantiate the bundle, create a proper configuration file, and launch the server

```sh

git clone https://github.com/ananace/ruby-grafana-matrix

cd ruby-grafana-matrix

bundle install --path=vendor

cp config.yml.example config.yml

vi config.yml

# Edit the configuration to suit your requirements

bundle exec rackup

```

You would then add the ingester as a Grafana webhook channel like so - albeit with port 9292 unless changed;

![Grafana config](https://i.imgur.com/Cu4m8Ew.png)

## Docker

Build the image:

`docker build -t ruby-grafana-matrix:latest .`

Create a proper configuration file:

```sh

cp config.yml.example config.yml

vi config.yml

```

Run the resulting container, and mount your `config.yml` inside of it:

`docker run -v $PWD/config.yml:/app/config.yml --name ruby-grafana-matrix ruby-grafana-matrix:latest`

If running the container on the same host as Grafana, you can attach it to the same Docker network and use the container name in the Grafana webhook URL.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/ruby-grafana-matrix

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).