You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by bo...@apache.org on 2015/11/04 18:18:49 UTC
[06/10] storm git commit: Moving Documentation to more appropriate
location
Moving Documentation to more appropriate location
Project: http://git-wip-us.apache.org/repos/asf/storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/25f31a0e
Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/25f31a0e
Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/25f31a0e
Branch: refs/heads/master
Commit: 25f31a0eee02ceee75f72a8f82f9f33e98cdd192
Parents: f697044
Author: Kishor Patil <kp...@yahoo-inc.com>
Authored: Tue Nov 3 15:16:58 2015 -0600
Committer: Kishor Patil <kp...@yahoo-inc.com>
Committed: Tue Nov 3 15:16:58 2015 -0600
----------------------------------------------------------------------
docs/DYNAMIC_LOG_LEVEL_SETTINGS.md | 41 -------------------
docs/DYNAMIC_WORKER_PROFILING.md | 29 -------------
docs/documentation/Documentation.md | 2 +
.../documentation/dynamic-log-level-settings.md | 41 +++++++++++++++++++
docs/documentation/dynamic-worker-profiling.md | 29 +++++++++++++
.../images/dynamic_log_level_settings_1.png | Bin 0 -> 93689 bytes
.../images/dynamic_log_level_settings_2.png | Bin 0 -> 78785 bytes
.../images/dynamic_profiling_debugging_1.png | Bin 0 -> 93635 bytes
.../images/dynamic_profiling_debugging_2.png | Bin 0 -> 138120 bytes
.../images/dynamic_profiling_debugging_3.png | Bin 0 -> 96974 bytes
docs/images/dynamic_log_level_settings_1.png | Bin 93689 -> 0 bytes
docs/images/dynamic_log_level_settings_2.png | Bin 78785 -> 0 bytes
docs/images/dynamic_profiling_debugging_1.png | Bin 93635 -> 0 bytes
docs/images/dynamic_profiling_debugging_2.png | Bin 138120 -> 0 bytes
docs/images/dynamic_profiling_debugging_3.png | Bin 96974 -> 0 bytes
15 files changed, 72 insertions(+), 70 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/DYNAMIC_LOG_LEVEL_SETTINGS.md
----------------------------------------------------------------------
diff --git a/docs/DYNAMIC_LOG_LEVEL_SETTINGS.md b/docs/DYNAMIC_LOG_LEVEL_SETTINGS.md
deleted file mode 100644
index f38b708..0000000
--- a/docs/DYNAMIC_LOG_LEVEL_SETTINGS.md
+++ /dev/null
@@ -1,41 +0,0 @@
-Dynamic Log Level Settings
-==========================
-
-We have added the ability to set log level settings for a running topology using the Storm UI and the Storm CLI.
-
-The log level settings apply the same way as you'd expect from log4j, as all we are doing is telling log4j to set the level of the logger you provide. If you set the log level of a parent logger, the children loggers start using that level (unless the children have a more restrictive level already). A timeout can optionally be provided (except for DEBUG mode, where it’s required in the UI), if workers should reset log levels automatically.
-
-This revert action is triggered using a polling mechanism (every 30 seconds, but this is configurable), so you should expect your timeouts to be the value you provided plus anywhere between 0 and the setting's value.
-
-Using the Storm UI
--------------
-
-In order to set a level, click on a running topology, and then click on “Change Log Level” in the Topology Actions section.
-
-
-
-Next, provide the logger name, select the level you expect (e.g. WARN), and a timeout in seconds (or 0 if not needed). Then click on “Add”.
-
-
-
-To clear the log level click on the “Clear” button. This reverts the log level back to what it was before you added the setting. The log level line will disappear from the UI.
-
-While there is a delay resetting log levels back, setting the log level in the first place is immediate (or as quickly as the message can travel from the UI/CLI to the workers by way of nimbus and zookeeper).
-
-Using the CLI
--------------
-
-Using the CLI, issue the command:
-
-`./bin/storm set_log_level [topology name] -l [logger name]=[LEVEL]:[TIMEOUT]`
-
-For example:
-
-`./bin/storm set_log_level my_topology -l ROOT=DEBUG:30`
-
-Sets the ROOT logger to DEBUG for 30 seconds.
-
-`./bin/storm set_log_level my_topology -r ROOT`
-
-Clears the ROOT logger dynamic log level, resetting it to its original value.
-
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/DYNAMIC_WORKER_PROFILING.md
----------------------------------------------------------------------
diff --git a/docs/DYNAMIC_WORKER_PROFILING.md b/docs/DYNAMIC_WORKER_PROFILING.md
deleted file mode 100644
index 9bc8da3..0000000
--- a/docs/DYNAMIC_WORKER_PROFILING.md
+++ /dev/null
@@ -1,29 +0,0 @@
-Dynamic Worker Profiling
-==========================
-
-In multi-tenant mode, storm launches long-running JVMs across cluster without sudo access to user. Self-serving of Java heap-dumps, jstacks and java profiling of these JVMs would improve users' ability to analyze and debug issues when monitoring it actively.
-
-The storm dynamic profiler lets you dynamically take heap-dumps, jprofile or jstack for a worker jvm running on stock cluster. It let user download these dumps from the browser and use your favorite tools to analyze it The UI component page provides list workers for the component and action buttons. The logviewer lets you download the dumps generated by these logs. Please see the screenshots for more information.
-
-Using the Storm UI
--------------
-
-In order to request for heap-dump, jstack, start/stop/dump jprofile or restart a worker, click on a running topology, then click on specific component, then you can select worker from the dropdown for that particular component and then click on “Start","Heap", "Jstack" or "Restart Worker" in the "Profiing and Debugging" section.
-
-
-
-For start jprofile, provide a timeout in minutes (or 10 if not needed). Then click on “Start”.
-
-
-
-To stop the jprofile logging click on the “Stop” button. This dumps the jprofile stats and stops the profiling. Refresh the page for the line to disappear from the UI.
-
-Click on "My Dump Files" to go the logviewer UI for list of worker specific dump files.
-
-
-
-Configuration
--------------
-
-The "worker.profiler.command" can be configured to point to specific pluggable profiler, heapdump commands. The "worker.profiler.enabled" can be disabled if plugin is not available or jdk does not support Jprofile flight recording so that worker JVM options will not have "worker.profiler.childopts". To use different profiler plugin, you can change these configuration.
-
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/Documentation.md
----------------------------------------------------------------------
diff --git a/docs/documentation/Documentation.md b/docs/documentation/Documentation.md
index f32268c..48e18e8 100644
--- a/docs/documentation/Documentation.md
+++ b/docs/documentation/Documentation.md
@@ -44,6 +44,8 @@ Trident is an alternative interface to Storm. It provides exactly-once processin
* [Hooks](Hooks.html)
* [Metrics](Metrics.html)
* [Lifecycle of a trident tuple]()
+* [Dynamic Log Level Settings](dynamic-log-level-settings.html)
+* [Dynamic Worker Profiling](dynamic-worker-profiling.html)
### Advanced
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/dynamic-log-level-settings.md
----------------------------------------------------------------------
diff --git a/docs/documentation/dynamic-log-level-settings.md b/docs/documentation/dynamic-log-level-settings.md
new file mode 100644
index 0000000..f38b708
--- /dev/null
+++ b/docs/documentation/dynamic-log-level-settings.md
@@ -0,0 +1,41 @@
+Dynamic Log Level Settings
+==========================
+
+We have added the ability to set log level settings for a running topology using the Storm UI and the Storm CLI.
+
+The log level settings apply the same way as you'd expect from log4j, as all we are doing is telling log4j to set the level of the logger you provide. If you set the log level of a parent logger, the children loggers start using that level (unless the children have a more restrictive level already). A timeout can optionally be provided (except for DEBUG mode, where it’s required in the UI), if workers should reset log levels automatically.
+
+This revert action is triggered using a polling mechanism (every 30 seconds, but this is configurable), so you should expect your timeouts to be the value you provided plus anywhere between 0 and the setting's value.
+
+Using the Storm UI
+-------------
+
+In order to set a level, click on a running topology, and then click on “Change Log Level” in the Topology Actions section.
+
+
+
+Next, provide the logger name, select the level you expect (e.g. WARN), and a timeout in seconds (or 0 if not needed). Then click on “Add”.
+
+
+
+To clear the log level click on the “Clear” button. This reverts the log level back to what it was before you added the setting. The log level line will disappear from the UI.
+
+While there is a delay resetting log levels back, setting the log level in the first place is immediate (or as quickly as the message can travel from the UI/CLI to the workers by way of nimbus and zookeeper).
+
+Using the CLI
+-------------
+
+Using the CLI, issue the command:
+
+`./bin/storm set_log_level [topology name] -l [logger name]=[LEVEL]:[TIMEOUT]`
+
+For example:
+
+`./bin/storm set_log_level my_topology -l ROOT=DEBUG:30`
+
+Sets the ROOT logger to DEBUG for 30 seconds.
+
+`./bin/storm set_log_level my_topology -r ROOT`
+
+Clears the ROOT logger dynamic log level, resetting it to its original value.
+
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/dynamic-worker-profiling.md
----------------------------------------------------------------------
diff --git a/docs/documentation/dynamic-worker-profiling.md b/docs/documentation/dynamic-worker-profiling.md
new file mode 100644
index 0000000..9bc8da3
--- /dev/null
+++ b/docs/documentation/dynamic-worker-profiling.md
@@ -0,0 +1,29 @@
+Dynamic Worker Profiling
+==========================
+
+In multi-tenant mode, storm launches long-running JVMs across cluster without sudo access to user. Self-serving of Java heap-dumps, jstacks and java profiling of these JVMs would improve users' ability to analyze and debug issues when monitoring it actively.
+
+The storm dynamic profiler lets you dynamically take heap-dumps, jprofile or jstack for a worker jvm running on stock cluster. It let user download these dumps from the browser and use your favorite tools to analyze it The UI component page provides list workers for the component and action buttons. The logviewer lets you download the dumps generated by these logs. Please see the screenshots for more information.
+
+Using the Storm UI
+-------------
+
+In order to request for heap-dump, jstack, start/stop/dump jprofile or restart a worker, click on a running topology, then click on specific component, then you can select worker from the dropdown for that particular component and then click on “Start","Heap", "Jstack" or "Restart Worker" in the "Profiing and Debugging" section.
+
+
+
+For start jprofile, provide a timeout in minutes (or 10 if not needed). Then click on “Start”.
+
+
+
+To stop the jprofile logging click on the “Stop” button. This dumps the jprofile stats and stops the profiling. Refresh the page for the line to disappear from the UI.
+
+Click on "My Dump Files" to go the logviewer UI for list of worker specific dump files.
+
+
+
+Configuration
+-------------
+
+The "worker.profiler.command" can be configured to point to specific pluggable profiler, heapdump commands. The "worker.profiler.enabled" can be disabled if plugin is not available or jdk does not support Jprofile flight recording so that worker JVM options will not have "worker.profiler.childopts". To use different profiler plugin, you can change these configuration.
+
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/images/dynamic_log_level_settings_1.png
----------------------------------------------------------------------
diff --git a/docs/documentation/images/dynamic_log_level_settings_1.png b/docs/documentation/images/dynamic_log_level_settings_1.png
new file mode 100644
index 0000000..71d42e7
Binary files /dev/null and b/docs/documentation/images/dynamic_log_level_settings_1.png differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/images/dynamic_log_level_settings_2.png
----------------------------------------------------------------------
diff --git a/docs/documentation/images/dynamic_log_level_settings_2.png b/docs/documentation/images/dynamic_log_level_settings_2.png
new file mode 100644
index 0000000..d0e61a7
Binary files /dev/null and b/docs/documentation/images/dynamic_log_level_settings_2.png differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/images/dynamic_profiling_debugging_1.png
----------------------------------------------------------------------
diff --git a/docs/documentation/images/dynamic_profiling_debugging_1.png b/docs/documentation/images/dynamic_profiling_debugging_1.png
new file mode 100644
index 0000000..3913e86
Binary files /dev/null and b/docs/documentation/images/dynamic_profiling_debugging_1.png differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/images/dynamic_profiling_debugging_2.png
----------------------------------------------------------------------
diff --git a/docs/documentation/images/dynamic_profiling_debugging_2.png b/docs/documentation/images/dynamic_profiling_debugging_2.png
new file mode 100644
index 0000000..66c0236
Binary files /dev/null and b/docs/documentation/images/dynamic_profiling_debugging_2.png differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/documentation/images/dynamic_profiling_debugging_3.png
----------------------------------------------------------------------
diff --git a/docs/documentation/images/dynamic_profiling_debugging_3.png b/docs/documentation/images/dynamic_profiling_debugging_3.png
new file mode 100644
index 0000000..5706d7e
Binary files /dev/null and b/docs/documentation/images/dynamic_profiling_debugging_3.png differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/images/dynamic_log_level_settings_1.png
----------------------------------------------------------------------
diff --git a/docs/images/dynamic_log_level_settings_1.png b/docs/images/dynamic_log_level_settings_1.png
deleted file mode 100644
index 71d42e7..0000000
Binary files a/docs/images/dynamic_log_level_settings_1.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/images/dynamic_log_level_settings_2.png
----------------------------------------------------------------------
diff --git a/docs/images/dynamic_log_level_settings_2.png b/docs/images/dynamic_log_level_settings_2.png
deleted file mode 100644
index d0e61a7..0000000
Binary files a/docs/images/dynamic_log_level_settings_2.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/images/dynamic_profiling_debugging_1.png
----------------------------------------------------------------------
diff --git a/docs/images/dynamic_profiling_debugging_1.png b/docs/images/dynamic_profiling_debugging_1.png
deleted file mode 100644
index 3913e86..0000000
Binary files a/docs/images/dynamic_profiling_debugging_1.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/images/dynamic_profiling_debugging_2.png
----------------------------------------------------------------------
diff --git a/docs/images/dynamic_profiling_debugging_2.png b/docs/images/dynamic_profiling_debugging_2.png
deleted file mode 100644
index 66c0236..0000000
Binary files a/docs/images/dynamic_profiling_debugging_2.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/storm/blob/25f31a0e/docs/images/dynamic_profiling_debugging_3.png
----------------------------------------------------------------------
diff --git a/docs/images/dynamic_profiling_debugging_3.png b/docs/images/dynamic_profiling_debugging_3.png
deleted file mode 100644
index 5706d7e..0000000
Binary files a/docs/images/dynamic_profiling_debugging_3.png and /dev/null differ