mqttwarn 0.31.0

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_services.

A picture says a thousand words.

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.

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 an individual notification plugin without the dispatching and transformation machinery of mqttwarn.

We have you covered. To launch a plugin standalone, those commands will give you an idea how to pass relevant information on the command line using JSON:

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

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

# Launch "pushover" service plugin
mqttwarn --plugin=pushover --options='{"title": "About", "message": "Hello world", "addrs": ["userkey", "token"], "priority": 6}'

# Launch "ssh" service plugin from the command line
mqttwarn --plugin=ssh --config='{"host": "ssh.example.org", "port": 22, "user": "foo", "password": "bar"}' --options='{"addrs": ["command with substitution %s"], "payload": "{\"args\": \"192.168.0.1\"}"}'

# Launch "cloudflare_zone" service plugin from "mqttwarn-contrib", passing "--config" parameters via command line
pip install mqttwarn-contrib
mqttwarn --plugin=mqttwarn_contrib.services.cloudflare_zone --config='{"auth-email": "foo", "auth-key": "bar"}' --options='{"addrs": ["0815", "www.example.org", ""], "message": "192.168.0.1"}'

# Submit notification to "ntfy", using Apprise service plugin.
mqttwarn --plugin=apprise \
    --config='{"baseuri": "ntfy://user:password@ntfy.example.org/topic1/topic2"}' \
    --options='{"addrs": [], "title": "Example notification", "message": "Hello world"}'

Also, the --config-file parameter can be used to optionally specify the path to a configuration file.

Running as system daemon

• We recommend to use Supervisor for running mqttwarn as a service, see also supervisor.ini.

• Alternatively, have a look at mqttwarn.service, the systemd unit configuration file for mqttwarn.

Running in a development sandbox

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

About

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

• mqttwarn on GitHub

• mqttwarn on the Python Package Index (PyPI)

• mqttwarn documentation

Requirements

You’ll need at least the following components:

• Python. The program should work on Python 3 and PyPy3.

• An MQTT broker. We recommend Mosquitto.

• Some more Python modules to satisfy service dependencies defined in the setup.py file.

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.

There are also some extensions to mqttwarn not included in the core package. Yet, they are bundled into another package, mqttwarn-contrib, see also community contributions to mqttwarn.

Licenses

This software is copyright © 2014-2021 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.

Press

• The article MQTTwarn: Ein Rundum-Sorglos-Notifier in German at JAXenter.

• The folks of the Berlin-based beekeeper collective Hiveeyes are monitoring their beehives and use mqttwarn as a building block for their alert notification system, enjoy reading Schwarmalarm using mqttwarn.

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.

Legal stuff

“MQTT” is a trademark of the OASIS open standards consortium, which publishes the MQTT specifications.

Have fun!