Chat now with support
Chat with Support

Foglight for Java EE Technologies 5.9.11 - 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 Apache Tomcat

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.

Before you begin

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.

 
* 
IMPORTANT: If you are using one of the following configurations, you are required to integrate manually. Extra steps are required.
•
On 32-bit or 64-bit Windows: Startup mode is set to Java and you have not specified a Java home using the JavaHome command line option.
•
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 .
•
Best Practices: We recommend that you explicitly set the Java home or the Java Virtual Machine when setting up a Tomcat application server that is running as a Windows Service. This prevents the Tomcat server from running with an unexpected JRE and makes the integration easier.
Integrating with Tomcat
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.
2
On the Application Servers Administration dashboard, in the Monitoring Agents section, click Setup agents...
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).
 
* 
TIP: For other integration methods, Reusing an integration configuration .
5
On the New Integration — Type page, select the type of Java application server you want to integrate with. In this case, select Tomcat on Solaris, Linux, HP-UX, or AIX, or Tomcat on Windows.
a
The wizard refreshes, providing the option to select the Tomcat application server startup method.
Select Catalina Scripts to integrate with Tomcat catalina.sh or catalina.bat startup scripts.
Or
Select Windows Service to instrument Tomcat (procrun) Windows Services.
 
* 
NOTE: If for any reason you need to integrate manually see Manual integration with Tomcat .
b
Click Next.
6
On the New Integration — Details page, provide the details required for integrating with your Tomcat server, including command-line options.
a
Type or select the absolute path to the Catalina startup script in the Catalina Home box.
Or
Type the Windows Service name in the Service Name box.
 
* 
IMPORTANT: You must have a Windows Service defined to proceed with this type of integration. If you do not yet have a Windows Service defined, first install your Tomcat server to run as a Windows Service.
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.
 
* 
NOTE: Always use forward slashes to separate directory names, regardless of whether the application server is running on Windows or UNIX.
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.
•
To add agent options, type them in the Agent Options box.
 
* 
TIP: 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 that 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.
 
* 
TIP: For information about pre-instrumentation, see Configuring Java Homes pre-instrumentation .
d
Click Next.
7
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.
8
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.
Or
•
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.
9
On the Integration Hosts page, select the host where Tomcat 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.
10
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.
11
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.
 
* 
IMPORTANT: 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.
12
On the Review page, verify the details of the integration.
a
By default, the instrumentation script is assigned a name based on the integration type. For example: Tomcat on Windows: CatalinaScripts.
If you want to customize this name, type the new value in the Name box.
b
Click Finish.
The Application Servers Administration dashboard refreshes, and the integration task appears in the Task History list, where you can monitor its progress.
13
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 WebLogic Domain Startup Scripts

You can use the Java EE Integration Agent to integrate the Java EE agent with WebLogic® domain startup scripts. Supply a description and the domain home path for the application server with which you want to integrate. If you are integrating with WebLogic running as a Windows® Service, specify the name of the Windows Service.

Prerequisite:
•
You must have a Windows Service defined before attempting an integration with WebLogic running as a Windows Service.
 
 
* 
IMPORTANT: If you are integrating with WebLogic 8.1.x, you cannot use the Integration Wizard described in this section. Instead, you must manually integrate. For detailed information, see Creating a Generic Installation for Manual Java EE Agent Integration .
To integrate with WebLogic on Solaris®, Linux®, HP-UX®, or AIX®, or on Windows®
1
On the navigation panel, under Dashboards, click Application Servers > Administration.
2
On the Application Servers Administration dashboard, in the Monitoring Agents section, click Setup agents...
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 Setup a new application server integration (the default selection).
* 
TIP: For other integration methods, see Reusing an integration configuration .
5
On the New Integration — Type page, select the type of Java application server you want to integrate with. In this case, select WebLogic on Solaris, Linux, HP-UX, or AIX, or WebLogic on Windows.
a
The wizard refreshes, providing the option to select the WebLogic application server startup method:
 
Table 2. Integration types
Integration Type
Description

Windows Service

Integrates a WebLogic Server or NodeManager Windows Service.

Domain Startup Script

Integrates the startWebLogic.sh/.cmd scripts within a WebLogic Domain (DOMAIN_HOME/bin/startWebLogic).

NodeManager Startup Script

Integrates the startNodeManager.sh/.cmd scripts within a WebLogic installation (WL_HOME/server/bin/startNodeManager).

NOTE: By default, all servers managed by the Node Manager are instrumented.

Managed Server Startup Script

