Documentation

This commit is contained in:
Mike Place 2014-11-26 16:56:45 -07:00
parent d00314d18b
commit 8297c2c48e

View file

@ -110,6 +110,26 @@ loaded as simply ``redis``:
return False
return __virtualname__
Event Returners
===============
For maximimum visibility into the history of events across a Salt
infrastructure, all events seen by a salt master may be logged to a returner.
To enable event logging, set the ``event_return`` configuration option in the
master config to returner which should be designated as the handler for event
returns.
.. note::
Not all returners support event returns. Verify a returner has an
``event_return()`` function before using.
.. note::
On larger installations, many hundreds of events may be generated on a
busy master every second. Be certain to closely monitor the storage of
a given returner as Salt can easily overwhealm an underpowered server
with thousands of returns.
Full List of Returners
======================