Chat now with support
Chat with Support

Foglight for Java EE Technologies 5.9.9 - Installation Guide

Install and Configure Foglight for Java EE Technologies Integrate with JBoss Integrate with Apache Tomcat Integrate with WebLogic Domain Startup Scripts Integrate with WebSphere Integrate with Oracle AS Create a Generic Installation for Manual Java EE Agent Integration Manage Java EE Agent Installations, Integrations, and Configurations Managing Java EE Agent Configurations Java EE Installation Management Java EE Integration Configuration FAQ and Troubleshooting Manual Application Server Integrations AppendixB: Managing Permissions for the Java EE Integration Agent Appendix A: Java EE Application Methods

Separating requests by parent method

Use the StopCurrentRequestInMethods parameter as a separate parameter when you want to stop the request in the configured method. Once stopped, the next method entered starts a new request. The data collected for the original request is not lost but has stopped collecting. The benefit of using the StopCurrentRequestInMethods parameter is to organize and specify the time range during which the Java EE agent collects requests.
The StopCurrentRequestInMethods setting splits one request type into two or more request types where the original request ends on the specified method and new requests are started on children of the specified method.
For example, suppose that you have the following request:
GET /foo/bar -> service() -> doGet() -> doSomeStuff() -> doMoreStuff()
and you want to configure it to split on the doGet() method. The result is two requests:
GET /foo/bar -> service() -> doGet()
doSomeStuff() -> doMoreStuff()
The configured method becomes a leaf in the original request and methods called within the defined method become the root node in new request types. The configured method becomes a method node even if it was previously part of a component.
* 
IMPORTANT: To prevent the split requests from being filtered out, make two additional changes:
•
AllowNonComponentRootNodes must be set to enabled (true).
•
Filtering Rules in the Recording Settings must be updated with a rule to include the new request type.
For more information, see Allowing non-component root nodes , and the Managing Nexus Recording Settings topic in the Managing Application Servers Administration and Configuration Guide.
* 
NOTE: Methods included in this list should not be included in the Named Methods list, the Custom Components list, the Long Running User Methods list, or the Start New Request In Methods list. This list takes precedence over all others. If the method is included in other lists, the agent logs a warning indicating the affected method and the ignored instrumentor.
To split a request on a parent method:
* 
TIP: To review how to access the instrumentation settings editor, see Editing agent instrumentation configurations
1
Click the Requests tab of the Edit dialog box.
2
To add method that the agent should stop on, click Edit beside StopCurrentRequestInMethods.
In the Settings Editor that opens, you can add, remove, or change the order of methods that the agent should stop on.
3
Click Add to add a stop method.
4
In the empty row that appears, do the following:
a
Leave the Include or Exclude option set to include (the default setting).
b
This example does not use a regular expression, so leave the Regex check box cleared.
c
Click in the Method Name box and type the name of the method that you want the agent to stop on. In this example, that is:
com.foo.bar.SomeServletName.doGet()
5
Click OK.
6
In the Edit dialog box, click Save.
7
Restart your application servers.
The result is two requests:
GET /foo/bar -> service() -> doGet()
and
doSomeStuff() -> doMoreStuff()
Manual configuration — StopCurrentRequestInMethods
If you manually edit the instrumentation.config file, use the following syntax to specify the stop methods.
StopCurrentRequestInMethods = MethodList();
For example, if the following request
GET /foo/bar -> service() -> doGet() -> doSomeStuff() -> doMoreStuff()
is configured to split on the doGet() method as follows:
StopCurrentRequestInMethods = MethodList(
  include "com.foo.bar.SomeServletName.doGet()",
);
the result will be the following two requests:
GET /foo/bar -> service() -> doGet()
doSomeStuff() -> doMoreStuff()

Splitting requests during single tracing

By default, requests that have been split using the StopCurrentRequestInMethods setting also appear as separate requests when collecting in single-trace mode.
Disabling the SplitRequestsWhenSingleTracing setting prevents request splitting when collecting a single trace. Requests that would otherwise be separated appear as part of the same call tree. In some situations, the additional context may be helpful for more detailed analysis.
To enable non-component root nodes:
* 
TIP: To review how to access the instrumentation settings editor, see Editing agent instrumentation configurations .
1
Click the Requests tab of the Edit dialog box.
2
Clear the check box for SplitRequestsWhenSingleTracing.
3
Click Save.
4
Restart your application server.
Manual configuration — SplitRequestWhenSingleTracing
If you manually edit the instrumentation.config file, use the following syntax to specify that requests should be split while single tracing.
SplitRequestsWhenSingleTracing = true;

Customizing instrumented classes

The Advanced instrumentation settings for a Java EE agent control which classes are instrumented.The InstrumentedClasses setting customizes the classes that are instrumented. In almost all cases, tune instrumentation using the UserClasses or CustomComponents. Changing any of these settings can have performance implications. For more information, see Changing user classes settings and Changing custom component settings .
The InstrumentedClasses setting is normally used to exclude a class when instrumentation causes failures or application problems.
•
Excluding a class ensures that it is excluded from all instrumentation.
•
Including a class causes the class to be examined and, if it implements important application server functionality, it may be instrumented appropriately.
* 
IMPORTANT: Do not use the Instrumented Classes setting to exclude classes from instrumentation except at the recommendation of Customer Support.
To edit the list of instrumented classes:
* 
TIP: To review how to access the instrumentation settings editor, see Editing agent instrumentation configurations .
1
Click the Advanced tab of the Edit dialog box.
2
Click Edit beside InstrumentedClasses.
3
Follow the instructions from Customer Support.

Managing other Java EE agent configuration files

The Advanced Configuration view lists all available version-specific agent configuration files. Sometimes, you may need to manually edit these files. It is strongly recommended that you do not change any of these files unless you have been told to do so by Customer Support.
To edit agent configuration files:
1
On the navigation panel, under Dashboards, click Application Servers > Administration > Application Servers Administration.
2
On the Application Servers Administration dashboard, click Java Administration.
3
On the Java Administration dashboard, click the Agent Configurations tab.
4
On the Agent Configurations tab, click Advanced configuration.
The Advanced Configuration page loads.
5
Select the version of the Java EE agent that you want to manage from the Version list (for example, 5.9.2 or 5.8).
6
Optional — To view the entire path to the file, click Show fully qualified names.
7
Click the name of the file that you want to edit, and in the menus that opens, click Edit.
8
Make any required changes, and click Save.
* 
IMPORTANT: The Update Policy column indicates when any changes are applied after you save the file. For some files, the change is immediate; for others, the application server must be restarted.
9
Restart your application server if necessary.
 
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating