Foglight for Java EE Technologies 5.9.13


	IMPORTANT: The higher the setting, the more significant the performance impact of the metric collection process is on your application server. For more information on PMI settings, see your WebSphere documentation.

Click Apply, then OK to return to the server settings.

In the Messages pane, click Save to apply your changes.

For the PMI settings to take effect, restart all WebSphere Application Servers in your environment.

Related topics:

•

Understanding what should be instrumented

•

Running WebSphere with security enabled

•

Integrating with WebSphere startup scripts

You can use the Java EE Integration Agent to integrate the Java EE agent with WebSphere® Startup Scripts. Specify the WAS Home and WAS Profile type for the application server that you want to integrate with.

To integrate with WebSphere on Solaris®, Linux®, HP-UX®, or AIX®, or on Windows®:

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

On the Application Servers Administration dashboard, in the Monitoring Agents section, click Setup agents...

In the menu that opens, select Java.

The Java — Setup New Application Server Integration wizard opens.

On the Setup Options page, select the type of integration. This example describes how to Setup a new application server integration (the default selection).


	TIP: For other integration methods, Reusing an integration configuration .

On the New Integration — Type page, select the type of Java application server you want to integrate with. In this case, select WebSphere on Solaris, Linux, HP-UX, or AIX, or WebSphere on Windows.

The wizard refreshes, providing the option to select the WebSphere application server startup method:

Table 3. Startup Method descriptions.
Startup Method	Description
Deployment Manager Startup Scripts	Startup Scripts for a Deployment Manager Node
Node Startup Scripts	Startup Scripts for a Federated Node
Deployment Manager Windows Service	Windows Service for a Deployment Manager
Server Startup Scripts	Startup Scripts for a non-federated WebSphere Application Server
Admin Agent Startup Scripts	Startup Scripts for an Admin Agent Node
Node/Admin Agent Windows Service	Windows Service for a Nodeagent or an Adminagent
WAS Server Windows Service	Windows Service for a WebSphere Application Server

Select a startup method.


	IMPORTANT: If your WebSphere Windows Service uses encoded parameters (for example, if you provided the ‑encodeParams option when the service was created, or if you ran the ‑encodeParams <service_name> command sometime after service creation) you cannot use the integration method described here. Instead, use the instructions in Manual integration with IBM WebSphere Application Server .

Click Next.

On the Integration Details page, provide the details required for integrating with your WebSphere server, including command-line options.

Type or select the information that your integration type requires. Use the following table to determine what information is needed.

Table 4. Startup Method integration details.
Startup Method	Integration Details Required
Deployment Manager Scripts	Profile Path WebSphere Home
Node Scripts	Profile Path WebSphere Home
Deployment Manager Windows Service	Profile Path Service Name WebSphere Home
Standalone Server Scripts	Profile Path WebSphere Home
Admin Agent Scripts	Admin Agent Profile Path WebSphere Home
Node/Admin Agent Windows Service	Profile Path Service Name WebSphere Home
WAS Server Windows Service	Profile Path Service Name WebSphere Home

The Profile Path is the absolute file system path to a WebSphere Profile.

The Admin Agent Profile Path is the absolute file system path to a WebSphere Admin Agent Profile.

WebSphere Home is the absolute file system path to the root of a WebSphere Installation.

Optional — If your application server uses startup scripts with customized names, click the arrow beside Other Options to open a list of script paths and names. Type the custom names in the appropriate boxes.


	NOTE: Always use forward slashes to separate directory names, regardless of whether the application server is running on Windows or UNIX.

Optional — Click the arrow beside Command Line Options to show the agent and pre-instrumentor option boxes. Use these boxes to provide command-line parameters for the agent or pre-instrumentor.

•

To add agent options, type them in the Agent Options box.


	NOTE: If you need to add more than one option to the Agent Options, separate them with spaces. Do not use quotes.

•

To add pre-instrumentation options, type them in the pre-instrumentor Options box.

To set pre-instrumentor options specific to the JVM you are running, type the desired VM options in the pre-instrumentor Options box.

For example, to set the memory limit for the pre-instrumentor to 256MB, type the following: ‑Xmx256m


	NOTE: If you need to add more than one option to the pre-instrumentor Options, separate them with spaces. Do not use quotes.

For more information, see Configuring Java Homes pre-instrumentation.

Click Next.

On the Nexus Connection page, select or create the connection that the agent should use to locate and communicate with a Nexus.


	TIP: For more information about the Nexus, see Nexus and Agent-Nexus connections .

If you are using the default Nexus on the embedded Agent Manager, or if you have created a single remote Nexus, a default Nexus Connection is created and pre-selected for you.

Otherwise, select or define at least one Nexus connection. For more information, see Creating or editing Agent-Nexus connection settings.

Click Next.

On the Logging page, select or create a logging configuration to control how logs are written, including retention policies and rollovers.

