You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2011/02/13 10:04:29 UTC
svn commit: r1070195 - in
/karaf/branches/karaf-2.2.x/manual/src/main/webapp: developers-guide/ images/
Author: jbonofre
Date: Sun Feb 13 09:04:28 2011
New Revision: 1070195
URL: http://svn.apache.org/viewvc?rev=1070195&view=rev
Log:
[KARAF-431] Add documentation around remote management via JMX.
Added:
karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_admin.jpg
karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_connect.jpg
karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_features.jpg
karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_memory.jpg
karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_overview.jpg
karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_summary.jpg
karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_threads.jpg
Modified:
karaf/branches/karaf-2.2.x/manual/src/main/webapp/developers-guide/debugging.conf
Modified: karaf/branches/karaf-2.2.x/manual/src/main/webapp/developers-guide/debugging.conf
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/developers-guide/debugging.conf?rev=1070195&r1=1070194&r2=1070195&view=diff
==============================================================================
--- karaf/branches/karaf-2.2.x/manual/src/main/webapp/developers-guide/debugging.conf (original)
+++ karaf/branches/karaf-2.2.x/manual/src/main/webapp/developers-guide/debugging.conf Sun Feb 13 09:04:28 2011
@@ -1,6 +1,6 @@
-h1. Troubleshooting, Debugging and Profiling
+h1. Troubleshooting, Debugging,Profiling, and Monitoring
h2. Troubleshooting
@@ -75,8 +75,6 @@ and on Windows,
set DEFAULT_JAVA_DEBUG_OPTS='-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005'
{code}
-
-
h2. Profiling
h3. YourKit
@@ -100,4 +98,39 @@ set JAVA_OPTS='-Xmx512M -agentlib:yjpage
Run Karaf from the console, and you should now be able to connect using YourKit standalone or from your favorite IDE.
+h2. Monitoring
+
+Karaf uses JMX for monitoring and management of all Karaf components.
+
+The JMX connection could be:
+* local using the process id
+
+!/images/jconsole_connect.jpg|border=1!
+
+* remote using the {{rmiRegistryPort}} property defined in {{etc/org.apache.karaf.management.cfg}} file.
+
+Using JMX, you can have a clean overview of the running Karaf instance:
+
+* A overview with graphics displaying the load in terms of thread, heap/GC, etc:
+
+!/images/jconsole_overview.jpg|border=1!
+
+* A thread overview:
+
+!/images/jconsole_threads.jpg|border=1!
+
+* A memory heap consumption, including "Perform GC" button:
+
+!/images/jconsole_memory.jpg|border=1!
+
+* A complete JVM summary, with all number of threads, etc:
+
+!/images/jconsole_summary.jpg|border=1!
+
+You can manage Karaf features like you are in the shell. For example, you have access to the Admin service MBean, allowing you to create, rename, destroy, change SSH port, etc Karaf instances:
+
+!/images/jconsole_admin.jpg|border=1!
+
+You can also manage Karaf features MBean to list, install, uninstall Karaf features:
+!/images/jconsole_features.jpg|border=1!
\ No newline at end of file
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_admin.jpg
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_admin.jpg?rev=1070195&view=auto
==============================================================================
Files karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_admin.jpg (added) and karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_admin.jpg Sun Feb 13 09:04:28 2011 differ
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_connect.jpg
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_connect.jpg?rev=1070195&view=auto
==============================================================================
Files karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_connect.jpg (added) and karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_connect.jpg Sun Feb 13 09:04:28 2011 differ
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_features.jpg
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_features.jpg?rev=1070195&view=auto
==============================================================================
Files karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_features.jpg (added) and karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_features.jpg Sun Feb 13 09:04:28 2011 differ
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_memory.jpg
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_memory.jpg?rev=1070195&view=auto
==============================================================================
Files karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_memory.jpg (added) and karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_memory.jpg Sun Feb 13 09:04:28 2011 differ
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_overview.jpg
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_overview.jpg?rev=1070195&view=auto
==============================================================================
Files karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_overview.jpg (added) and karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_overview.jpg Sun Feb 13 09:04:28 2011 differ
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_summary.jpg
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_summary.jpg?rev=1070195&view=auto
==============================================================================
Files karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_summary.jpg (added) and karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_summary.jpg Sun Feb 13 09:04:28 2011 differ
Added: karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_threads.jpg
URL: http://svn.apache.org/viewvc/karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_threads.jpg?rev=1070195&view=auto
==============================================================================
Files karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_threads.jpg (added) and karaf/branches/karaf-2.2.x/manual/src/main/webapp/images/jconsole_threads.jpg Sun Feb 13 09:04:28 2011 differ