OSGi Infrastructure Configuration

The GlassFish application server versions 3.x and later uses OSGi architecture. By default, OSGi containers follow a specific model for bootstrap class delegation. Classes that are not specified in the container's CLASSPATH are not delegated to the bootstrap classloader; therefore you must configure the OSGi containers for the Java Agentclasses.

See GlassFish Startup Settings and GlassFish OSGi Configuration per Domain.

To ensure that the OSGi container identifies the Java Agent, specify this package prefix:

CODE 
org.osgi.framework.bootdelegation=com.singularity.*

This prefix follows the regular boot delegation model so that the Java Agent classes are visible.

If you already have existing boot delegations, add "com.singularity.*" to the existing path separated by a comma. For example:

CODE 
org.osgi.framework.bootdelegation=com.sun.btrace., com.singularity

Configure Eclipse Equinox

To configure Eclipse Equinox:
Configure Eclipse Equinox for your environment:
Option Description
If running Eclipse Equinox under Glassfish
  1. Open the config.ini file located at <glassfish install directory>/glassfish/osgi/equinox/configuration.
  2. Add this package prefix to the config.ini file:
    CODE 
    org.osgi.framework.bootdelegation=com.singularity.*
If running Eclipse Equinox under the WebSphere Application Server Liberty profile
  1. Open the bootstrap.properties file in the JVM directory <WLP_home>/usr/servers/<server_name> for editing.
  2. Add this code line:
    CODE 
    org.osgi.framework.bootdelegation=com.singularity.*
See Getting Started with Equinox.

Configure Apache Sling

  1. Open the sling.properties file.
    The location of the sling.properties varies depending on the Java platform. In the Sun/Oracle implementation, the sling.properties file is located at <java.home>/lib.
  2. Add this package prefix to the sling.properties file:
    CODE 
    org.osgi.framework.bootdelegation=com.singularity.*

Configure JIRA or Confluence

For JIRA >= 5.1.8, and Confluence >= 5.3:

  1. Open the startup script (that is, catalina.sh) for editing.
  2. Look for the start command block:
    CODE 
    elif [ "$1" = "start" ] ; then
  3. Add the following Java system property alongside the existing properties in both else blocks:
    CODE 
    -Datlassian.org.osgi.framework.bootdelegation.extra=com.singularity.*
  4. Add the property to the run command block as well to instrument the application started in run mode.
    For example:Run Command Block
  5. Before the comment line 'Execute The Requested Command', add the –javaagent argument to the file as a new Java option:
    • Linux
      CODE 
      JAVA_OPTS="$JAVA_OPTS -javaagent:<agent_home>/javaagent.jar"
    • Windows
      CODE 
      set JAVA_OPTS=%JAVA_OPTS% -javaagent:"Drive:<agent_home>\javaagent.jar"
  6. Restart the application.

Configure Other OSGi-based Containers

For other OSGI-based runtime containers, add this package prefix to the appropriate OSGi configuration.

CODE 
file.org.osgi.framework.bootdelegation=com.singularity.*

Configure Apache Karaf

  1. Open the custom.properties file for Karaf.
    It is located at $KARAF_HOME/etc/custom.properties . $KARAF_HOME is the path to the folder where Karaf is installed.
  2. Add this package prefix to the custom.properties file:
    CODE 
    org.osgi.framework.bootdelegation=com.singularity.*
    Important: >All the values specified in the custom.properties file will override the default values specified in the /etc/config.properties file. So, ensure that you include the default values of org.osgi.framework.bootdelegation from the config.properties file to the custom.properties file.

    Once configured, all applications based on Java Agent Supported Frameworks that are running on Apache Karaf can be instrumented and seen on the Controller UI.