Chat now with support
Chat with Support

Foglight for Java EE Technologies 5.9.13 - Installation Guide

Installing and Configuring Foglight for Java EE Technologies Integrating with JBoss Integrating with Apache Tomcat Integrating with WebLogic Domain Startup Scripts Integrating with WebSphere Integrating with WebSphere Liberty Integrating with Oracle AS Integrating with Spring Boot for Embedded Tomcat Creating a Generic Installation for Manual Java EE Agent Integration Managing Java EE Agent Installations, Integrations, and Configurations Managing Java EE Agent Configurations Managing Java EE Installation Java EE Integration Configuration FAQ and Troubleshooting Manually Integrating Application Server Appendix A: Java EE Application Methods AppendixB: Managing Permissions for the Java EE Integration Agent

Integrating with JBoss

You can use the application server agent setup wizard to configure and integrate the Java EE agent and the Java EE Integration Agent with JBoss® server startup scripts. You must supply the JBoss Home directory for one or more application servers with which you want to integrate. Optionally, you can also specify pre-instrumentation and agent options.

For an overview of the installation and integration process, see Installing the agents .

1
On the navigation panel, under Dashboards, click Application Servers > Administration.
4
On the Setup Options page, select the type of integration. This example describes how to Setup a new application server integration (the default selection).
b
Click Next.
a
Type or select the absolute path to the JBoss Home directory. This is the JBoss installation location on the remote file system.
b
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.
c
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.
For example, if the JBoss .jar files are located in a lib/endorsed directory, add the following option in the Agent Options box:
‑Dquest.agent.instrument.bootstrap=true
d
Click Next.
Click Next.
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.
Click Next.
a
By default, the instrumentation script is assigned a name based on the integration type. For example: JBoss on Windows: ServerRunScript. If you want to customize this name, type the new value in the Name box.
b
Click Finish.

Running JBoss with Jetty

Jetty is a pure Java-based HTTP server and servlet container (application server). If you are running JBoss® with Jetty, make the following changes to the property file agent_type_jboss-<version>.config before you start recording.

The following table lists the <version> names:

EAP 6

agent/java/plugins/jboss-eap-6.config

1
On the navigation panel, under Dashboards, click Application Servers > Administration.
3
On the Java view, click the Agent Configurations tab.
4
5
Select the version of the Java EE agent that you want to edit. Click Version x.x.x to open a list of compatible versions.
6
Click the name of the agent/java/plugins/jboss-<version>.config for the JBoss version you want to edit, and select Edit.
TIP: Click Show fully qualified names to see the directory location for the files. Type all or part of the filename in the Search box (for example, jboss-) to locate the file.
9
Click Save.

Integrating a Java Service Wrapper Windows Service with a Java EE agent

Foglight for Java EE Technologies supports the use of Windows Services configured using the Java Service Wrapper (JSW) application by Tanuki Software.

The JSW uses configuration files to control how your Java application is started and stopped as a Windows Service. To integrate the Java EE agent with your JSW, the JDK must be pre-instrumented (using the Java EE Integration Agent) and then the JSW configuration file needs to be manually modified to include Java EE agent configuration settings.

Windows®: <VERSIONED_SUBDIRECTORY>\bootstrap\<INTEGRATIONID>
UNIX®: <VERSIONED_SUBDIRECTORY>/bootstrap/<INTEGRATIONID>
You can find the <INTEGRATIONID> in the file that the Java EE Integration Agent creates in step 1.
3
Run the integration bat/sh file that was created by the manual installation.
#include <INSTALLATION DIRECTORY>\jee_builds.properties
a
Replace <INSTALLATION DIRECTORY> with the absolute path of the Installation Directory. The path can be found on the Installations tab of the Java Administration page (accessible from the Applications Servers Administration dashboard). If the Installation Directory path is specified as a relative path, as it is by default, you may need to examine the agent machine to determine the absolute path.
b
If set.JAVA_HOME is not specified earlier in the JSW configuration file, uncomment the second line in the code block above and set <JVMPath> to the absolute path for the JVM that the service uses.
For example: set.JAVA_HOME=C:\work\jvms\jdk1.5.0_12
c
Replace <INTEGRATIONID> with the value determined in step 2.
d
Replace <BOOTSTRAP .JAR FILENAME> with the filename of the bootstrap JAR file created in the <VERSIONED_SUBDIRECTORY>/bootstrap/<INTEGRATIONID> directory by the pre-instrumentation task in step 1.
and replace <N> with incremented numbers starting after your highest wrapper.java.additional number.

 

Integrating with Apache Tomcat

Use the application server agent setup wizard to configure and integrate the Java EE agent and the Java EE Integration Agent with Apache Tomcat Catalina startup scripts or with Tomcat running as a Windows® Service.

You must supply the Catalina Home directory or the Windows Service name for one or more application servers with which you want to integrate. Optionally, you can also specify pre-instrumentation options and agent options.

For most configurations of a Tomcat server running as a Windows Service, the Java EE Integration Agent automatically integrates the Java EE agent. Read the Important note below to determine if you are required to complete additional steps to integrate the Java EE agent with a Tomcat server running as a Windows Service.

If you are not required to perform the additional steps, complete the integration procedure (Integrating with Tomcat ), then restart your Tomcat application server. No other steps are required.

On 64-bit Windows: Startup mode is set to jvm and the Use Default check box is selected. If you are using one of these configurations, complete this procedure: Configuring a Tomcat Windows Service that requires manual integration .
To integrate with Tomcat on Solaris®, Linux®, HP-UX®, or AIX®, or on Windows®:
1
On the navigation panel, under Dashboards, click Application Servers > Administration.
3
In the menu that opens, select Java. The Java — Setup New Application Server Integration wizard opens.
4
On the Setup Options page, select the type of integration. This example describes how to Set up a new application server integration (the default selection).
Select Catalina Scripts to integrate with Tomcat catalina.sh or catalina.bat startup scripts.
Select Windows Service to instrument Tomcat (procrun) Windows Services.
b
Click Next.
b
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.
c
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.
d
Click Next.
Click Next.
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.
Click Next.
b
Click Finish.

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.

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating