Repository: flume Updated Branches: refs/heads/trunk 698f0ba2d -> 35de8ff18
FLUME-2509. Add description for properties in Failover Sink Processor (Ashish Paliwal via Roshan Naik) Project: http://git-wip-us.apache.org/repos/asf/flume/repo Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/f20e0a94 Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/f20e0a94 Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/f20e0a94 Branch: refs/heads/trunk Commit: f20e0a9410481e874e5d4916ff3b32d7f893e780 Parents: 698f0ba Author: Roshan Naik <[email protected]> Authored: Wed Nov 19 18:25:00 2014 -0800 Committer: Roshan Naik <[email protected]> Committed: Wed Nov 19 18:26:33 2014 -0800 ---------------------------------------------------------------------- flume-ng-doc/sphinx/FlumeUserGuide.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flume/blob/f20e0a94/flume-ng-doc/sphinx/FlumeUserGuide.rst ---------------------------------------------------------------------- diff --git a/flume-ng-doc/sphinx/FlumeUserGuide.rst b/flume-ng-doc/sphinx/FlumeUserGuide.rst index 122f2e8..43a4d5c 100644 --- a/flume-ng-doc/sphinx/FlumeUserGuide.rst +++ b/flume-ng-doc/sphinx/FlumeUserGuide.rst @@ -2704,7 +2704,12 @@ that so long as one is available events will be processed (delivered). The failover mechanism works by relegating failed sinks to a pool where they are assigned a cool down period, increasing with sequential failures before they are retried. Once a sink successfully sends an event, it is -restored to the live pool. +restored to the live pool. The Sinks have a priority associated with them, +larger the number, higher the priority. If a Sink fails while sending a Event +the next Sink with highest priority shall be tried next for sending Events. +For example, a sink with priority 100 is activated before the Sink with priority +80. If no priority is specified, thr priority is determined based on the order in which +the Sinks are specified in configuration. To configure, set a sink groups processor to ``failover`` and set priorities for all individual sinks. All specified priorities must @@ -2718,8 +2723,9 @@ Property Name Default Description ================================= =========== =================================================================================== **sinks** -- Space-separated list of sinks that are participating in the group **processor.type** ``default`` The component type name, needs to be ``failover`` -**processor.priority.<sinkName>** -- <sinkName> must be one of the sink instances associated with the current sink group -processor.maxpenalty 30000 (in millis) +**processor.priority.<sinkName>** -- Priority value. <sinkName> must be one of the sink instances associated with the current sink group + A higher priority value Sink gets activated earlier. A larger absolute value indicates higher priority +processor.maxpenalty 30000 The maximum backoff period for the failed Sink (in millis) ================================= =========== =================================================================================== Example for agent named a1:
