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
This commit is contained in:
Matthew Treinish 2017-06-01 03:53:41 -04:00
parent 63ba008b0c
commit c0f1d8ccd0
No known key found for this signature in database
GPG Key ID: FD12A0F214C9E177

View File

@ -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
===========