•

Select an existing log configuration from the list. The default log provides a basic log configuration that you can use to get started.

•

Click New log configuration. The New Log Configuration dialog box opens.


	TIP: If you are uncertain about how to adjust these settings, click Help for an overview of log targets and their purposes. For details, see Creating or editing logging properties .

Click Next.

On the Integration Hosts page, select the monitored host where WebSphere is installed. By default, only eligible hosts (that is, hosts that have an active Foglight Agent Manager of a compatible version installed and running) are listed.

Select the host and click Next.

On the Agent Configuration page, select the configuration that the agent will use. This agent configuration defines the requests to monitor and collect details.


	TIP: You can create agent configurations or edit existing ones from the Java Administration dashboard. For more information, see Managing Java EE Agent Configurations.

Select a configuration and click Next.

On the Installation Directory page, define the location for the directory that contains all installation components and log files.

•

To accept the default directory, leave the Directory name box blank.


	NOTE: If you have previously configured the host for agent installation, the existing installation directory is used.

To specify a custom directory, type a path in the Directory name box.

Click Next.

On the Review page, verify the details of the integration.

By default, the instrumentation script is assigned a name based on the integration type. For example: WebSphere on Windows: StandaloneServerScripts.

If you want to customize this name, type the new value in the Name box.

Click Finish.

The Application Servers Administration dashboard refreshes, and the integration task appears in the Task History list, where you can monitor its progress.

Restart your application server.

The agent starts collecting data after the application server has restarted and the agent is successfully integrated. Use the Application Servers Monitor dashboard to view the application servers status. For more information about the Application Servers Monitor dashboard, see the Foglight for Application Servers User Guide.

Integrating with WebSphere Liberty

You can use the Java EE Integration Agent to integrate the Java EE agent with an IBM® WebSphere® Liberty on Windows and Linux.

To integrate with WebSphere Liberty on Linux® or on Windows®:

Create a Generic installation only integration on Linux or Windows. For more information, see Creating a Generic Installation for Manual Java EE Agent Integration.

•

New Integration - Type: Select Generic installation only on Solaris, Linux, HP-UX, or AIX for Linux, or select Generic installation only on Windows for Windows.

•

New Integration - Details: Type your Java Installation directory in the Java Home field.

After the generic installation is complete, create a new file named jvm.options under the <Liberty Home>/usr/servers/<Server Name> directory.

Open the new jvm.options in a text editor, and then add the following contents.

-Dquest.agent.appserverinfo=<Server Name>:Generic:<Liberty Version>:<System Name>

-Xbootclasspath/p:<Bootstrap jar path>/<Bootstrap jar name>.jar

-javaagent:<Performasure agent jar path>/performasure-agent.jar

-Dquest.integrationid=<Integration ID>


	IMPORTANT: During the integration, change the variables inside “<>” to the actual values used in your environment. IMPORTANT: If the JDK version or any instrument configuration has been changed, make sure to redo the integration to generate a new bootstrap JAR.


	NOTE: The value of quest.integrationid is generated during the agent setup, and this value is a part of bootclasspath. For example, if the bootclasspath is "/opt/quest/foglightagentmanager/agents/JavaEE/5.9.10-20161219-1320/bootstrap/rVbXsTY9XOGObZR/-usr-java-jdk1.8.0_111.jar", then the value of quest.integrationid will be "rVbXsTY9XOGObZR".

See the following samples for reference.

•

Linux: Assume Liberty is installed under “/opt/IBM/wlp-webProfile7”, Java EE agent directory is “/opt/quest/foglightagentmanager/agents/JavaEE/5.9.10-20161219-1320”, and the Liberty server to be monitored is “JDBCSample”. Then add the following contents into jvm.options under “/opt/IBM/wlp-webProfile7/usr/servers/JDBCSample/”.

•

Windows: Assume Liberty is installed under “C:\IBM\wlp-webProfile7-java8-win-x86_64-16.0.0.2”, Java EE agent directory is “C:\Quest\foglightagentmanager\agents\JavaEE\5.9.10-20161219-1320”, and the Liberty server to be monitored is “JDBCSample”. Then add the following contents into jvm.options under “C:\IBM\wlp-webProfile7-java8-win-x86_64-16.0.0.2\usr\servers\JDBCSample\”.

Save jvm.options.

Execute the following command to start WebSphere Liberty using the <Server Name>.

<Liberty Home>\bin>server run <Server Name>

You will get the following output in the Liberty console, which means the Java Agent integration with Liberty is complete.

Integrating with Oracle AS

In OracleAS 10g R3, the cluster name is implicitly set to default whether a server is running in a cluster or in a standalone environment. However, the Java EE agent can only detect a cluster if the cluster name is explicitly set to something other than default.

