storm-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [06/13] storm git commit: Add docs for log search
Date Mon, 09 Nov 2015 22:55:26 GMT
Add docs for log search


Branch: refs/heads/master
Commit: 2ed4478e1a8f35e5d0830e8ed2a020ae51023d81
Parents: a3726a9
Author: zhuol <>
Authored: Thu Nov 5 15:05:18 2015 -0600
Committer: zhuol <>
Committed: Mon Nov 9 11:51:09 2015 -0600

 docs/documentation/               |   1 +
 docs/documentation/                  |  14 ++++++++++++++
 docs/documentation/images/search-a-topology.png   | Bin 0 -> 671031 bytes
 .../images/search-for-a-single-worker-log.png     | Bin 0 -> 736579 bytes
 4 files changed, 15 insertions(+)
diff --git a/docs/documentation/ b/docs/documentation/
index bcf6ec9..7044664 100644
--- a/docs/documentation/
+++ b/docs/documentation/
@@ -45,6 +45,7 @@ Trident is an alternative interface to Storm. It provides exactly-once processin
 * [Metrics](Metrics.html)
 * [Lifecycle of a trident tuple]()
 * [UI REST API](ui-rest-api.html)
+* [Log Search](Log-Search.html)
 * [Dynamic Log Level Settings](dynamic-log-level-settings.html)
 * [Dynamic Worker Profiling](dynamic-worker-profiling.html)
diff --git a/docs/documentation/ b/docs/documentation/
new file mode 100644
index 0000000..03297b7
--- /dev/null
+++ b/docs/documentation/
@@ -0,0 +1,14 @@
+Log Search
+This feature is aimed for improving the debugging of Storm. Log Search supports searching
in a certain log file or in a topology's all log files:
+Using the Storm UI
+String search in a log file: In the log page for a worker, 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.
+![Search in a log](images/search-for-a-single-worker-log.png "Seach in a log")
+Search in a topology: 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 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")
diff --git a/docs/documentation/images/search-a-topology.png b/docs/documentation/images/search-a-topology.png
new file mode 100644
index 0000000..8d6153c
Binary files /dev/null and b/docs/documentation/images/search-a-topology.png differ
diff --git a/docs/documentation/images/search-for-a-single-worker-log.png b/docs/documentation/images/search-for-a-single-worker-log.png
new file mode 100644
index 0000000..8c6f423
Binary files /dev/null and b/docs/documentation/images/search-for-a-single-worker-log.png

View raw message