From fd6a7e39c4f02ef8e7e1534a5f61945c0ba2de3a Mon Sep 17 00:00:00 2001 From: zhuol Date: Thu, 17 Dec 2015 15:16:59 -0600 Subject: [PATCH 1/2] Some rework [STORM-1393] on Derek's comments --- docs/documentation/Logs.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/documentation/Logs.md b/docs/documentation/Logs.md index a0961eab566..ce535ed421b 100644 --- a/docs/documentation/Logs.md +++ b/docs/documentation/Logs.md @@ -4,10 +4,10 @@ layout: documentation documentation: true --- Logs in Storm are essential for tracking the status, operations, error messages and debug information for all the -daemons (nimbus, supervisor, logviewer, drpc, ui) and topologies' workers. +daemons (e.g., nimbus, supervisor, logviewer, drpc, ui, pacemaker) and topologies' workers. ### Location of the Logs -All the daemon logs are placed under ${storm.log.dir} directory, which a user can set in the System properties or +All the daemon logs are placed under ${storm.log.dir} directory, which an administrator can set in the System properties or in the cluster configuration. By default, ${storm.log.dir} points to ${storm.home}/logs. All the worker logs are placed under the workers-artifacts directory in a hierarchical manner, e.g., @@ -19,12 +19,12 @@ locates at ${storm.log.dir}/logs/workers-artifacts. Daemon and worker logs are allowed to view and download through Storm UI by authorized users. To improve the debugging of Storm, we provide the Log Search feature. -Log Search supports searching in a certain log file or in a topology's all log files: +Log Search supports searching in a certain log file or in all of a topology's log files: -String search in a log file: In the log page for a worker, a user can search a certain string, e.g., "Exception", in for a certain worker log. This search can happen for both normal text log or rolled ziplog files. In the results, the offset and matched lines will be displayed. +String search in a log file: In the log page for a worker, a user can search a certain string, e.g., "Exception", in for a certain worker log. This search can happen for both normal text log or rolled zip log files. In the results, the offset and matched lines will be displayed. ![Search in a log](images/search-for-a-single-worker-log.png "Search in a log") Search in a topology: a user can also search a string for a certain topology by clicking the icon of magnifying lens at the top right corner of the UI page. This means the UI will try to search on all the supervisor nodes in a distributed way to find the matched string in all logs for this topology. The search can happen for both normal text log or rolled zip log files by checking/unchecking the "Search archived logs:" box. Then the matched results can be shown on the UI with url links, directing the user to the certain logs on each supervisor node. This powerful feature is very helpful for users to find certain problematic supervisor nodes running this topology. -![Seach in a topology](images/search-a-topology.png "Search in a topology") +![Search in a topology](images/search-a-topology.png "Search in a topology") From a4c377945c864417b548c92f86551cc6e0dd53a9 Mon Sep 17 00:00:00 2001 From: zhuol Date: Fri, 18 Dec 2015 11:34:07 -0600 Subject: [PATCH 2/2] Minor edits --- docs/documentation/Logs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/documentation/Logs.md b/docs/documentation/Logs.md index ce535ed421b..28e66934a90 100644 --- a/docs/documentation/Logs.md +++ b/docs/documentation/Logs.md @@ -21,10 +21,10 @@ Daemon and worker logs are allowed to view and download through Storm UI by auth To improve the debugging of Storm, we provide the Log Search feature. Log Search supports searching in a certain log file or in all of a topology's log files: -String search in a log file: In the log page for a worker, a user can search a certain string, e.g., "Exception", in for a certain worker log. This search can happen for both normal text log or rolled zip log files. In the results, the offset and matched lines will be displayed. +String search in a log file: In the log page for a worker, a user can search a certain string, e.g., "Exception", in a certain worker log. This search can happen for both normal text log or rolled zip log files. In the results, the offset and matched lines will be displayed. ![Search in a log](images/search-for-a-single-worker-log.png "Search in a log") -Search in a topology: a user can also search a string for a certain topology by clicking the icon of magnifying lens at the top right corner of the UI page. This means the UI will try to search on all the supervisor nodes in a distributed way to find the matched string in all logs for this topology. The search can happen for both normal text log or rolled zip log files by checking/unchecking the "Search archived logs:" box. Then the matched results can be shown on the UI with url links, directing the user to the certain logs on each supervisor node. This powerful feature is very helpful for users to find certain problematic supervisor nodes running this topology. +Search in a topology: a user can also search a string for a certain topology by clicking the icon of magnifying lens at the top right corner of the UI page. This means the UI will try to search on all the supervisor nodes in a distributed way to find the matched string in all logs for this topology. The search can happen for either normal text log files or rolled zip log files by checking/unchecking the "Search archived logs:" box. Then the matched results can be shown on the UI with url links, directing the user to the certain logs on each supervisor node. This powerful feature is very helpful for users to find certain problematic supervisor nodes running this topology. ![Search in a topology](images/search-a-topology.png "Search in a topology")