View source for Virgo/Diagnostics

{{Virgo}}
This page contains hints and tips for diagnosing problems with Virgo and Virgo applications. 

__FORCETOC__
== Equinox Console  ==

The Equinox Console is useful for examining either the kernel framework or the user region framework.

Virgo offers shell commands to the user region Equinox Console for slightly more friendly inspection of user region artefacts.

To enable an Equinox console, you need to set a framework property, like this: 
<pre>osgi.console=2402
</pre>identifying the port to use.
 
In the case of the user region, add this property to the file <tt>config/org.eclipse.virgo.kernel.userregion.properties</tt>. In the case of the kernel region, add this property to the file <tt>lib/org.eclipse.virgo.kernel.launch.properties</tt>. 

You can even enable an Equinox console in both regions at once, using two different ports of course. 

To use the console, telnet in: 
<pre>&gt; telnet localhost 2402
</pre> 
The most useful commands are '<tt>ss</tt>' to list all bundles, '<tt>bundle &lt;n&gt;</tt>' to display information about the bundle with bundle id '<tt>&lt;n&gt;</tt>', and '<tt>help</tt>' to see other commands. 

When running in the user region, the Virgo shell commands are offered via the '<tt>vsh</tt>' command.  Type '<tt>vsh help</tt>' to see a list of the shell commands available.

== Precision Debug logging ==

It is possible to turn on logging at various levels for specific classes (loggers) in Virgo. We illustrate this with a <code lang="java">'''FileSystemChecker'''</code> ''debug'' trace, which is part of the <code lang="java">'''HotDeployer'''</code> system.

In <code lang="text">'''serviceability.xml'''</code> in the <code lang="text">'''config'''</code> directory simply add the following: <pre><logger level="DEBUG" additivity="false" name="org.eclipse.virgo.kernel.deployer.hot.HotDeployer">
    <appender-ref ref="SIFTED_LOG_FILE" />
</logger></pre>
after the other logger specifications and before the root tag.

This puts debug information in the <code lang="text">'''log.log'''</code> file in <code lang="text">'''serviceability/logs/virgo-kernel'''</code> directory.

Alternatively, set <code lang="text">'''appender-ref ref="LOG_FILE"'''</code> and the debug information goes in the general <code lang="text">'''log.log'''</code> file in the <code lang="text">'''serviceability/logs'''</code> directory.

In this case the sort of output you might see is (actual paths have been replaced): <pre>[2010-07-23 12:27:44.599] fs-watcher                   org.eclipse.virgo.kernel.deployer.hot.HotDeployer                 pickup - before check:
	FileList():  [test.configuration.properties]
	Known files: [/path-to-server-home/pickup/test.configuration.properties]
	Monitored:   [/path-to-server-home/pickup/test.configuration.properties] 
[2010-07-23 12:27:44.660] fs-watcher                   org.eclipse.virgo.kernel.deployer.hot.HotDeployer                 pickup - after check:
	Known files: [/path-to-server-home/pickup/test.configuration.properties]
	Monitored:   [] 
[2010-07-23 12:27:45.661] fs-watcher                   org.eclipse.virgo.kernel.deployer.hot.HotDeployer                 pickup - before check:
	FileList():  [test.configuration.properties]
	Known files: [/path-to-server-home/pickup/test.configuration.properties]
	Monitored:   [] 
[2010-07-23 12:27:45.661] fs-watcher                   org.eclipse.virgo.kernel.deployer.hot.HotDeployer                 pickup - after check:
	Known files: [/path-to-server-home/pickup/test.configuration.properties]
	Monitored:   [] 
[2010-07-23 12:27:46.661] fs-watcher                   org.eclipse.virgo.kernel.deployer.hot.HotDeployer                 pickup - before check:
	FileList():  [test.configuration.properties]
	Known files: [/path-to-server-home/pickup/test.configuration.properties]
	Monitored:   [] 
[2010-07-23 12:27:46.662] fs-watcher                   org.eclipse.virgo.kernel.deployer.hot.HotDeployer                 pickup - after check:
	Known files: [/path-to-server-home/pickup/test.configuration.properties]
	Monitored:   [] </pre>

which is pretty verbose, so be aware that the log file may become quite large very quickly.  In the standard <code lang="text">'''serviceability.xml'''</code> file the appenders used here write to "rolling log files" which are based upon size; so the total amount of logged information is bounded, though the log you choose can be swamped with information from one source.