In Oracle 10g R3, you can set the cluster name in the file <oracle_home>/opmn/conf/opmn.xml by adding the cluster-name attribute to the ias-instance tag for each server in the cluster and setting this attribute to the desired value. For example: <ias-instance id="ID" name="name" cluster-name="mycluster1">. You must add the cluster-name attribute and set it to the same value for each application server in your cluster.

Use the following procedure to integrate the Java EE agent with an Oracle Application Server version 10g R3 (v10.1.3.[0-5]).


	IMPORTANT: The instructions in this procedure assume that no more than two JDKs (1.4, 1.5, or 1.6) are in use simultaneously.

To configure Oracle Application Server 10g R2 or 10g R3:

Create a Generic installation only integration on the host, with the JAVA_HOME specified for pre-instrumentation. For more information, see Creating a Generic Installation for Manual Java EE Agent Integration.

After the generic installation is complete, a new file appears in the following directory on the machine where you ran the pre-instrumentation.

Windows: <VERSIONED_SUBDIRECTORY>\bootstrap\<INTEGRATIONID>

Unix: <VERSIONED_SUBDIRECTORY>/bootstrap/<INTEGRATIONID>

You can find the <INTEGRATIONID> in the file created by the Java EE Integration Agent in step 1.


	TIP: Make a backup copy of your original <oracle_home>/opmn/conf/opmn.xml file before completing the next step.

Open <oracle_home>/opmn/conf/opmn.xml in a text editor.

Add the following environment variable definitions at the <ias-instance> level.

Code Block:

<process-manager>

<ias-instance id="xyz" name="xys" cluster-name="XYZ">

<variable id="PERFORMASURE_JDK15_OPTIONS" value="-Dquest.debug=0 -Dquest.integrationid=$JDK15_INTEGRATIONID -Xbootclasspath^/p:$PERFORMASURE_HOME/bootstrap/$JDK15_INTEGRATIONID/<oracle_jdk15_bootstrap_jar> -javaagent:$PERFORMASURE_HOME/lib/performasure-agent.jar=oracle"/>


	TIP: Forward and backward slashes (“/”, “\”) in opmn.xml-environment-variable-values are automatically converted to the platform-specific path-separator character, unless preceded by a caret (^). The new environment variables can therefore work on both Windows and Unix platforms without requiring any modifications to the slash direction.

If you are using JDK 1.4:

•

Omit the definition of JDK15_INTEGRATIONID and PERFORMASURE_JDK15_OPTIONS.

•

Replace <oracle_jdk14_bootstrap_jar> with the file name of the bootstrap JAR file created in the <VERSIONED_SUBDIRECTORY>/bootstrap/<INTEGRATIONID> directory by the pre-instrumentation task in step 1, for your JDK 1.4 installation (for example, C--AppServers-oracle-10gR2_10.1.2-jdk.jar).

If you are using JDK 1.5 or 1.6:

•

Omit the definition of JDK14_INTEGRATIONID and PERFORMASURE_JDK14_OPTIONS.

•

Replace <JDK15_INTEGRATIONID> with the name of the directory created in step 1 by the pre-instrumentation task for your 1.5 JDK.

•

Replace <oracle_jdk15_bootstrap_jar> with the file name of the bootstrap JAR file created in the <VERSIONED_SUBDIRECTORY>/bootstrap/<INTEGRATIONID> directory by the pre-instrumentation task in step 1, for your JDK 1.5 or 1.6 installation (for example, C--AppServers-oracle-10gR3_10.1.3-jdk.jar).

Replace <VERSIONED_SUBDIRECTORY> with the path to the Java EE agent installation directory created in step 1.


	NOTE: The " characters surrounding <VERSIONED_SUBDIRECTORY> are required to enable the use of spaces in the value. Do not remove them.


	IMPORTANT: If you are integrating the Java EE agent with OracleAS 10g R2 or 10g R3 in a clustered environment and you have two or more OC4J server instances with the same name, ensure that the id attribute of the process-set tag for each OC4J instance is unique within the cluster.

Append the $PERFORMASURE_JDK14_OPTIONS or $PERFORMASURE_JDK15_OPTIONS, according to the version of the JDK you are using, to the value attribute of the java-options tag that is enclosed in the start-parameters tag for each OC4J component that you want instrumented. Employ the JDK version that was used for that OC4J instance.

Example Modifications When Using JDK 1.4:

Example Modifications When Using JDK 1.5 or JDK 1.6:

Save opmn.xml.

If opmn is running, you must reload the modified opmn.xml file by launching opmnctl reload. If opmn is not running, start it now.

Stop and restart each OC4J process that was modified in step 5d.

The Oracle application servers 10g R3 is now instrumented and ready to connect to the Management Server.

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Foglight for Java EE Technologies 5.9.13 - Installation Guide

Setting the PMI levels on WebSphere

Integrating with WebSphere startup scripts

Integrating with WebSphere Liberty

Integrating with Oracle AS