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: over 1 year 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 (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-16T18:48:18.000Z (almost 5 years ago)
- Last Synced: 2025-04-23T03:06:29.422Z (over 1 year ago)
- Topics: grafana, matrix-protocol
- Language: Ruby
- Size: 70.3 KB
- Stars: 16
- Watchers: 4
- 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;
## 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).