Integrates the startManagedWebLogic.sh/.cmd scripts within a WebLogic 12.1.1 or earlier installation (WL_HOME/common/bin/startManagedWebLogic).

Non-Domain startWLS Startup Script

Integrates the startWLS script within a WebLogic 10.0 or earlier installation (WL_HOME/server/bin/startWLS).

All Non-Domain Scripts

Combines the NodeManager, Managed Server, and startWLS Startup Script tasks into a single integration.

b
Select a startup method.
c
Click Next.
6
On the New Integration — Details page, provide the details required for integrating with your WebLogic server, including command-line options.
a
For most WebLogic integrations, type or select the absolute path to the WebLogic Home directory. WebLogic Home is the installation directory of a particular WebLogic version.
If you are integrating using startWebLogic as the startup method, type or select the absolute path to the Domain Home. Domain Home is the directory containing a WebLogic Domain.
If you are integrating with WebLogic as a Windows Service, type the name of the Windows service in the Service Name box.
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.
* 
NOTE: Always use forward slashes to separate directory names, regardless of whether the application server is running on Windows or UNIX.
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.
•
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.
* 
TIP: For information about pre-instrumentation, see Creating a Generic Installation for Manual Java EE Agent Integration .
d
Click Next.
7
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.
8
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.
9
On the Integration Hosts page, select the host where WebLogic 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 one or more hosts and click Next.
10
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.
11
On the Installation Directory page, define the location for the directory that contains all installation components and log files.
a
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.
b
Click Next.
12
On the Review page, verify the details of the integration.
a
By default, the instrumentation script is assigned a name based on the integration type. For example: WebLogic on Windows: startWebLogic.
If you want to customize this name, type the new value in the Name box.
b
Click Finish.
The Application Servers Administration dashboard refreshes, and the integration task appears in the Task History list, where you can monitor its progress.
13
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

Before you begin remote agent integration with an IBM® WebSphere® application server, first review the following sections:

•
Understanding what should be instrumented
•
Setting the PMI levels on WebSphere
•
Running WebSphere with security enabled

Next, follow the procedure in Integrating with WebSphere startup scripts , as appropriate for your system.

Understanding what should be instrumented

The following guidelines identify the components in a WebSphere® domain that require instrumentation to ensure that the Nexus can do a full data collection.

For standalone servers:

•
Each standalone server process must be integrated and running.
•
To collect WebSphere metrics on the average size of an HTTP session, enable Average Size (b) Current in the Show columns list and then restart your WebSphere application server using the
-Dquest.configfilter.httpsessionsize=true command. For more information about show and hide columns, see the Foglight for Application Servers User Guide.
•
WebSphere standalone servers must be integrated by their server startup scripts, or by individual Windows® server processes.
* 
NOTE: Standalone servers started solely by an instrumented Admin agent do not need to be integrated individually. However, if a standalone server is started by other means (startup script, or Windows Service), then integrating using these methods is required.
•
WebSphere version 7.x/8.x/9.0.0.x standalone servers registered with a WebSphere 7.x/8.x/9.0.0.x Admin agent possess an extra integration option: integrating the Admin agent process instead of individual registered servers. Any standalone servers launched by an instrumented Admin agent are also instrumented. However, the Admin agent is not required for monitoring of any standalone servers it may have started, and it may be shut down once all startup activities have been completed. To manually integrate a WebSphere version 7.x/8.x/9.0.0.x Admin agent, see Manual integration with IBM WebSphere Application Server .

For WebSphere Servers federated in a WebSphere Cell:

•
The Domain Manager of each WebSphere Cell must be integrated for complete cell monitoring, and must remain running during the monitored period. Any interruption in the service of an instrumented domain manager results in incomplete Nexus data collection, and possible false alarms.
•
Each Node agent must be integrated with the agent, and must remain running during the monitored period. Any interruption in the service of an instrumented nodeagent results in incomplete data collection, and possible false alarms. Individual application servers started by an instrumented Node agent are instrumented automatically.
•
No integration is required for individual servers. Attempts to start an individual server using a startup script fail, as WebSphere requires you to send the start command by using the server’s node agent.
* 
CAUTION: For any server with a corresponding Windows service: Attempts to start a server by using a startup script may launch a Windows service instead. If the startup script is instrumented with the Java EE Integration Agent, then the resulting WebSphere process is instrumented as well. Otherwise, the integration properties of the Service are used. This release changes the behavior of services launched as a result of a start script invocation.
Related topics:
•
Running WebSphere with security enabled
•
Setting the PMI levels on WebSphere
•
Integrating with WebSphere startup scripts
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating