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

Creating WebSphere services

If you are starting your servers, Node agents, or WebSphere® Deployment Managers as a service, create a Windows® Service to use the Java EE agent instrumentation. See the IBM® documentation for instructions on creating and installing a Windows Service with the WASService.exe tool. You can keep your old Windows Service, but ensure that only one service for a particular WebSphere server, Node agent, or WebSphere Deployment Manager has a startup type of Automatic. All others should be set to Manual or Disabled.

When creating a Windows Service to integrate with the Java EE agent, provide an extra argument to the -startArgs option:

For WebSphere server use:

" -Dquest.agent.websphere.server"

For WebSphere Node agent use:

" -Dquest.agent.websphere.nodeagent"

For WebSphere Deployment Manager use:

" -Dquest.agent.websphere.dmgr"

* 
NOTE: Quotes are required. The space between the first quote and the dash is also required.

A caret (^) character is required at the end of a line (other than the last) to correctly wrap the DOS command on multiple lines. A space is a required before the caret character to ensure proper spacing when copying and pasting the following code blocks.
Examples:
WebSphere Server:

WAS_HOME\bin\WASService.exe -add "BASE server1 - with agent" ^
-servername server1 ^
-profilePath "C:\WebSphere\profiles\AppSrv01" ^
-startArgs " -Dquest.agent.websphere.server" ^
-startType automatic

WebSphere Node agent:

WAS_HOME\bin\WASService.exe -add "ND nodeagent - with agent" ^
-servername nodeagent ^
-profilePath "C:\WebSphere\profiles\AppSrv01" ^
-startArgs " -Dquest.agent.websphere.nodeagent" ^
-startType automatic

WebSphere Deployment Manager:

WAS_HOME\bin\WASService.exe -add "ND dmgr - with agent" ^
-servername dmgr ^
-profilePath "C:\WebSphere\profiles\Dmgr01" ^
-startArgs " -Dquest.agent.websphere.dmgr" ^
-startType automatic

Modifying the WebSphere startup scripts

Use the steps in this section to modify the WebSphere startup scripts.

* 
NOTE: The following procedures are not required if you are starting your servers, Node agent, or Deployment Manager using Windows services.
Before you begin

Review the following exceptions before you configure your server.

Exception list
•
If you want to set pre-instrumentor options specific to the JVM you are running:
Set the environment variable QUEST_PREINST_OPTS with the desired VM options. The environment variable QUEST_PREINST_OPTS is passed to the Java EE agent pre-instrumentor script.
For example, to set the memory used for the pre-instrumentor to 256MB, specify the following:
Windows:
QUEST_PREINST_OPTS=-Xms256m -Xmx256m
Unix:
QUEST_PREINST_OPTS=”-Xms256m -Xmx256m”
Modifying WebSphere startup scripts

Complete the following steps to modify a WebSphere startup script.

To modify the WebSphere startup scripts:
1
Locate your profile-specific startServer, startNode, or startManager script. Save a backup copy before continuing.
2
Open your profile-specific startServer, startNode, or startManager script. Before the call to the WebSphere Installation startServer, startNode, or startManager script, add the following environment variable as appropriate:
Windows:
a
In startServer add:
set QUEST_JAVA_ENV_OPTS=WEBSPHERE:SERVER
b
In startNode add:
set QUEST_JAVA_ENV_OPTS=WEBSPHERE:NODEAGENT
c
In startManager add:
set QUEST_JAVA_ENV_OPTS=WEBSPHERE:DMGR
Unix:
a
In startServer add:
QUEST_JAVA_ENV_OPTS=WEBSPHERE:SERVER
export QUEST_JAVA_ENV_OPTS
b
In startNode add:
QUEST_JAVA_ENV_OPTS=WEBSPHERE:NODEAGENT
export QUEST_JAVA_ENV_OPTS
c
In startManager add:
QUEST_JAVA_ENV_OPTS=WEBSPHERE:DMGR
export QUEST_JAVA_ENV_OPTS
3
Restart your application server. See, Restarting modified WebSphere servers.

Restarting modified WebSphere servers

After you have modified the startup script, restart the WebSphere® server.

To start the WebSphere modified server:
1
If it is not already running, start the Foglight Management Server.
2
Stop and restart the WebSphere server using the instructions for the server type you modified:
•
If you are using a standalone WebSphere server, stop the server and restart it with the modified script or the new Windows Service.
•
When starting WebSphere 8.x/9.0.0.x servers managed by a WebSphere Deployment Manager, stop the WebSphere node agent and restart the node agent with the modified script or with the new Windows Service. Restart any managed WebSphere Application Server instances after restarting the modified WebSphere node agent.
•
When starting a standalone WebSphere 8.x/9.0.0.x Server managed by a WebSphere Admin Agent, stop the WebSphere Admin Agent and restart the Admin Agent with the modified script or with the new Windows Service. Restart any managed WebSphere Application Server instances after restarting the modified WebSphere Admin 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 Foglight for Java EE Technologies, 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.
* 
CAUTION: Foglight starts a Java EE agent for each instrumented server. When the Java EE agent connects to the Management Server, the log file for the Java EE agent contains an INFO message stating that it has connected to the Nexus which is deployed on the Management Server. For example: INFO [Multiplexer: 0] com.quest.pas.agent.nexus.PsychoNexusStalker - Connected to Nexus at APMFoglightServer:41705.

 

Appendix A: Java EE Application Methods

Appendix A: Java EE Application Methods

This appendix provides information on methods collected for the Full detail instrumentation level and Component detail instrumentation level.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating