├── .gitignore ├── .dockerignore ├── .flake8 ├── alertmanager_telegram ├── wsgi.py ├── config.py ├── __init__.py ├── logging.py ├── templating.py └── messaging.py ├── requirements.txt ├── .github └── workflows │ ├── linters.yaml │ └── docker.yaml ├── Dockerfile ├── .pre-commit-config.yaml ├── templates └── default.html ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .venv/ 2 | .vscode/ 3 | -------------------------------------------------------------------------------- /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 88 3 | extend-ignore = E203 4 | -------------------------------------------------------------------------------- /alertmanager_telegram/wsgi.py: -------------------------------------------------------------------------------- 1 | from alertmanager_telegram import create_app 2 | 3 | app = create_app() 4 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | flask>=1.1.2,<2 2 | gunicorn 3 | logzero>=1.5.0,<2 4 | python-telegram-bot==12.7 5 | 6 | markupsafe==2.0.1 7 | -------------------------------------------------------------------------------- /.github/workflows/linters.yaml: -------------------------------------------------------------------------------- 1 | name: Linters 2 | 3 | on: 4 | pull_request: 5 | push: 6 | branches: [ main ] 7 | 8 | jobs: 9 | pre-commit: 10 | uses: janw/workflows/.github/workflows/pre-commit.yaml@main 11 | -------------------------------------------------------------------------------- /.github/workflows/docker.yaml: -------------------------------------------------------------------------------- 1 | name: Docker 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | tags: 7 | - "*" 8 | pull_request: 9 | 10 | jobs: 11 | docker: 12 | uses: janw/workflows/.github/workflows/docker.yaml@main 13 | with: 14 | build-platforms: linux/amd64 15 | -------------------------------------------------------------------------------- /alertmanager_telegram/config.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | TELEGRAM_CHAT_ID = os.environ.get("TELEGRAM_CHAT_ID") 4 | if not TELEGRAM_CHAT_ID: 5 | raise ValueError("No TELEGRAM_CHAT_ID set for application") 6 | 7 | TELEGRAM_TOKEN = os.environ.get("TELEGRAM_TOKEN") 8 | if not TELEGRAM_TOKEN: 9 | raise ValueError("No TELEGRAM_TOKEN set for application") 10 | 11 | TEMPLATES_AUTO_RELOAD = True 12 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.8-slim 2 | 3 | WORKDIR /app 4 | COPY requirements.txt ./ 5 | RUN pip install --no-cache-dir -r requirements.txt 6 | 7 | COPY ./alertmanager_telegram ./alertmanager_telegram 8 | COPY ./templates ./templates 9 | 10 | EXPOSE 8080 11 | ENTRYPOINT [ "gunicorn", "alertmanager_telegram.wsgi:app", "--logger-class", "alertmanager_telegram.logging.GunicornLogger", "-b", "0.0.0.0:8080" ] 12 | -------------------------------------------------------------------------------- /alertmanager_telegram/__init__.py: -------------------------------------------------------------------------------- 1 | import telegram 2 | from flask import Flask 3 | 4 | from alertmanager_telegram.logging import logger 5 | 6 | 7 | def create_app(): 8 | app = Flask(__name__) 9 | app.config.from_object("alertmanager_telegram.config") 10 | token = app.config["TELEGRAM_TOKEN"] 11 | 12 | app.bot = telegram.Bot(token) 13 | 14 | from alertmanager_telegram.messaging import blueprint 15 | 16 | app.register_blueprint(blueprint) 17 | 18 | logger.info("Created app instance") 19 | return app 20 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/pre-commit-hooks 3 | rev: "v4.4.0" 4 | hooks: 5 | - id: trailing-whitespace 6 | - id: end-of-file-fixer 7 | - id: check-yaml 8 | 9 | - repo: https://github.com/pycqa/flake8 10 | rev: "6.0.0" 11 | hooks: 12 | - id: flake8 13 | additional_dependencies: ["flake8-bugbear"] 14 | 15 | - repo: https://github.com/pycqa/isort 16 | rev: "5.12.0" 17 | hooks: 18 | - id: isort 19 | 20 | - repo: https://github.com/python/black 21 | rev: "23.3.0" 22 | hooks: 23 | - id: black 24 | -------------------------------------------------------------------------------- /alertmanager_telegram/logging.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | 4 | import logzero 5 | from gunicorn.glogging import Logger 6 | 7 | _log_level = os.environ.get("LOG_LEVEL", "info").upper() 8 | log_level = getattr(logging, _log_level) 9 | log_format = "%(color)s[%(levelname)1.1s %(asctime)s %(name)s]%(end_color)s %(message)s" 10 | 11 | formatter = logzero.LogFormatter(fmt=log_format) 12 | logger_args = dict(level=log_level, formatter=formatter) 13 | 14 | logzero.__name__ = "" 15 | logzero.setup_logger(**logger_args) 16 | logzero.setup_default_logger(**logger_args) 17 | logger = logzero.setup_logger("alertmanager_telegram", **logger_args) 18 | 19 | 20 | class GunicornLogger(Logger): 21 | def __init__(self, cfg): 22 | super().__init__(cfg) 23 | 24 | self.error_log = logzero.setup_logger("gunicorn", **logger_args) 25 | -------------------------------------------------------------------------------- /templates/default.html: -------------------------------------------------------------------------------- 1 | {% if status == 'firing' -%} 2 | 👩‍🚒 3 | {%- else -%} 4 | 🍻 5 | {%- endif -%} 6 | {{ status | title }}: {{commonLabels.alertname}} ({{ alerts | length }}) 7 | {%- if status == 'firing' and commonLabels.severity == "critical" %} ‼️ 8 | {%- endif %} 9 | 10 | {{ commonAnnotations.summary|e }} 11 | {% for label, value in commonAnnotations.items() if label != "summary" %} 12 | {{ label }}: {{value}} 13 | {%- endfor %} 14 | {% for label, value in commonLabels.items() if label != "alertname" %} 15 | {{ label }}: {{value}} 16 | {%- endfor %} 17 | 18 | {% for alert in alerts %} 19 | {%- for label, value in alert.annotations.items() %} 20 | {{ label }}: {{value}} 21 | {%- endfor %} 22 | {%- for label, value in alert.labels.items() %} 23 | {{ label }}: {{value}} 24 | {%- endfor -%} 25 | {%- if loop.last -%} 26 | Go to source 27 | {% endif %} 28 | {% endfor -%} 29 | {% if ellipsis or truncatedAlerts == 1 %} 30 | … (list truncated) 31 | {% endif -%} 32 | Go to Alertmanager 33 | -------------------------------------------------------------------------------- /alertmanager_telegram/templating.py: -------------------------------------------------------------------------------- 1 | from flask import render_template 2 | from telegram.constants import MAX_MESSAGE_LENGTH 3 | 4 | from alertmanager_telegram.logging import logger 5 | 6 | 7 | def render(content): 8 | alerts = content["alerts"] 9 | 10 | common_labels = content.get("commonLabels", {}) 11 | common_annotations = content.get("commonAnnotations", {}) 12 | for alert in alerts: 13 | if "labels" in alert: 14 | labels = alert["labels"] 15 | for label in common_labels.keys(): 16 | labels.pop(label, None) 17 | 18 | if "annotations" in alert: 19 | annotations = alert["annotations"] 20 | for annotation in common_annotations.keys(): 21 | annotations.pop(annotation, None) 22 | 23 | message = render_template("default.html", **content) 24 | while len(message) > MAX_MESSAGE_LENGTH and len(content["alerts"]) > 0: 25 | logger.debug("Truncating alerts list (with ellipsis)") 26 | content["alerts"].pop() 27 | content["ellipsis"] = True 28 | message = render_template("default.html", **content) 29 | 30 | if len(message) > MAX_MESSAGE_LENGTH: 31 | msg = "Message template is too long" 32 | logger.error(msg) 33 | return msg 34 | 35 | return message 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Alertmanager Telegram relay 2 | 3 | A simple webhook notification relay for Prometheus Alertmanager. 4 | 5 | ## Running with Docker 6 | 7 | First, you'll need two environment variables: 8 | 9 | * `TELEGRAM_CHAT_ID`: Your Telegram user ID. Retrieve it from [@userinfobot](https://t.me/userinfobot). 10 | * `TELEGRAM_TOKEN`: An API token for a bot you created to send you the alert messages. Create one via [@botfather](https://t.me/botfather). 11 | 12 | Next, provide the variables to the docker container: 13 | 14 | ```bash 15 | docker run \ 16 | --name alertmanager-telegram \ 17 | -e TELEGRAM_CHAT_ID="..." \ 18 | -e TELEGRAM_TOKEN="..." \ 19 | -p 8080:8080 \ 20 | ghcr.io/janw/alertmanager-telegram 21 | ``` 22 | 23 | Finally, in the Alertmanager config, add the relay as a webhook receiver: 24 | 25 | ```yaml 26 | receivers: 27 | - name: "telegram" 28 | webhook_configs: 29 | - url: "http://alertmanager-telegram:8080/alerts" 30 | send_resolved: true 31 | ``` 32 | 33 | ## Templating 34 | 35 | A custom alert template can be added by overriding `/templates/default.html`: 36 | 37 | ```bash 38 | docker run \ 39 | --name alertmanager-telegram \ 40 | -e TELEGRAM_CHAT_ID="..." \ 41 | -e TELEGRAM_TOKEN="..." \ 42 | -v /path/to/my/template.html:/templates/default.html \ 43 | -p 8080:8080 \ 44 | janwh/alertmanager-telegram 45 | ``` 46 | -------------------------------------------------------------------------------- /alertmanager_telegram/messaging.py: -------------------------------------------------------------------------------- 1 | from flask import Blueprint, current_app, jsonify, request 2 | 3 | from alertmanager_telegram.logging import logger 4 | from alertmanager_telegram.templating import render 5 | 6 | blueprint = Blueprint("messaging", __name__, template_folder="../templates") 7 | 8 | 9 | @blueprint.route("/alerts", methods=["POST"]) 10 | def alerts(): 11 | content = request.get_json() 12 | 13 | if "alerts" not in content or "status" not in content: 14 | logger.warning("Received invalid request") 15 | return jsonify(status="invalid"), 400 16 | 17 | alert_count = len(content["alerts"]) 18 | alert_status = content["status"] 19 | chat_id = current_app.config["TELEGRAM_CHAT_ID"] 20 | 21 | logger.info(f"Received {alert_count} alerts (status={alert_status})") 22 | try: 23 | text = render(content) 24 | except Exception: 25 | logger.exception("Exception in message rendering") 26 | return jsonify(status="failed"), 500 27 | 28 | try: 29 | current_app.bot.send_message( 30 | chat_id=chat_id, 31 | parse_mode="HTML", 32 | disable_web_page_preview=True, 33 | text=text, 34 | ) 35 | except Exception: 36 | logger.exception("Exception during sending message") 37 | return jsonify(status="failed"), 500 38 | 39 | logger.info("Sent message") 40 | return jsonify(status="success"), 200 41 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------