Foglight for Java EE Technologies 5.9.13 - Installation Guide

Full detail instrumentation level

The Java EE Agent instruments all the classes and methods in your application unless you explicitly exclude some.

At the package or class level, you can control which packages or classes are included or excluded by editing UserClasses in the agent_instrumentation.config file. For more information, see Changing user classes settings.

Within a class, you can control the number of recursive calls that are fully instrumented by editing the RecursionLimit in the agent_instrumentation.config file. For more information, see Setting the Request Recursion Limit.

Component detail instrumentation level

Focusing on a few crucial methods allows you to localize a potential trouble spot. Then you can add instrumentation targets to expand your search. Afterwards, by switching to the full detail instrumentation level, you can collect performance data on each method in your application.

Component detail instrumentation also reduces overhead. By collecting data only on a limited set of important classes and methods, you can run Foglight for Java EE Technologies with little degradation to your system’s response time.

To implement component detail instrumentation, Foglight for Java EE Technologies measures selected methods in Servlets, JSPs, EJBs, JMS, JNDI, HTTP, and JDBC. You can include your own choice of custom components by editing the CustomComponents configuration section in the file agent_instrumentation.config. For more information, see Changing custom component settings.

Application methods in component detail instrumentation level

When you choose component detail, only the classes listed in the following sections are instrumented. Therefore, any of your application’s classes that do not implement or extend the interfaces listed in this section are not tracked using Quest Software’s Tag and Follow™ technology.

When you need specific information about all the classes in your application, record in full detail. When you want to gather data on key Java EE classes, record in component detail. You can also extend the component detail view to include custom components.

IMPORTANT: Depending on how your application server implements them, certain methods listed below may not appear in a session recorded with component detail.

For classes that implement the javax.servlet.Servlet interface, Foglight for Java EE Technologies records:

For classes that implement the javax.servlet.http.HttpServlet interface, Foglight for Java EE Technologies records:

For classes that implement the javax.servlet.Filter interface, Foglight for Java EE Technologies records:

For classes that implement the javax.servlet.jsp.HttpJspPage interface, Foglight for Java EE Technologies records:

Session beans, entity beans, and message-driven beans are instrumented. As well, all classes that implement the javax.ejb.EJBLocalHome interface or the javax.ejb.EJBHome interface are recorded, excluding RMI stub classes.

WebLogic® or WebSphere® EJB wrapper classes are excluded from component detail instrumentation. For example, in a PetStore session, the productdetails tree has a node for the class named InventoryEJB_ripg5n_Impl. This class contains methods such as __WL_setBusy(Boolean) and __WL_isBusy(). This class is a WebLogic-generated wrapper class for the InventoryEJB and is not instrumented in component detail.

For classes that implement the javax.ejb.EJBLocalHome interface, or the javax.ejb.EJBHome interface, except for the RMI stub classes, Foglight for Java EE Technologies records:

WebLogic and WebSphere wrapper classes are excluded from component detail instrumentation.

For classes that implement the javax.ejb.SessionBean interface, Foglight for Java EE Technologies records all public methods, including:

Foglight for Java EE Technologies records all the public methods that your application has added to the bean to support your custom business logic.

Foglight for Java EE Technologies does not record:

For classes that implement the javax.ejb.EntityBean interface, Foglight for Java EE Technologies records all public methods, including:

Foglight for Java EE Technologies does not record:

For classes that implement the javax.ejb.MessageDrivenBean interface, and the javax.jms.MessageListener interface, Foglight for Java EE Technologies records all public methods, including:

Foglight for Java EE Technologies does not record:

For classes that are annotated with javax.ejb.Stateless, Foglight for Java EE Technologies records all public methods, including methods that are annotated with the following:

For classes that are annotated with javax.ejb.Stateful, Foglight for Java EE Technologies records all public methods, including methods that are annotated with the following:

For classes that are annotated with javax.ejb.MessageDriven, Foglight for Java EE Technologies records all public methods, including methods that are annotated with the following:

For classes that are annotated with javax.interceptor.Interceptors, Foglight for Java EE Technologies records all public methods, including methods that are annotated with the following:

For classes that are annotated with javax.persistence.Entity, Foglight for Java EE Technologies records all public methods, including methods that are annotated with the following:

For classes that are annotated with javax.persistence.EntityListeners, Foglight for Java EE Technologies records all public methods, including methods that are annotated with the following:

For classes that are annotated with javax.persistence.MappedSuperclass, Foglight for Java EE Technologies records all public methods, including methods that are annotated with the following:

For classes that implement the java.sql.Connection interface, Foglight for Java EE Technologies records:

CallableStatement prepareCall(String)

CallableStatement prepareCall(String, int, int)

CallableStatement prepareCall(String, int, int, int)

PreparedStatement prepareStatement(String)

PreparedStatement prepareStatement(String, int)

PreparedStatement prepareStatement(String, int[])

PreparedStatement prepareStatement(String, int, int)

PreparedStatement prepareStatement(String, int, int, int)

For classes that implement the java.sql.Driver interface, Foglight for Java EE Technologies records:

For classes that implement the java.sql.PreparedStatement interface, Foglight for Java EE Technologies records:

NOTE: If you are using a ResultSet implementation for your application with “scrollable” and “sensitive to changes” (TYPE_SCROLL_SENSITIVE) enabled, you may see unexpected database activity in the single trace view, if your users employed cursor movement methods such as last() or next(). This is because a ResultSet marked as “scrollable” and “sensitive” can require internal calls back to the database, to fetch data, as a result of method calls that move the cursor.

For classes that implement the java.sql.ResultSet interface, Foglight for Java EE Technologies records:

For classes that implement the java.sql.Statement interface, Foglight for Java EE Technologies records:

For classes that implement the javax.sql.ConnectionPoolDataSource interface, Foglight for Java EE Technologies records:

For classes that implement the javax.sql.DataSource interface, Foglight for Java EE Technologies records:

For classes that implement the javax.sql.PooledConnection interface, Foglight for Java EE Technologies records:

For classes that implement the javax.sql.XADataSource interface, Foglight for Java EE Technologies records:

Foglight for Java EE Technologies records the same information in component detail as for the full detail level.

Foglight for Java EE Technologies records the following calls to methods in JMS interfaces:

Foglight for Java EE Technologies records calls to all methods of these interfaces:

Foglight for Java EE Technologies tracks all the service requests that enter your instrumented application server, unless you explicitly choose to exclude some. You also have the option of splitting one service request and tracking each part separately.

Foglight for Java EE Technologies instruments all the RMI calls that enter your instrumented system.

AppendixB: Managing Permissions for the Java EE Integration Agent

To manually adjust the permissions for the Java EE Integration Agent, use the Foglight for Java EE Technologies Agent Properties page.

Before you make any changes, review the following topics: