Skip to main content

mqttwarn - subscribe to MQTT topics and notify pluggable services

Project description

https://img.shields.io/badge/Python-2.7-green.svg https://img.shields.io/pypi/v/mqttwarn.svg https://img.shields.io/github/tag/jpmens/mqttwarn.svg

https://cloud.githubusercontent.com/assets/2345521/6320105/4dd7a826-bade-11e4-9a61-72aa163a40a9.png

mqttwarn

To warn, alert, or notify.

https://raw.githubusercontent.com/jpmens/mqttwarn/develop/assets/google-definition.jpg

About

mqttwarn - subscribe to MQTT topics and notify pluggable services.

Description

mqttwarn subscribes to any number of MQTT topics and publishes received payloads to one or more notification services after optionally applying sophisticated transformations.

It comes with over 70 notification handler plugins for a wide range of notification services and is very open to further contributions. You can enjoy the alphabetical list of plugins within the handbook.

A picture says a thousand words.

https://raw.githubusercontent.com/jpmens/mqttwarn/develop/assets/mqttwarn.png

Introduction

This program subscribes to any number of MQTT topics (which may include wildcards) and publishes received payloads to one or more notification services, including support for notifying more than one distinct service for the same message.

Notifications are transmitted to the appropriate service via plugins. mqttwarn provides built-in plugins for a number of services and you can easily add your own.

A more detailed blog post about what mqttwarn can be used for is available at https://jpmens.net/2014/04/03/how-do-your-servers-talk-to-you/.

For example, you may wish to submit an alarm published as text to the MQTT topic home/monitoring/+ as notification via e-mail and Pushover.

Documentation

The handbook is the right place to read all about mqttwarn’s features and service plugins.

Installation

Synopsis:

pip install --upgrade mqttwarn

You can also add support for a specific service plugin:

pip install --upgrade 'mqttwarn[xmpp]'

You can also add support for multiple services, all at once:

pip install --upgrade 'mqttwarn[asterisk,nsca,osxnotify,tootpaste,xmpp]'

Configuration

First, create configuration and custom Python starter files mqttwarn.ini and samplefuncs.py and edit them to your taste:

# Create configuration file
mqttwarn make-config > mqttwarn.ini

# Create file for custom functions
mqttwarn make-samplefuncs > samplefuncs.py

Usage

Running interactively

Just launch mqttwarn:

# Run mqttwarn
mqttwarn

To supply a different configuration file or log file, optionally use:

# Define configuration file
export MQTTWARNINI=/etc/mqttwarn/acme.ini

# Define log file
export MQTTWARNLOG=/var/log/mqttwarn.log

# Run mqttwarn
mqttwarn

Running notification plugins

For debugging or other purposes, you might want to directly run a notification plugin without the dispatching and transformation machinery of mqttwarn. We have you covered, just try this to launch the plugin standalone by passing essential information using JSON:

# Launch "log" service plugin
mqttwarn --plugin=log --data='{"message": "Hello world", "addrs": ["crit"]}'

# Launch "file" service plugin
mqttwarn --plugin=file --data='{"message": "Hello world\n", "addrs": ["/tmp/mqttwarn.err"]}'

Please note this feature is a work in progress, so expect there to be dragons.

Running as system daemon

Running in a development sandbox

For hacking on mqttwarn, please install it in development mode.

Acknowledgements

Thanks to all the contributors of mqttwarn who got their hands dirty with it and helped to co-create and conceive it in one way or another. You know who you are.

Project information

About

These links will guide you to the source code of mqttwarn and its documentation.

Requirements

You’ll need at least the following components:

  • Python 2.x. We tested it with 2.6 and 2.7.
  • Some more Python modules defined in the setup.py file. These will probably get installed automatically.
  • An MQTT broker. We recommend Mosquitto.

Contributing

We are always happy to receive code contributions, ideas, suggestions and problem reports from the community.

So, if you’d like to contribute you’re most welcome. Spend some time taking a look around, locate a bug, design issue or spelling mistake and then send us a pull request or create an issue.

Thanks in advance for your efforts, we really appreciate any help or feedback.

Licenses

This software is copyright © 2014-2019 Jan-Piet Mens and contributors. All rights reserved.

It is and will always be free and open source software.

Use of the source code included here is governed by the Eclipse Public License 2.0, see LICENSE file for details. Please also recognize the licenses of third-party components.

Troubleshooting

If you encounter any problems during setup or operations or if you have further suggestions, please let us know by opening an issue on GitHub. Thanks already.

Miscellaneous

Press

Notes

mqttwarn is currently undergoing some refurbishment and will also be ported to Python 3 during that phase. You are welcome to participate!

We outlined the tasks for the next releases within the backlog. They might be transferred into GitHub issues progressively, if applicable.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mqttwarn, version 0.12.0
Filename, size File type Python version Upload date Hashes
Filename, size mqttwarn-0.12.0.tar.gz (104.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page