pax_global_header00006660000000000000000000000064135146213670014522gustar00rootroot0000000000000052 comment=06ead846dd24dd2fd6f8e131bced2cf40147a053 prometheus-xmpp-alerts-0.4.2/000077500000000000000000000000001351462136700161725ustar00rootroot00000000000000prometheus-xmpp-alerts-0.4.2/.gitignore000066400000000000000000000000461351462136700201620ustar00rootroot00000000000000prometheus_xmpp_alerts.egg-info .eggs prometheus-xmpp-alerts-0.4.2/.travis.yml000066400000000000000000000002771351462136700203110ustar00rootroot00000000000000language: python sudo: false cache: pip dist: xenial python: - 3.6 - 3.7 install: - pip install pyasn1 flake8 - python setup.py develop script: - python setup.py test - flake8 prometheus-xmpp-alerts-0.4.2/Dockerfile000066400000000000000000000013271351462136700201670ustar00rootroot00000000000000FROM python:3.7-alpine AS build-env RUN apk add --no-cache \ gcc \ musl-dev \ libffi-dev RUN pip install \ slixmpp \ aiohttp \ pyyaml \ prometheus_client FROM python:3.7-alpine COPY --from=build-env /usr/local/lib/python3.7/site-packages/ /usr/local/lib/python3.7/site-packages/ ADD ./prometheus-xmpp-alerts /prometheus-xmpp-alerts ADD ./prometheus_xmpp /prometheus_xmpp ADD ./xmpp-alerts.yml.example /etc/prometheus/xmpp-alerts.yml RUN sed -i 's/127.0.0.1/0.0.0.0/' /etc/prometheus/xmpp-alerts.yml RUN sed -i 's/yaml.load(f)/yaml.load(f, Loader=yaml.FullLoader)/' /prometheus-xmpp-alerts EXPOSE 9199 CMD ["/usr/local/bin/python", "/prometheus-xmpp-alerts", "--config", "/etc/prometheus/xmpp-alerts.yml"] prometheus-xmpp-alerts-0.4.2/LICENSE000066400000000000000000000261361351462136700172070ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. prometheus-xmpp-alerts-0.4.2/README.md000066400000000000000000000025441351462136700174560ustar00rootroot00000000000000prometheus-xmpp-alerts ====================== A simple web hook that forwards prometheus alerts over XMPP. Usage ----- # To use, configure a web hook in alertmanager. E.g.: ```yaml receivers: - name: 'jelmer-pager' webhook_configs: - url: 'http://192.168.2.1:9199/alert' ``` Edit the configuration file (defaults to ``/etc/prometheus/xmpp-alerts.yml``): ```yaml jid: 'alertmanager@example.com' password: 'PASSWORD' to_jid: 'jelmer@example.com' listen_address: '192.168.2.1' listen_port: 9199 format: 'short' ``` And run the web hook:: ```shell $ python3 prometheus-xmpp-alerts ``` If you have [amtool](https://github.com/prometheus/alertmanager#amtool) set up, then you can also allow ``to_jid`` to see existing alerts and manage silences. Message Format -------------- If you don't set the message format option, the `short` format will be used. * **short** > FIRING, 2019-05-17T18:48:18, Alert Summary * **full** > **[FIRING] Alert Summary** (groupLabelValue1 groupLabelValue2) > This is the description of the test alert. > **label1**: value1 > **label2**: value2 > **label3**: value3 Testing ------- The web hook can be accessed on three paths: * ``/alert``: used by Prometheus to deliver alerts, expects POST requests with JSON body * ``/test``: delivers a test message * ``/metrics``: exposes statistics about number of alerts received prometheus-xmpp-alerts-0.4.2/prometheus-xmpp-alerts000077500000000000000000000121261351462136700225670ustar00rootroot00000000000000#!/usr/bin/python3 # Simple HTTP web server that forwards prometheus alerts over XMPP. # # To use, configure a web hook in alertmanager. E.g.: # # receivers: # - name: 'jelmer-pager' # webhook_configs: # - url: 'http://192.168.2.1:9199/alert' # # Edit xmpp-alerts.yml.example, then run: # $ python3 prometheus-xmpp-alerts --config=xmpp-alerts.yml.example import argparse import json import logging import shlex import socket import sys import slixmpp import yaml from aiohttp import web from prometheus_client import ( Counter, generate_latest, CONTENT_TYPE_LATEST, ) from prometheus_xmpp import ( create_message_short, create_message_full, run_amtool, ) DEFAULT_CONF_PATH = '/etc/prometheus/xmpp-alerts.yml' alert_counter = Counter('alert_count', 'Total number of alerts delivered') test_counter = Counter('test_count', 'Total number of test alerts delivered') xmpp_message_counter = Counter( 'xmpp_message_count', 'Total number of XMPP messages received.') class XmppApp(slixmpp.ClientXMPP): def __init__(self, jid, password, amtool_allowed=None): slixmpp.ClientXMPP.__init__(self, jid, password) self._amtool_allowed = amtool_allowed or [] self.auto_authorize = True self.add_event_handler("session_start", self.start) self.add_event_handler("message", self.message) self.add_event_handler("disconnected", self.lost) self.register_plugin('xep_0030') # Service Discovery self.register_plugin('xep_0004') # Data Forms self.register_plugin('xep_0060') # PubSub self.register_plugin('xep_0199') # XMPP Ping def start(self, event): """Process the session_start event. Args: event: Event data (empty) """ self.send_presence(ptype='available', pstatus='Active') self.get_roster() def lost(self, event): logging.info("Connection lost, exiting.") sys.exit(1) def message(self, msg): """Handle an incoming message. Args: msg: The received message stanza. """ if msg['type'] in ('chat', 'normal'): args = shlex.split(msg['body']) if args == []: response = "No command specified" elif args[0] in ('alert', 'silence'): if msg['from'].bare in self._amtool_allowed: response = run_amtool(args) else: response = "Unauthorized JID." elif args[0] == 'help': response = "Supported commands: help, alert, silence." else: response = "Unknown command: %s" % args[0] msg.reply(response).send() parser = argparse.ArgumentParser() parser.add_argument('--config', dest='config_path', type=str, default=DEFAULT_CONF_PATH, help='Path to configuration file.') parser.add_argument("-q", "--quiet", help="set logging to ERROR", action="store_const", dest="loglevel", const=logging.ERROR, default=logging.INFO) parser.add_argument("-d", "--debug", help="set logging to DEBUG", action="store_const", dest="loglevel", const=logging.DEBUG, default=logging.INFO) args = parser.parse_args() # Setup logging. logging.basicConfig(level=args.loglevel, format='%(levelname)-8s %(message)s') with open(args.config_path) as f: if getattr(yaml, 'FullLoader', None): config = yaml.load(f, Loader=yaml.FullLoader) else: # Backwards compatibility with older versions of Python config = yaml.load(f) hostname = socket.gethostname() jid = "{}/{}".format(config['jid'], hostname) app = XmppApp(jid, config.get('password'), config.get('amtool_allowed', [config['to_jid']])) app.connect() async def serve_test(request): test_counter.inc() id_ = app.send_message( mto=config['to_jid'], mbody='Test message', mtype='chat') return web.Response(body='Sent message.') async def serve_alert(request): alert_counter.inc() try: alert = await request.json() except json.decoder.JSONDecodeError as e: raise web.HTTPUnprocessableEntity(str(e)) if 'format' in config and config['format'] == 'full': text = '\n--\n'.join(create_message_full(alert)) else: text = '\n'.join(create_message_short(alert)) id_ = app.send_message( mto=config['to_jid'], mbody=text, mtype='chat') return web.Response(body='Sent message') async def serve_metrics(request): resp = web.Response(body=generate_latest()) resp.content_type = CONTENT_TYPE_LATEST return resp async def serve_root(request): return web.Response(body='See /test, /alert or /metrics') web_app = web.Application() web_app.add_routes([ web.get('/', serve_root), web.get('/test', serve_test), web.post('/test', serve_test), web.get('/alert', serve_alert), web.post('/alert', serve_alert), web.get('/metrics', serve_metrics), ]) web.run_app(web_app, host=config['listen_address'], port=config['listen_port']) prometheus-xmpp-alerts-0.4.2/prometheus-xmpp-alerts.service000066400000000000000000000005441351462136700242240ustar00rootroot00000000000000[Unit] Description=Prometheus XMPP Alerts Documentation=https://jelmer.uk/code/prometheus-xmpp-alerts Wants=network-online.target After=network-online.target [Service] Restart=always User=prometheus Group=prometheus StandardError=syslog Restart=on-failure KillSignal=SIGQUIT ExecStart=/usr/bin/prometheus-xmpp-alerts [Install] WantedBy=multi-user.target prometheus-xmpp-alerts-0.4.2/prometheus_xmpp/000077500000000000000000000000001351462136700214315ustar00rootroot00000000000000prometheus-xmpp-alerts-0.4.2/prometheus_xmpp/__init__.py000066400000000000000000000041451351462136700235460ustar00rootroot00000000000000#!/usr/bin/python3 # Simple HTTP web server that forwards prometheus alerts over XMPP. # # To use, configure a web hook in alertmanager. E.g.: # # receivers: # - name: 'jelmer-pager' # webhook_configs: # - url: 'http://192.168.2.1:9199/alert' # # Edit xmpp-alerts.yml.example, then run: # $ python3 prometheus-xmpp-alerts --config=xmpp-alerts.yml.example import re from datetime import datetime import subprocess __version__ = (0, 3, 2) version_string = '.'.join(map(str, __version__)) def parse_timestring(ts): # strptime doesn't understand nanoseconds, so discard the last three digits ts = re.sub('\\.([0-9]{6})([0-9]{0,3})Z$', r'.\1Z', ts) return datetime.strptime(ts, '%Y-%m-%dT%H:%M:%S.%fZ') def create_message_short(message): """Create the short form message to deliver.""" for alert in message['alerts']: yield '%s, %s, %s' % ( alert['status'].upper(), parse_timestring(alert['startsAt']).isoformat(timespec='seconds'), alert['annotations']['summary']) def create_message_full(message): """Create the long form message to deliver.""" group_labels = '' if 'groupLabels' in message: group_labels = ' ({})'.format(' '.join( value for key, value in message['groupLabels'].items())) for alert in message['alerts']: description = '' if 'description' in alert['annotations']: description = '\n{}'.format(alert['annotations']['description']) labels = '' if 'labels' in alert: for label, value in alert['labels'].items(): labels += '\n*{}:* {}'.format(label, value) yield '*[{}] {}*{}{}{}'.format( alert['status'].upper(), alert['annotations']['summary'], group_labels, description, labels) def run_amtool(args): """Run amtool with the specified arguments.""" # TODO(jelmer): Support setting the current user, e.g. for silence # ownership. ret = subprocess.run( ["/usr/bin/amtool"] + args, shell=False, text=True, stdout=subprocess.PIPE) return ret.stdout prometheus-xmpp-alerts-0.4.2/prometheus_xmpp/tests/000077500000000000000000000000001351462136700225735ustar00rootroot00000000000000prometheus-xmpp-alerts-0.4.2/prometheus_xmpp/tests/__init__.py000066400000000000000000000046551351462136700247160ustar00rootroot00000000000000# __init__.py -- The tests for prometheus_xmpp # Copyright (C) 2018 Jelmer Vernooij # from datetime import datetime import unittest from prometheus_xmpp import \ create_message_short, create_message_full, parse_timestring class CreateMessageTests(unittest.TestCase): message = { "version": "4", "groupKey": "test", "status": "firing", "receiver": "xmpp", "groupLabels": { "groupLabel1": "groupLabelValue1", "groupLabel2": "groupLabelValue2" }, "commonLabels": { "commonLabel1": "commonLabelValue1", "commonLabel2": "commonLabelValue2" }, "commonAnnotations": { "commonAnnotation1": "commonAnnotationValue1", "commonAnnotation2": "commonAnnotationValue2" }, "externalURL": "https://alertmanager.example.com", "alerts": [ { "status": "firing", "labels": { "test": "true", "severity": "test" }, "annotations": { "summary": "Test Alert", "description": "This is just a test alert." }, "startsAt": "2019-04-12T23:20:50.123456789Z", "endsAt": "2019-04-12T23:20:50.123456789Z", "generatorURL": "curl" } ] } def test_create_message_short(self): self.assertEqual( ['FIRING, 2019-04-12T23:20:50, Test Alert'], list(create_message_short(self.message))) def test_create_message_full(self): self.assertEqual( ['*[FIRING] Test Alert* (groupLabelValue1 groupLabelValue2)' + '\nThis is just a test alert.' + '\n*test:* true' + '\n*severity:* test'], list(create_message_full(self.message))) class ParseTimestringTests(unittest.TestCase): def test_parse_with_nanoseconds(self): self.assertEqual( datetime.strptime( '2019-04-27T05:33:35.739602Z', '%Y-%m-%dT%H:%M:%S.%fZ'), parse_timestring('2019-04-27T05:33:35.739602132Z')) def test_parse_with_microseconds(self): self.assertEqual( datetime.strptime( '2019-04-27T05:33:35.739602Z', '%Y-%m-%dT%H:%M:%S.%fZ'), parse_timestring('2019-04-27T05:33:35.739602Z')) def test_suite(): module_names = ['prometheus_xmpp.tests'] loader = unittest.TestLoader() return loader.loadTestsFromNames(module_names) prometheus-xmpp-alerts-0.4.2/setup.py000077500000000000000000000024371351462136700177150ustar00rootroot00000000000000#!/usr/bin/python3 # encoding: utf-8 # Setup file for prometheus-xmpp-alerts # Copyright (C) 2016-2018 Jelmer Vernooij from setuptools import setup setup(name='prometheus-xmpp-alerts', author="Jelmer Vernooij", author_email="jelmer@jelmer.uk", url="https://jelmer.uk/code/prometheus-xmpp-alerts", description="Prometheus XMPP Alerts hook", version='0.4.2', license='Apachev2', project_urls={ "Bug Tracker": "https://github.com/jelmer/prometheus-xmpp-alerts/issues", "Repository": "https://www.jelmer.uk/code/prometheus-xmpp-alerts", "GitHub": "https://github.com/jelmer/prometheus-xmpp-alerts", }, keywords="prometheus xmpp jabber", packages=['prometheus_xmpp'], scripts=['prometheus-xmpp-alerts'], classifiers=[ 'Development Status :: 3 - Alpha', 'License :: OSI Approved :: Apache Software License', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Operating System :: POSIX', 'Operating System :: Microsoft :: Windows', 'Topic :: Software Development :: Version Control', ], install_requires=['slixmpp', 'aiohttp', 'pyyaml', 'prometheus_client'], ) prometheus-xmpp-alerts-0.4.2/xmpp-alerts.yml.example000066400000000000000000000005251351462136700226250ustar00rootroot00000000000000# Login details for the bot itself jid: 'alertmanager@example.com' password: 'PASSWORD' listen_address: '127.0.0.1' listen_port: 9199 # JID to send alerts to to_jid: 'jelmer@example.com' # List of JIDs that are allowed to query alerts and set silences. Defaults to # to_jid. amtool_allowed: [] # Message format (short, full) format: 'short'