diff --git a/README.md b/README.md index cfb62eb..04eccf8 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,22 @@ -# Nio Template [![Built with matrix-nio](https://img.shields.io/badge/built%20with-matrix--nio-brightgreen)](https://github.com/poljar/matrix-nio) +# Matrix AlertBot [![Built with matrix-nio](https://img.shields.io/badge/built%20with-matrix--nio-brightgreen)](https://github.com/poljar/matrix-nio) -A template for creating bots with -[matrix-nio](https://github.com/poljar/matrix-nio). The documentation for -matrix-nio can be found -[here](https://matrix-nio.readthedocs.io/en/latest/nio.html). +A bot that receives alert from [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager) to send them to a Matrix room. Users can interract with the bot to create silences for the alerts. -This repo contains a working Matrix echo bot that can be easily extended to your needs. Detailed documentation is included as well as a step-by-step guide on basic bot building. +Features include: -Features include out-of-the-box support for: - -* Bot commands -* SQLite3 and Postgres database backends -* Configuration files -* Multi-level logging -* Docker +* Send alerts from Alertmanager to a Matrix room +* Add a reaction to an alert to create a silence until the alert is resolved +* Reply to an alert to create a silence with a given duration +* Reply to an alert to create a silence until the alert is resolved +* Remove silences created through the bot * Participation in end-to-end encrypted rooms -## Projects using nio-template - -* [anoadragon453/matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot -) - A matrix bot to remind you about things -* [gracchus163/hopeless](https://github.com/gracchus163/hopeless) - COREbot for the Hope2020 conference Matrix server -* [alturiak/nio-smith](https://github.com/alturiak/nio-smith) - A modular bot for @matrix-org that can be dynamically -extended by plugins -* [anoadragon453/msc-chatbot](https://github.com/anoadragon453/msc-chatbot) - A matrix bot for matrix spec proposals -* [anoadragon453/matrix-episode-bot](https://github.com/anoadragon453/matrix-episode-bot) - A matrix bot to post episode links -* [TheForcer/vision-nio](https://github.com/TheForcer/vision-nio) - A general purpose matrix chatbot -* [anoadragon453/drawing-challenge-bot](https://github.com/anoadragon453/drawing-challenge-bot) - A matrix bot to -post historical, weekly art challenges from reddit to a room -* [8go/matrix-eno-bot](https://github.com/8go/matrix-eno-bot) - A bot to be used as a) personal assistant or b) as -an admin tool to maintain your Matrix installation or server -* [elokapina/bubo](https://github.com/elokapina/bubo) - Matrix bot to help with community management -* [elokapina/middleman](https://github.com/elokapina/middleman) - Matrix bot to act as a middleman, for example as a support bot -* [chc4/matrix-pinbot](https://github.com/chc4/matrix-pinbot) - Matrix bot for pinning messages to a dedicated channel - -Want your project listed here? [Edit this -page!](https://github.com/anoadragon453/nio-template/edit/master/README.md) - ## Getting started See [SETUP.md](SETUP.md) for how to setup and run the template project. ## Project structure -*A reference of each file included in the template repository, its purpose and -what it does.* - The majority of the code is kept inside of the `matrix_alertbot` folder, which is in itself a [python package](https://docs.python.org/3/tutorial/modules.html), the `__init__.py` file inside declaring it as such. @@ -55,106 +26,10 @@ available. It will import the `main` function from the `main.py` file in the package and run it. To properly install this script into your python environment, run `pip install -e .` in the project's root directory. -`setup.py` contains package information (for publishing your code to +`setup.py` contains package information (for publishing the code to [PyPI](https://pypi.org)) and `setup.cfg` just contains some configuration options for linting tools. -`sample.config.yaml` is a sample configuration file. People running your bot -should be advised to copy this file to `config.yaml`, then edit it according to -their needs. Be sure never to check the edited `config.yaml` into source control +`sample.config.yaml` is a sample configuration file. You should copy this file to `config.yaml`, then edit it according to +your needs. Be sure never to check the edited `config.yaml` into source control since it'll likely contain sensitive details such as passwords! - -Below is a detailed description of each of the source code files contained within -the `matrix_alertbot` directory: - -### `main.py` - -Initialises the config file, the bot store, and nio's AsyncClient (which is -used to retrieve and send events to a matrix homeserver). It also registering -some callbacks on the AsyncClient to tell it to call some functions when -certain events are received (such as an invite to a room, or a new message in a -room the bot is in). - -It also starts the sync loop. Matrix clients "sync" with a homeserver, by -asking constantly asking for new events. Each time they do, the client gets a -sync token (stored in the `next_batch` field of the sync response). If the -client provides this token the next time it syncs (using the `since` parameter -on the `AsyncClient.sync` method), the homeserver will only return new event -*since* those specified by the given token. - -This token is saved and provided again automatically by using the -`client.sync_forever(...)` method. - -### `config.py` - -This file reads a config file at a given path (hardcoded as `config.yaml` in -`main.py`), processes everything in it and makes the values available to the -rest of the bot's code so it knows what to do. Most of the options in the given -config file have default values, so things will continue to work even if an -option is left out of the config file. Obviously there are some config values -that are required though, like the homeserver URL, username, access token etc. -Otherwise the bot can't function. - -### `storage.py` - -Creates (if necessary) and connects to a SQLite3 database and provides commands -to put or retrieve data from it. Table definitions should be specified in -`_initial_setup`, and any necessary migrations should be put in -`_run_migrations`. There's currently no defined method for how migrations -should work though. - -### `callbacks.py` - -Holds callback methods which get run when the bot get a certain type of event -from the homserver during sync. The type and name of the method to be called -are specified in `main.py`. Currently there are two defined methods, one that -gets called when a message is sent in a room the bot is in, and another that -runs when the bot receives an invite to the room. - -The message callback function, `message`, checks if the message was for the -bot, and whether it was a command. If both of those are true, the bot will -process that command. - -The invite callback function, `invite`, processes the invite event and attempts -to join the room. This way, the bot will auto-join any room it is invited to. - -### `bot_commands.py` - -Where all the bot's commands are defined. New commands should be defined in -`process` with an associated private method. `echo` and `help` commands are -provided by default. - -A `Command` object is created when a message comes in that's recognised as a -command from a user directed at the bot (either through the specified command -prefix (defined by the bot's config file), or through a private message -directly to the bot. The `process` command is then called for the bot to act on -that command. - -### `message_responses.py` - -Where responses to messages that are posted in a room (but not necessarily -directed at the bot) are specified. `callbacks.py` will listen for messages in -rooms the bot is in, and upon receiving one will create a new `Message` object -(which contains the message text, amongst other things) and calls `process()` -on it, which can send a message to the room as it sees fit. - -A good example of this would be a Github bot that listens for people mentioning -issue numbers in chat (e.g. "We should fix #123"), and the bot sending messages -to the room immediately afterwards with the issue name and link. - -### `chat_functions.py` - -A separate file to hold helper methods related to messaging. Mostly just for -organisational purposes. Currently just holds `send_text_to_room`, a helper -method for sending formatted messages to a room. - -### `errors.py` - -Custom error types for the bot. Currently there's only one special type that's -defined for when a error is found while the config file is being processed. - -## Questions? - -Any questions? Please ask them in -[#nio-template:amorgan.xyz](https://matrix.to/#/!vmWBOsOkoOtVHMzZgN:amorgan.xyz?via=amorgan.xyz) -and we'll help you out!