Foglight for Java EE Technologies 5.9.11

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.

Integrating with Spring Boot for Embedded Tomcat

You can use the Java EE Integration Agent to prepare the artifacts for the embedded Tomcat, to integrate the Java EE agent with Spring Boot startup scripts on Windows and Linux.

Prerequisites:

•

Spring Boot version 1.4.1, version 1.5.2, or version 2.0.0 must be installed in your environment.

•

Foglight for Java EE Technologies version 5.9.11 must be installed in your environment.

To integrate with Spring Boot 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 the same Java installation directory to run your Spring Boot application in the Java Home field.

Follow the wizard to complete the generic installation.

After the generic installation is complete, you can update either startup scripts or the command line tool to launch your Spring Boot application.

Consider for example you are using the java -jar example-application.jar command to launch your Spring Boot application. Update the original command to the following:


	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 <Integration ID> is generated during the agent setup. In other words, the <Integration ID> is the value of the QUEST_INTEGRATIONID property in the integration file (either .sh or .cmd file) that is generated after the generic installation and located under the <FGLAM_HOME>\agents\JavaEE\ folder.

See the following samples for reference.

•

Linux: Assume the Java EE agent directory is “/opt/quest/foglightagentmanager/agents/JavaEE/5.9.11-20170410-1146”, the “QUEST_INTEGRATIONID” value is “8tKWIAFGo9xd82p”, and the target Spring Boot application jar is “example-application.jar”. Then update the original command to the following:

•

Windows: Assume the Java EE agent directory is “C:\Quest\foglightagentmanager\agents\JavaEE\5.9.11-20170410-1146”, the “QUEST_INTEGRATIONID” value is “8tKWIAFGo9xd82p”, and the target Spring Boot application jar is “example-application.jar”. Then update the original command to the following:

Creating a Generic Installation for Manual Java EE Agent Integration

Use this Generic installation only option in the Java agent setup wizard to create and deploy a Java EE Integration Agent to a host without a Java EE agent integration. This option is useful in situations where you need to create an installation directory and configure pre-instrumentation in preparation for manually integrating an agent.

Configuring Java Homes pre-instrumentation

Part of an application server’s integration with the Java EE agent includes a step known as pre-instrumentation. Pre-instrumentation prepares a special bootstrap jar file required for the operation of the Java EE agent. Many application server startup routines include the pre-instrumentation step as part of the integration with the Java EE agent, but some startup routines do not. In these cases (such as, WebLogic® Windows® Services, and Oracle® Application Server), pre-instrumentation must be run as a separate step from application server startup. Create a Generic installation only that includes a value for the JAVA_HOME option for each JDK used in your application server environment. This task creates the initial bootstrap jar, which may be referenced in your integrations, and it can also be used to update the bootstrap jar from time to time, as needed. The Java EE Integration Agent can be configured to complete this extra step as part of its activation routine.

To create a generic installation and pre-instrument:

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.

On the Setup Options page of the Java — Setup New Application Server Integration wizard, select Setup a new application server integration.

Click Next.

On the New Integration — Type page, select either Generic installation only on Windows or Generic installation only on Solaris, Linux, HP-UX, or AIX.

Click Next.

For Oracle AS only: On the New Integration — Details page, specify any agent or pre-instrumentor options that are required for integration.


	IMPORTANT: These settings are not applied to any integrations except Oracle AS. Other application servers ignore any values input here.

Click the arrow beside Command Line Options to show 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.

Click the down arrow beside Other Options to show the Java Home box.

If you specify a value for Java Home, the Java EE Integration Agent instruments Java Home and creates a bootstrap jar file. If you leave the Java Home box blank, the instrumentation script is created but the bootstrap jar is not. You can use the generated instrumentation script at any time to create or recreate the bootstrap jar.

For more information about pre-instrumentation, 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 host that you want to integrate with. 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 one or more hosts 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 empty.