Skip to content

lrstanley/discord-alertmanager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

82 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

logo

πŸ”— Table of Contents

❔ Why

I utilize the direct integration between AlertManager and Discord, via webhooks. I also wanted a way of managing my silences directly from the same channels where those alerts were being posted, thus why I created this bot. The bot allows you to both manage silences directly via Discords slash commands, as well as interact with AlertManagers webhook messages, to silence specific alerts, pre-configuring the silence with content from that specific alert.

πŸ’» Installation

Check out the releases page for prebuilt versions.

🐳 Container Images (ghcr)

$ docker run -it --rm ghcr.io/lrstanley/discord-alertmanager:master
$ docker run -it --rm ghcr.io/lrstanley/discord-alertmanager:1.0.0
$ docker run -it --rm ghcr.io/lrstanley/discord-alertmanager:latest

🧰 Source

Note that you must have Go installed (latest is usually best).

git clone https://github.com/lrstanley/discord-alertmanager.git && cd discord-alertmanager
make
./discord-alertmanager --help

βš™οΈ Usage

Take a look at the docker-compose.yaml file, helm chart, or the above docker run commands. For references on supported flags/environment variables, take a look at USAGE.md.

πŸ“— Slash Commands

You can utilize Discords slash commands, and add, get, edit, list, and remove silences:

Full list of commands:

slash commands

Example for fetching a specific silence:

/silences get id

Example for listing all active silences:

/silences list

πŸ’¬ Message Commands

You can right click AlertManager webhook events, and add a silence:

silence alert from webhook

You can right click a silence, and update it:

edit silence

Or remove it:

remove silence

πŸ™‹β€β™‚οΈ Support & Assistance

  • ❀️ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
  • πŸ™‹β€β™‚οΈ Take a look at the support document on guidelines for tips on how to ask the right questions.
  • 🐞 For all features/bugs/issues/questions/etc, head over here.

🀝 Contributing

  • ❀️ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
  • πŸ“‹ Please review the contributing doc for submitting issues/a guide on submitting pull requests and helping out.
  • πŸ—οΈ For anything security related, please review this repositories security policy.

βš–οΈ License

MIT License

Copyright (c) 2023 Liam Stanley <me@liamstanley.io>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Also located here

About

alertmanager silence management bot for Discord

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages