From c0f1d8ccd01623ee77321aab69883f881ce9b169 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Thu, 1 Jun 2017 03:53:41 -0400 Subject: [PATCH] Add firehose documentation for notifications This commit adds docs on event notifications as an example use case. This is a common thing that people want to do with firehose events, so it's good to document how to do it. This commit doesn't go into detail on how to use/configure mqttwarn (since it can be quite involved) but points people at the docs. Change-Id: Ic5fff993e5f268e2dbd82062b4fb95483d69abf2 --- doc/source/firehose.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/source/firehose.rst b/doc/source/firehose.rst index 888085babd..c31a73831a 100644 --- a/doc/source/firehose.rst +++ b/doc/source/firehose.rst @@ -298,6 +298,23 @@ Or with ruby: puts message end +Example Use Cases +================= + +Event Notifications +------------------- + +A common use case for the event bus is to get a notification when an event +occurs. There is an open source tool, `mqttwarn`_ that makes setting this up +off the firehose (or any other mqtt broker) very straightforward. + +.. _mqttwarn: https://github.com/jpmens/mqttwarn + +You can use mqttwarn to setup custom notifications to a large number of tools +and services. (both local and remote). You can read the full docs on how to +configure and use mqttwarn at https://github.com/jpmens/mqttwarn/wiki and +https://github.com/jpmens/mqttwarn/blob/master/README.md + IMAP and MX ===========