The <code lang="text">'''serviceability.xml'''</code> file is just a logback configuration file, and all the Logback functionality is available. For more information see the [http://logback.qos.ch/manual/configuration.html Logback configuration] on-line documentation.

== Entry and Exit tracing ==

In the default '''<code lang="text">serviceability.xml</code>''' file the root logging level is '''<code lang="text">INFO</code>'''. This is reasonable: if a log entry is made at <b><code lang="text">INFO</code></b> level, one expects this to appear in the log under normal circumstances.

<code lang="text">Medic</code> (one of the Virgo repositories) is designed to set up logging, tracing and dumping, for use by the rest of the code, and achieves this partly by weaving in aspects that perform tracing at the entry and exit  points of methods. These aspects are woven into the rest of the code so that they don't have to code them themselves.

The entry and exit level tracing aspects are carefully woven into the <code lang="text">kernel</code> and the server code (<code lang="text">web</code>) to avoid the logging code itself (recursion) and the low-level utility functions (<code lang="text">util</code> and <code lang="text">osgi-extensions</code>).

It traces entry and exit points at two levels: <b><code lang="text">DEBUG</code></b> for all <code lang="java">public</code> methods and <b><code lang="text">TRACE</code></b> for all other methods (package private and private).  'Getter' and 'Setter' methods (those beginning with <code lang="text">get</code> and <code lang="text">set</code>) are not traced at any level.

So, to see these entries you need to set the logging level to <b><code lang="text">DEBUG</code></b> or higher for the areas you are interested in.

You will see entries in the <b><code lang="text">serviceability/log/log*.log</code></b> files like this:<pre>[2010-07-29 16:40:31.342] main   > public static boolean org.eclipse.virgo.kernel.core.BundleUtils.isFragmentBundle(org.osgi.framework.Bundle) 
[2010-07-29 16:40:31.342] main   < public static boolean org.eclipse.virgo.kernel.core.BundleUtils.isFragmentBundle(org.osgi.framework.Bundle) 
[2010-07-29 16:40:31.342] main   > public void org.eclipse.virgo.kernel.core.internal.BundleStartTracker.trackStart(org.osgi.framework.Bundle, org.eclipse.virgo.kernel.core.Signal) 
[2010-07-29 16:40:31.342] main   > public static boolean org.eclipse.virgo.kernel.core.BundleUtils.isFragmentBundle(org.osgi.framework.Bundle) 
[2010-07-29 16:40:31.343] main   < public static boolean org.eclipse.virgo.kernel.core.BundleUtils.isFragmentBundle(org.osgi.framework.Bundle) 
[2010-07-29 16:40:31.343] main   Adding signal 'org.eclipse.virgo.kernel.install.artifact.internal.AbstractInstallArtifact$StateMonitorSignal@210c507' for bundle 'com.springsource.platform.apps.explicit_bundle_imports_1.0.0 [54]' 
[2010-07-29 16:40:31.343] main   < public void org.eclipse.virgo.kernel.core.internal.BundleStartTracker.trackStart(org.osgi.framework.Bundle, org.eclipse.virgo.kernel.core.Signal)</pre>

where the entry and exit points are marked with <b><code lang="text">></code></b> and <b><code lang="text"><</code></b> respectively, with the full class names of the method and its parameters supplied.

It is arranged that <i>any</i> exit from a method will be traced if its entry is, even if that was the result of an exception, so the entry and exit lines should always pair.

== Profiling  ==

We use [http://yourkit.com YourKit] for profiling Virgo. The setup is simple and apart from adding the appropriate JVM options (described on the [http://yourkit.com/docs/95/help/agent.jsp YourKit site]) to JAVA_OPTS, all that is necessary is to add <tt>com.yourkit.*</tt> to the <tt>org.osgi.framework.bootdelegation</tt> property in <tt>lib/java6-server.profile</tt>. Note that YourKit has a [http://yourkit.com/docs/95/help/filters.jsp default filter] which excludes <tt>org.eclipse.*</tt>, so if you would like to profile the internals of Virgo then you'll need to disable this filter.

For a detailed break down of this process, please see the section below related to your operating system.

=== Linux / Unix  ===

#Install YourKit to your PC. For the purposes of this guide, YourKit has been installed into <tt>/opt/yjp-9.5.4</tt>. You do not have to install YourKit into this directory to enable profiling with Virgo. It is just used as an example. 
#Locate the directory where you have installed Virgo, create the following file and open it: <tt>bin/setenv.sh</tt> 
#Edit the file <tt>bin/setenv.sh</tt> and add two shell variables: YJP_HOME and JAVA_OPTS. 
#Set YJP_HOME to point to the location of your YourKit installation. 
#Set JAVA_OPTS as follows:

<div style="margin-left: 3.5em;">
'''Linux 32-bit'''
<source lang="bash">
YJP_HOME="/opt/yjp-9.5.4"
JAVA_OPTS="-agentpath:$YJP_HOME/bin/linux-x86-32/libyjpagent.so=disablestacktelemetry,disableexceptiontelemetry,builtinprobes=none,delay=1000 
</source></div>
<div style="margin-left: 3.5em;">
'''Linux 64-bit'''
<source lang="bash">
YJP_HOME="/opt/yjp-9.5.4"
JAVA_OPTS="-agentpath:$YJP_HOME/bin/linux-x86-64/libyjpagent.so=disablestacktelemetry,disableexceptiontelemetry,builtinprobes=none,delay=1000
</source></div>
<p style="margin-left: 3.5em;">'''Other *nix'''<br/>For other versions of Unix, use either one of the above options and simply alter <tt>-agentpath:$YJP_HOME/bin/os-arch/libyjpagent.so</tt> so that <tt>$YJP_HOME/bin/os-arch/libyjpagent.so</tt> points to the YourKit Agent library for your platform.</p>
<ol start="6">
 <li>Locate and open the file <tt>lib/java6-server.profile</tt>. Towards the bottom of that file, there will be a section for ''bootdelegation''. Add the following value to that section, <tt>com.yourkit.*,\</tt><br/>
<p>For example:</p>
<div style="margin-left: 1.5em;">
<pre>
org.osgi.framework.bootdelegation = \
org.eclipse.virgo.osgi.extensions.*,\
org.eclipse.virgo.osgi.launcher.*,\
org.eclipse.virgo.kernel.authentication,\
com.sun.*,\
com.yourkit.*,\
javax.xml.*,\
org.apache.xerces.jaxp.*,\
org.w3c.*,\
org.xml.*,\
sun.*
</pre></div>
</li>
<li>Restart the Eclipse Virgo installation. The first line of the console output should read as follows.<br/>
<div style="margin-left: 1.5em;">
<pre>
[YourKit Java Profiler 9.5.4] Loaded. Log file: /home/user/.yjp/log/7191.log
</pre></div>
<p>This means that the YourKit profiler has been enabled for the Virgo installation. If you do not see this line as the first line of the console output, please check the edits made to the bin/setenv.sh file and to the lib/java6-server.profile file in the previous two steps.</p>
</li>
<li>Start the YourKit application.</li>
<li>If you would like to profile the internals of Virgo, go to the ''Settings'' menu and select ''Filters''.  Then scroll down the list till you see the entry for <tt>Eclipse</tt>.  Unselect the checkbox next to that entry and click the ''OK'' button.  '''Note''' You only need to perform this step once.</li>
<li>Look at the '''Monitor Local Applications''' panel, it should now contain an entry for the Eclipse Virgo server, labeled as '''Launcher'''. Click the link to start profiling Virgo and any bundles deployed to the server.</li>
</ol>

=== Windows  ===

#Install YourKit to your PC. For the purposes of this guide, YourKit has been installed into <tt>C:\Program Files\YourKit Java Profiler 9.5.4</tt>. You do not have to install YourKit into this directory to enable profiling with Virgo. It is just used as an example. 
#Right click on ''My Computer'' and go to ''Properties''. Click the ''Advanced'' tab and then the ''Environment'' button. 
#Add a ''System Variable'' called YJP_HOME and set its value to the location where YourKit was installed. For this example, that is <tt>C:\Program Files\YourKit Java Profiler 9.5.4</tt>. 
#Edit the ''Path'' system variable and append one of the following <tt>%YJP_HOME%\bin\win32</tt> for 32-bit Windows systems or <tt>%YJP_HOME%\bin\win64</tt> for 64-bit Windows systems. 
#Locate the directory where Virgo is installed and create a file called <tt>bin/setenv.bat</tt>. 
#Edit the file <tt>bin/setenv.bat</tt> and add a shell variable called JAVA_OPTS. Set the value to the following.
<div style="margin-left: 3em;"><source lang="bash">
set JAVA_OPTS="-agentpath:yjpagent=disablestacktelemetry,disableexceptiontelemetry,builtinprobes=none,delay=1000"
</source></div>
<ol start="7">
 <li>Locate and open the file <tt>lib\java6-server.profile</tt>. Towards the bottom of that file, there will be a section for ''bootdelegation''. Add the following value to that section, <tt>com.yourkit.*,\</tt><br/>
<p>For example:</p>
<div style="margin-left: 1.5em;">
<pre>
org.osgi.framework.bootdelegation = \
org.eclipse.virgo.osgi.extensions.*,\
org.eclipse.virgo.osgi.launcher.*,\
org.eclipse.virgo.kernel.authentication,\
com.sun.*,\
com.yourkit.*,\
javax.xml.*,\
org.apache.xerces.jaxp.*,\
org.w3c.*,\
org.xml.*,\
sun.*
</pre></div>
</li>
<li>Restart the Eclipse Virgo installation. The first line of the console output should read as follows.<br/>
<div style="margin-left: 1.5em;">
<pre>
[YourKit Java Profiler 9.5.6] Loaded. Log file: C:\Documents and Settings\Administrator\.yjp\log\3496.log
</pre></div>
<p>This means that the YourKit profiler has been enabled for the Virgo installation. If you do not see this line as the first line of the console output, please check the edits made to the bin/setenv.sh file and to the lib/java6-server.profile file in the previous two steps.</p>
</li>
<li>Start the YourKit application.</li>
<li>If you would like to profile the internals of Virgo, go to the ''Settings'' menu and select ''Filters''.  Then scroll down the list till you see the entry for <tt>Eclipse</tt>.  Unselect the checkbox next to that entry and click the ''OK'' button.  '''Note''' You only need to perform this step once.</li>
<li>Look at the '''Monitor Local Applications''' panel, it should now contain an entry for the Eclipse Virgo server, labeled as '''Launcher'''. Click the link to start profiling Virgo and any bundles deployed to the server.</li>
</ol>

[[Category:Virgo]] [[Category:EclipseRT]]