Foglight for Java EE Technologies 5.9.7.5

It is possible to manually edit the settings in the instrumentation.config file instead of using the GUI editor. If you are comfortable and familiar with these settings from previous versions of Foglight for Java EE Technologies, you may prefer to use the text editor.

To manually edit the instrumentation settings:

On the navigation panel, under Dashboards, click Application Servers > Administration > Application Servers Administration.

On the Application Servers Administration dashboard, click Java Administration.

On the Java Administration dashboard, click the Agent Configurations tab.

On the Agent Configurations tab, click the name of the agent configuration that you want to edit.

In the menu that opens, click Manage.

The Java Agent Configuration: <configuration name> view opens.

From the Version list, select the version of the Java EE agent (for example 5.9.2 or 5.8) that you want to work with.

Click the name of the file that you want to edit. In this case, click instrumentation.

In the menu that opens, select Text edit.

Type the required information in the text editor.

After you set all the required values, click Save.

Restart the application server.

Managing General Instrumentation Settings

The General instrumentation settings for a Java EE agent include instrumentation levels, simple methods, user classes, custom components, and custom component callbacks. Changing any of these settings can have performance implications. Review the provided information before making any changes.

Changing the Instrumentation Level for Request Metric Data Collection

The Java EE agent uses instrumentation to perform request monitoring and collect single traces. This instrumentation does add some overhead to your monitored servers and the information collected indirectly applies load to the Foglight Management Server. However, if you only require single traces collected at component level, or you do not require request monitoring at all, you can reduce or turn off instrumentation using the Instrumentation Level setting. This reduces the overhead on your monitored servers, as well as the load on the Foglight Management Server.

The default instrumentation level is FullDetail. At full detail level, request monitoring can be enabled and, when single traces are collected, all nodes in the call tree are included. This level provides the most flexibility in terms of request monitoring and single trace collection and should be acceptable for most customers.

If you require request monitoring, but do not require full detail single traces, instrumentation can be set to Component Detail. At component detail level, you can enable request monitoring, but when single traces are collected, they are collected at only the component technology detail level, reducing the complexity of the call tree. This level is more restrictive in what information can be collected for single traces, but reduces both the agent overhead on the monitored server and the load on the Management Server.

If you require request monitoring but only require request metrics for HTTP, JMS, and RMI requests, instrumentation can be set to Basic Detail. At this level, no breakdowns are collected and, if single traces are collected, only HTTP, JMS, and RMI nodes are included in the Request Trace call tree. No other component or full detail methods are collected, therefore reducing both the agent overhead on the monitored server and the load on the Management Server, compared to the Component Detail instrumentation level.

If you do not require request monitoring or the ability to capture single traces, instrumentation for this purpose can be disabled by setting the instrumentation level to No Detail. At this setting, request monitoring cannot be enabled and you are unable to capture single traces at any detail level. This removes instrumentation overhead on the monitored server and greatly reduces load on the Management Server.


	IMPORTANT: If you want to monitor which classes or interfaces are used by custom components to call customer written code, see Changing Custom Component Callbacks Settings .

To set the instrumentation level:


	TIP: To review how to access the instrumentation settings editor, see Editing Agent Instrumentation Configurations .

On the General tab of the Edit dialog box, select the instrumentation level from the InstrumentationLevel list.

•

Full Detail — Instruments at full detail level. All methods in the call tree are captured.

•

Component Detail — Instruments at the component level only. Methods from defined component technology, including custom components, are captured.

•

Basic Detail — Instruments at a basic level. Only request metrics for HTTP, JMS, and RMI request are collected. No other component or full detail methods are captured.

•

No Detail — Turns off instrumentation that is not essential for running an agent. As a result, no request metrics are collected, and single traces call trees cannot be captured.


	NOTE: As a result of setting instrumentation to this level, no data is displayed in the Application Servers Monitor > Requests tab.

Click Save.

Restart your application server.

Manual Configuration - InstrumentationLevel

If you manually edit the instrumentation.config file, use the following syntax to set the instrumentation level:

Table 1. Instrument level syntax.
Level	Syntax
FullDetail	InstrumentationLevel = "FullDetail";
ComponentDetail	InstrumentationLevel = "ComponentDetail";
BasicDetail	InstrumentationLevel = "BasicDetail";
NoDetail	InstrumentationLevel = "NoDetail";

Configuring Instrumented Simple Method Settings

Simple methods are methods for which instrumentation would add more byte-code and overhead to the original method.

By default simple methods are not instrumented to reduce overhead of a sampled request as well as the complexity of single traces. When simple methods are not instrumented, any time spent in those methods is attributed to the caller.


	CAUTION: Simple methods usually execute extremely quickly, so instrumentation adds unnecessary overhead and complexity.

To explicitly name methods for instrumentation:


	TIP: To review how to access the instrumentation settings editor, see Editing Agent Instrumentation Configurations .

On the General tab of the Edit dialog box, click Edit

beside InstrumentedSimpleMethods.

In the Settings Editor dialog box, click

Add.

If you want the method name to be treated as a regular expression, select the Regex check box.

Click in the Method Name box and type the name of the method you want to instrument. For example, in the following image, the getSugar() method is instrumented even if it is detected as a simple method.