Foglight for Java EE Technologies 5.9.11 - Installation Guide

Changing custom component settings

The Custom Components setting extends the default set of J2EE components to be included when recording a session at the Component Detail instrumentation level.

Sometimes, your distributed application may use third-party technologies that are not part of the default list of items included in the default instrumentation for the Java EE agent. If you want to include these in the component-only view, you can use custom component instrumentation.

The default custom component settings are shown in the following screenshot. Some customizations may be required to add additional classes if these frameworks have been extended. You can add package listings if necessary.

The method signature can be specified but it must be specified using the internal JVM format. For more information, see the Oracle Java SE Documentation: http://docs.oracle.com/javase/specs/#7035.

TIP: To review how to access the instrumentation settings editor, see Editing agent instrumentation configurations .

1	On the General tab of the Edit dialog box, click Edit beside CustomComponents.

a	Click Add component.

Click Add to add a single method at a time.

Click Add multiple to open a text box where you can type several methods.

If you manually edit the instrumentation.config file, use the following syntax to specify custom component instrumentation.

The default custom component settings are shown below. Some customizations may be required to add additional classes if these frameworks have been extended. In the example below, you can uncomment and add package listings if necessary.

Changing custom component callbacks settings

Use the Custom Component Callbacks setting to specify the classes or interfaces that the custom components use to call customer written code. The default instrumentation settings include some custom component callbacks for Apache Struts and Spring.

NOTE: This setting is only valid for Full Detail and Component Detail Instrumentation Levels. Changing its value has no effect if the instrumentation level is Basic Detail or No Detail. For information about instrumentation levels, see Changing the instrumentation level for Request Metric data collection .

For more information, see Appendix: Java EE Application Methods.

TIP: To review how to access the instrumentation settings editor, see Editing agent instrumentation configurations .

1	On the General tab of the Edit dialog box, click Edit beside CustomComponentCallbacks.

Click Add to add a single class at a time.

Click Add multiple to open a text box where you can type several classes.

If you manually edit the instrumentation.config file, use the following syntax to specify custom component callback instrumentation.

CustomComponentCallbacks = ClassList (
# Apache Struts 1.x
include "org.apache.struts.action.Action",
include "org.apache.struts.action.ActionForm",
include "org.apache.struts.action.ExceptionHandler",
);

Customizing Long Running Methods

Use the LongRunningUserMethods setting to customize the collection of performance data from methods that run over a long period of time. By default, the Java EE agent waits for a method to finish running before treating the collected data as complete. However, for methods such as the run() method of a background thread or other methods that run over a long period of time, it may be preferable to treat the data as complete at specific points in the code. This makes the data available in small pieces as the method runs instead of as one large piece when the long running method completes. Changing any of these settings can have performance implications.

The Java EE agent pauses at waypoint methods (LongRunningUserMethodWaypoints) to treat the data as complete before continuing. For best performance, use a minimal set of waypoint methods.

NOTE: This setting is only valid for Full Detail and Component Detail Instrumentation Levels. Changing its value has no effect if the instrumentation level is Basic Detail or No Detail. For information about instrumentation levels, see Changing the instrumentation level for Request Metric data collection .

TIP: To review how to access the instrumentation settings editor, see Editing agent instrumentation configurations .

2	To add long running methods, click Edit beside LongRunningUserMethods.

Click Add to add a single method at a time.

Click Add multiple to open a text box where you can type several methods.

1	On the Long Running Methods tab of the Edit dialog box, click Edit beside LongRunningUserMethodWaypoints.

Click Add to add a single waypoint at a time.

If you manually edit the instrumentation.config file, use the following syntax to specify long running user methods and waypoints instrumentation.

LongRunningUserMethods = MethodList(
include "com.globex.plan.DominateWorldThread.run"
);

LongRunningUserMethodWaypoints = MethodList(
include "com.globex.plan.DominateWorldThread.executeProjectArcturus"
);

In this case, the method "com.globex.plan.DominateWorldThread.run" treats the data as complete each time the method executeProjectArcturus() is called from run(). The Java EE agent pauses at waypoint methods to treat the data as complete before continuing. A minimal set of waypoint methods allows for the best possible performance.

Named Methods settings

The Named Methods instrumentation settings determine how the agent tracks specific methods. Changing any of these settings can have performance implications. Review the provided information before changing any settings.