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

Manual integration with WebLogic

Manual integration with WebLogic

This section contains instructions for integrating the Java EE agent with a WebLogic® Server. You must modify your WebLogic startup script by adding lines to set the variables that the Java EE agent requires.

Manually configuring WebLogic for integration

Use the steps in this section to manually configure a WebLogic® Server or a WebLogic Express Startup for integration with the Java EE agent.

To configure WebLogic server or WebLogic Express startup:
1
Make a backup copy of your WebLogic Server startup script before proceeding with the steps below.
2
Complete the Generic installation only on Windows, as described in Creating a Generic Installation for Manual Java EE Agent Integration .
3
Copy the following block of code to your WebLogic Server startup script. Insert the block just before the WebLogic startup line.
Windows®:
@rem set QUEST_PREINST_OPTS=* OPTIONAL pre-instrumentor Options *
set QUEST_DEPLOYMENT_DIRECTORY=* SET JavaEE Installation Directory *
set QUEST_JAVA_ENV_OPTS=WEBLOGIC:SERVER
call "%QUEST_DEPLOYMENT_DIRECTORY:"=%\<integrate.cmd>" || (
echo Java EE agent not enabled )
UNIX®:
QUEST_PREINST_OPTS=* OPTIONAL pre-instrumentor Options *
export QUEST_PREINST_OPTS
QUEST_DEPLOYMENT_DIRECTORY=* SET JavaEE Installation Directory *
if [ -f "$QUEST_DEPLOYMENT_DIRECTORY/<integrate.sh>" ]
then
QUEST_JAVA_ENV_OPTS=WEBLOGIC:SERVER
. "$QUEST_DEPLOYMENT_DIRECTORY/<integrate.sh>"
else
echo Java EE agent not enabled
fi
4
Set <integrate.cmd/sh> to the name of the integration task you created in step 2. For example: integrate-Generic_installation_only_on_Windows_Install_Configs_and_pre-instrument.cmd.
5
Set the QUEST_DEPLOYMENT_DIRECTORY variable to the Installation Directory specified by the Java EE Integration Agent instance activated on this host. This agent instance was created in step 2.
* 
IMPORTANT: In Unix, quote this path if it contains spaces.
6
Before saving this new startup script, ensure that your environment does not meet any of the exceptions listed at the beginning of this section, then save the new script.
7
If it is not already running, start the Management Server. The instrumented WebLogic Server attempts to connect to it when starting using the new script.
8
Restart the WebLogic Server using the new script.
The Management Server 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 Management Server. For example:
INFO [Multiplexer: 0] com.quest.pas.agent.nexus.PsychoNexusStalker - Connected to Nexus at APMFoglightServer:41705.

Manual integration with IBM WebSphere Application Server

Manual integration with IBM WebSphere Application Server
* 
IMPORTANT: Review the section Understanding what should be instrumented before you begin manually integrating WebSphere®.

This section contains instructions for integrating the Java EE agent with WebSphere Server. You either need to create Windows® services that start instrumented servers, Admin agents, Node agents, and WebSphere Deployment Managers; or modify the startup scripts.

If you want to instrument the servers that a Node agent starts, configure integration with the Node agent.

If you want to collect cell-wide configuration information and application server states, configure the integration with the WebSphere Deployment Manager.

Using Foglight for Java EE Technologies with your WebSphere servers requires three steps:

1
WebSphere environments .
2
Creating WebSphere services .
3
Modifying the WebSphere startup scripts .

Other topics include:

•
Running WebSphere with security enabled
•
Setting the PMI levels on WebSphere
* 
CAUTION: Before you attempt to integrate WebSphere, ensure that the Disable JIT check box is not selected on the Java Virtual Machine page in the WebSphere Administrative Console. Disabling the JIT drastically slows down the server’s startup and operation. Disabling metrics or changing metric sets while you are collecting data is not recommended. If you do so, Foglight may be unable to collect the necessary WebSphere metrics. In addition, if you disable metrics or change metric sets while data collection is in progress, Foglight cannot restore the original set of metrics that you configured.

WebSphere environments

WebSphere® are configured to use profiles. Therefore, configuration with the Java EE agent involves two steps. The first is to edit to the global setupCmdLine script. These changes only take effect if the environment variable QUEST_DEPLOYMENT_DIRECTORY has been set in your user profile setupCmdLine script. All other profiles ignore the code in the global setupCmdLine script.

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”
Configuring WebSphere environments

Complete the following steps to configure a WebSphere® environment.

To configure a WebSphere environment:
1
Make a backup copy of your original global setupCmdLine script (.bat or .sh).
By default, this script can be found in the <websphere_home>/bin/ directory.
2
Create a Generic Installation Only integration on the host. For more information, see Creating a Generic Installation for Manual Java EE Agent Integration.
3
Open the global setupCmdLine script in a text editor and make the following modifications:
•
Windows® Only — Add the following code to the end of the script:
if %1==-Dquest.agent.websphere.server set QUEST_JAVA_ENV_OPTS=WEBSPHERE:SERVER
if %1==-Dquest.agent.websphere.nodeagent set QUEST_JAVA_ENV_OPTS=WEBSPHERE:NODEAGENT
if %1==-Dquest.agent.websphere.dmgr set QUEST_JAVA_ENV_OPTS=WEBSPHERE:DMGR
Add the following code before the line goto :EOF:
if defined QUEST_DEPLOYMENT_DIRECTORY if defined QUEST_JAVA_ENV_OPTS (
call "%QUEST_DEPLOYMENT_DIRECTORY%\<integrate.cmd>"
if ERRORLEVEL 1 echo Java EE agent NOT enabled
)
•
UNIX® — Add the following code to the end of the script:
if [ -f "$QUEST_DEPLOYMENT_DIRECTORY/<integrate.sh>" -a -n "$QUEST_JAVA_ENV_OPTS" ];
then
. "$QUEST_DEPLOYMENT_DIRECTORY/<integrate.sh>"
else
echo Java EE agent is NOT enabled
fi
4
Set <integrate.cmd/sh> to the name of the integration task you created in step 2. For example: integrate-Generic_installation_only_on_Windows_Install_Configs_and_pre-instrument.cmd.
5
Save your modified setupCmdLine script file.
6
Locate your profile setupCmdLine script. The default installation places it in WAS_HOME/profiles/<profile_name>/bin. Set the QUEST_DEPLOYMENT_DIRECTORY at the end of the profile script to the Installation directory defined in step 2 to enable monitoring for that profile.
Windows:
rem Enable Java EE agent monitoring for this profile
set QUEST_DEPLOYMENT_DIRECTORY=* SET JavaEE Installation Directory *
Unix:
# Enable Java EE agent monitoring for this profile
QUEST_DEPLOYMENT_DIRECTORY=* SET JavaEE Installation Directory *
export QUEST_DEPLOYMENT_DIRECTORY
7
Save the changes to your profile-specific setupCmdLine script.
8
Restart your application server.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating