Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idealista/prom2teams
prom2teams is an HTTP server built with Python that receives alert notifications from a previously configured Prometheus Alertmanager instance and forwards it to Microsoft Teams using defined connectors
https://github.com/idealista/prom2teams
alerting alertmanager devops docker docker-image helm-chart kubernetes microsoft-teams monitoring prom2teams prometheus prometheus-alertmanager prometheus-alerts prometheus-monitoring webhook
Last synced: 5 days ago
JSON representation
prom2teams is an HTTP server built with Python that receives alert notifications from a previously configured Prometheus Alertmanager instance and forwards it to Microsoft Teams using defined connectors
- Host: GitHub
- URL: https://github.com/idealista/prom2teams
- Owner: idealista
- License: apache-2.0
- Created: 2017-08-23T09:12:49.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-24T17:12:49.000Z (4 months ago)
- Last Synced: 2025-01-10T07:22:44.392Z (12 days ago)
- Topics: alerting, alertmanager, devops, docker, docker-image, helm-chart, kubernetes, microsoft-teams, monitoring, prom2teams, prometheus, prometheus-alertmanager, prometheus-alerts, prometheus-monitoring, webhook
- Language: Python
- Homepage:
- Size: 688 KB
- Stars: 274
- Watchers: 30
- Forks: 88
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.com/idealista/prom2teams)
[](https://sonarcloud.io/dashboard?id=idealista_prom2teams)
[](https://hub.docker.com/r/idealista/prom2teams/)
[](https://hub.docker.com/r/idealista/prom2teams/)
# prom2teams: Prometheus Alertmanager/Microsoft Teams integration
**prom2teams** is a service built with Python that receives alert notifications from a previously configured [Prometheus Alertmanager](https://github.com/prometheus/alertmanager) instance and forwards it to [Microsoft Teams](https://teams.microsoft.com/) using defined connectors.
It presents grouping of alerts, labels/annotations exclusion and a Teams' alert retry policy among its key features.
- [Getting Started](#getting-started)
- [Prerequisities](#prerequisites)
- [Installing](#installing)
- [Usage](#usage)
- [Docker Image](#docker-image)
- [Helm Chart](#helm-chart)
- [Config file](#config-file)
- [Configuring Prometheus](#configuring-prometheus)
- [Templating](#templating)
- [Documentation](#documentation)
- [Swagger UI](#swagger-ui)
- [Testing](#testing)
- [Built With](#built-with)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Contributing](#contributing)
## Getting Started
### Prerequisites
The application has been tested with _Prometheus 2.2.1_, _Python 3.8.0_ and _pip 9.0.1_.
Newer versions of _Prometheus/Python/pip_ should work but could also present issues.
### Installing
prom2teams is present on [PyPI](https://pypi.python.org/pypi/prom2teams), so could be installed using pip3:
```bash
$ pip3 install prom2teams
```
**Note:** Works since v1.1.1
## Usage
**Important:** Config path must be provided with at least one Microsoft Teams Connector. Check the options to know how you can supply it.
```bash
# To start the server (enable metrics, config file path , group alerts by, log file path, log level and Jinja2 template path are optional arguments):
$ prom2teams [--enablemetrics] [--configpath ] [--groupalertsby ("name"|"description"|"instance"|"severity"|"summary")] [--logfilepath ] [--loglevel (DEBUG|INFO|WARNING|ERROR|CRITICAL)] [--templatepath ]
# To show the help message:
$ prom2teams --help
```
Other options to start the service are:
```bash
export APP_CONFIG_FILE=
$ prom2teams
```
**Note:** Grouping alerts works since v2.2.1
### Docker image
Every new Prom2teams release, a new Docker image is built in our [Dockerhub](https://hub.docker.com/r/idealista/prom2teams). We strongly recommend you to use the images with the version tag, though it will be possible to use them without it.
There are two things you need to bear in mind when creating a Prom2teams container:
- The connector URL must be passed as the environment variable `PROM2TEAMS_CONNECTOR`
- In case you want to group alerts, you need to pass the field as the environment variable `PROM2TEAMS_GROUP_ALERTS_BY`
- You need to map container's Prom2teams port to one on your host.
So a sample Docker run command would be:
```bash
$ docker run -it -d -e PROM2TEAMS_GROUP_ALERTS_BY=FIELD_YOU_WANT_TO_GROUP_BY -e PROM2TEAMS_CONNECTOR="CONNECTOR_URL" -p 8089:8089 idealista/prom2teams:VERSION
```
#### Provide custom config file
If you prefer to use your own config file, you just need to provide it as a Docker volume to the container and map it to `/opt/prom2teams/config.ini`. Sample:
```bash
$ docker run -it -d -v pathToTheLocalConfigFile:/opt/prom2teams/config.ini -p 8089:8089 idealista/prom2teams:VERSION
```
### Helm chart
#### Installing the Chart
To install the chart with the release name `my-release` run:
```bash
$ helm install --name my-release /location/of/prom2teams_ROOT/helm
```
After a few seconds, Prom2Teams should be running.
> **Tip**: List all releases using `helm list`, a release is a name used to track a specific deployment
#### Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
##### Helm 2
```bash
$ helm delete my-release
```
> **Tip**: Use helm delete --purge my-release to completely remove the release from Helm internal storage
The command removes all the Kubernetes components associated with the chart and deletes the release.
##### Helm 3
```bash
$ helm uninstall my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
#### Configuration
The following table lists the configurable parameters of the Prom2teams chart and their default values.
| Parameter | Description | Default
| --- | --- | ---
| `image.repository` | The image repository to pull from | `idealista/prom2teams`
| `image.tag` | The image tag to pull | ``
| `image.pullPolicy` | The image pull policy | `IfNotPresent`
| `resources.requests.cpu` | CPU requested for being run in a node | `100m`
| `resources.requests.memory` | Memory requested for being run in a node | `128Mi`
| `resources.limits.cpu` | CPU limit | `200m`
| `resources.limits.memory` | Memory limit | `200Mi`
| `service.type` | Service Map (NodePort/ClusterIP) | `ClusterIP`
| `service.port` | Service Port | `8089`
| `prom2teams.host` | IP to bind to | `0.0.0.0`
| `prom2teams.port` | Port to bind to | `8089`
| `prom2teams.connector` | Connector URL | ``
| `prom2teams.connectors` | A map where the keys are the connector names and the values are the connector webhook urls | `{}`
| `prom2teams.group_alerts_by` | Group_alerts_by field | ``
| `prom2teams.loglevel` | Loglevel | `INFO`
| `prom2teams.templatepath` | Custom Template path (files/teams.j2) | `/opt/prom2teams/helmconfig/teams.j2`
| `prom2teams.config` | Config (specific to Helm) | `/opt/prom2teams/helmconfig/config.ini`
| `prom2teams.extraEnv` | Dictionary of arbitrary additional environment variables for deployment (eg. `HTTP_PROXY`) | ``
### Production
For production environments you should prefer using a WSGI server. [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/)
dependency is installed for an easy usage. Some considerations must be taken to use it:
The binary `prom2teams_uwsgi` launches the app using the uwsgi server. Due to some incompatibilities with [wheel](https://github.com/pypa/wheel)
you must install `prom2teams` using `sudo pip install --no-binary :all: prom2teams` (https://github.com/pypa/wheel/issues/92)
```bash
$ prom2teams_uwsgi
```
And `uwsgi` would look like:
```
[uwsgi]
master = true
processes = 5
#socket = 0.0.0.0:8001
#protocol = http
socket = /tmp/prom2teams.sock
chmod-socket = 777
vacuum = true
env = APP_ENVIRONMENT=pro
env = APP_CONFIG_FILE=/etc/default/prom2teams.ini
```
Consider not provide `chdir` property neither `module` property.
Also you can set the `module` file, by doing a symbolic link: `sudo mkdir -p /usr/local/etc/prom2teams/ && sudo ln -sf /usr/local/lib/python3.7/dist-packages/usr/local/etc/prom2teams/wsgi.py /usr/local/etc/prom2teams/wsgi.py` (check your dist-packages folder)
Another approach is to provide yourself the `module` file [module example](bin/wsgi.py) and the `bin` uwsgi call [uwsgi example](bin/prom2teams_uwsgi)
**Note:** default log level is DEBUG. Messages are redirected to stdout. To enable file log, set the env APP_ENVIRONMENT=(pro|pre)
### Config file
The config file is an [INI file](https://docs.python.org/3/library/configparser.html#supported-ini-file-structure) and should have the structure described below:
```ini
[Microsoft Teams]
# At least one connector is required here
Connector:
AnotherConnector:
...
[HTTP Server]
Host: # default: localhost
Port: # default: 8089
[Log]
Level: # default: DEBUG
Path: # default: /var/log/prom2teams/prom2teams.log
[Template]
Path: # default: app resources default template (./prom2teams/resources/templates/teams.j2)
[Group Alerts]
Field: # alerts won't be grouped by default
[Labels]
Excluded:
[Annotations]
Excluded:
[Teams Client]
RequestTimeout: # defaults to 30 secs
RetryEnable: # defaults to false
RetryWaitTime: # default: 60 secs
MaxPayload: # default: 24KB
```
**Note:** Grouping alerts works since v2.2.0
### Configuring Prometheus
The [webhook receiver](https://prometheus.io/docs/alerting/configuration/#) in Prometheus allows configuring a prom2teams server.
The url is formed by the host and port defined in the previous step.
**Note:** In order to keep compatibility with previous versions, v2.0 keep attending the default connector ("Connector") in the endpoint 0.0.0.0:8089. This will be removed in future versions.
```
// The prom2teams endpoint to send HTTP POST requests to.
url: 0.0.0.0:8089/v2/
```
### Prom2teams Prometheus metrics
Prom2teams uses Flask and, to have the service monitored, we use @rycus66's [Prometheus Flask Exporter](https://github.com/rycus86/prometheus_flask_exporter). This will enable an endpoint in `/metrics` where you could find interesting metrics to monitor such as number of responses with a certain status. To enable this endpoint, just either:
- Use the `--enablemetrics` or `-m` flag when launching prom2teams.
- Set the environment variable `PROM2TEAMS_PROMETHEUS_METRICS=true`.
### Templating
prom2teams provides a [default template](prom2teams/resources/templates/teams.j2) built with [Jinja2](http://jinja.pocoo.org/docs/2.10/) to render messages in Microsoft Teams. This template could be overrided using the 'templatepath' argument ('--templatepath ') during the application start.
Some fields are considered mandatory when received from Alert Manager.
If such a field is not included a default value of 'unknown' is assigned.
All non-mandatory labels not in excluded list are injected in `extra_labels` key. All non-mandatory annotations not in excluded list are injected in `extra_annotations` key.
Alertmanager fingerprints are available in the `fingerprint` key. Fingerprints
are supported by Alertmanager 0.19.0 or greater.
## Documentation
### Swagger UI
Accessing to `:` (e.g. `localhost:8089`) in a web browser shows the API v1 documentation.
Accessing to `:/v2` (e.g. `localhost:8089/v2`) in a web browser shows the API v2 documentation.
## Testing
To run the test suite you should type the following:
```bash
// After cloning prom2teams :)
$ pip install -r requirements.txt
$ python3 -m unittest discover tests
$ cd tests/e2e
$ ./test.sh
```
## Built With
## Versioning
For the versions available, see the [tags on this repository](https://github.com/idealista/prom2teams/tags).
Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
## Authors
* **Idealista** - *Work with* - [idealista](https://github.com/idealista)
See also the list of [contributors](https://github.com/idealista/prom2teams/contributors) who participated in this project.
## License
This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.
## Contributing
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.