You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by pt...@apache.org on 2016/04/21 20:46:38 UTC
[2/3] storm git commit: Updating the doc to reflect the new default
behavior
Updating the doc to reflect the new default behavior
Project: http://git-wip-us.apache.org/repos/asf/storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/8ee43e73
Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/8ee43e73
Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/8ee43e73
Branch: refs/heads/1.x-branch
Commit: 8ee43e7373e54583d7e9c980763df572e06d9aa7
Parents: c6d0bc4
Author: Arun Mahadevan <ai...@hortonworks.com>
Authored: Fri Apr 1 09:56:10 2016 +0530
Committer: P. Taylor Goetz <pt...@gmail.com>
Committed: Thu Apr 21 14:45:51 2016 -0400
----------------------------------------------------------------------
docs/Eventlogging.md | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/storm/blob/8ee43e73/docs/Eventlogging.md
----------------------------------------------------------------------
diff --git a/docs/Eventlogging.md b/docs/Eventlogging.md
index d864366..0895232 100644
--- a/docs/Eventlogging.md
+++ b/docs/Eventlogging.md
@@ -11,7 +11,10 @@ This could be useful for inspecting the tuples emitted at a spout or a bolt in t
## Enabling event logging
-Event logging can be enabled by clicking the "Debug" button under the topology actions in the topology view. This logs the
+Note: Event logging needs to be enabled first by setting the storm config "topology.eventlogger.executors" to a non zero value. Please see
+the [Configuration](#config) section for more details.
+
+Events can be logged by clicking the "Debug" button under the topology actions in the topology view. This logs the
tuples from all the spouts and bolts in a topology at the specified sampling percentage.
<div align="center">
@@ -54,14 +57,14 @@ Event logging can be disabled at a specific component or at the topology level b
<p>Figure 4: Disable event logging at topology level.</p>
</div>
-## Configuration
-Eventlogging works by sending the events (tuples) from each component to an internal eventlogger bolt. By default storm automatically starts one event logger task per worker. This can be easily changed by setting the below parameter while running your topology (by setting it in storm.yaml or passing options via command line).
+## <a name="config"></a>Configuration
+Eventlogging works by sending the events (tuples) from each component to an internal eventlogger bolt. By default Storm does not start any event logger tasks, but this can be easily changed by setting the below parameter while running your topology (by setting it in storm.yaml or passing options via command line).
| Parameter | Meaning |
| -------------------------------------------|-----------------------|
-| "topology.eventlogger.executors": nil | One event logger task per worker (default). |
+| "topology.eventlogger.executors": 0 | No event logger tasks are created (default). |
| "topology.eventlogger.executors": 1 | One event logger task for the topology. |
-| "topology.eventlogger.executors": 0 | No event logger tasks are created. |
+| "topology.eventlogger.executors": nil | One event logger task per worker. |
## Extending eventlogging