Chat now with support
Chat with Support

Foglight for Java EE Technologies 5.9.7.5 - Installation Guide

Installing and Configuring Foglight for Java EE Technologies Integrating with JBoss Integrating with Tomcat Integrating with WebLogic Domain Startup Scripts Integrating with WebSphere Integrating with Oracle AS 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 Installations Foglight for Java EE Integration Configuration FAQ and Troubleshooting Performing Manual Application Server Integrations Appendix: Managing Permissions for the Java EE Integration Agent Appendix: Foglight for Java EE Application Methods

About Java EE Integration Agent User Permissions

Foglight for Java EE Technologies consists of two separate agents, each of which require access to the file system and other resources.
•
The Java EE Integration Agent is executed by the same user that is running the Agent Manager process during agent activation.
•
The Java EE Agent is executed by the user running the integrated application server.
The required permissions can be supplied at any level appropriate to your organization or IT structure:
•
Owner/User Permissions — The Agent Manager and the Application Server must be executed by the same user. Usually n this case there is no need to set permissions explicitly.
•
Group Permissions — The Agent Manager user and the Application Server user belong to a common group.
•
Others Permission — The Agent Manager user is different from the Application Server user and these two users cannot be added to a common group. Because Others permissions include all other users, it is recommended that Owner or Group permissions be used whenever possible.
For more information, see Appendix B: Managing Permissions for the Java EE Integration Agent on page 97.

About the Installation Directory

The installation directory (DEPLOYMENT_DIRECTORY) is created during the Java EE Integration Agent activation. After the Java EE Integration Agent is activated, all future version updates of Foglight for Java EE Technologies use this directory to store sub-directories containing the latest Java agent libraries, configuration files, and log files. In addition, the installation directory contains the integrate scripts, integrate.cmd, and integrate.sh, that are used to configure your application servers.
The default value for this installation directory is JavaEE. This path is relative to the <FglAM_HOME>\agents\ directory created during the Foglight Agent Manager (FglAM) installation.
 
* 
NOTE: You can specify a custom location during installation. If you do not specify a fully qualified path, it is relative to the <FglAM_HOME>\agents directory.
 
* 
IMPORTANT: Do not use the JavaEE Installation directory anywhere in your application server startup scripts. This directory is used by the Java EE Integration Agent to maintain a copy of the original agent files/libraries.
For more information about managing installations, see Managing Java EE Agent Installations, Integrations, and Configurations .

Upgrading Java EE Agents and Integration Agents

The Foglight Upgrade Guide provides full instructions for upgrading to the latest version of the cartridge and agents. Read the section “Upgrading Foglight for Java EE Technologies” in the Upgrading the Application Monitoring Cartridges chapter for details.
Depending on the version you are upgrading from, you may also need to upgrade the Nexus. See the Foglight Upgrade Guide for details.
Configuration Migration During Upgrades
If you have modified the configuration files and you perform a minor version upgrade (for example from x.y.z to x.y.z+1), your modified files are preserved. The default contents of the configuration files from the new version are overwritten with your changes.
For example, you have version 5.9.3.2 currently installed and you have modified the Nexus recording.config and the Java EE agent instrumentation.config. Upgrading to version 5.9.4 would overwrite the default contents of the 5.9.4 versions of those files with your file contents from 5.9.3.2. All other 5.9.4 configuration files are unchanged, and contain the default contents installed by the 5.9.4 cartridge.
 
* 
NOTE: Configuration files managed through the Advanced dashboards (for example, nexus/aggregation.config or agent/java/collector/jboss.config) are not automatically migrated. If you have made any modifications to these files, they must be migrated manually, with the assistance of Customer Support where necessary.

In addition, the nexus/compatible-builds.config file is never automatically migrated. If you have any patch build IDs, these must be manually added to the new version’s compatible-builds.config with the assistance of Customer Support.
 
* 
IMPORTANT: No automatic migration occurs during an upgrade to the next major version (for example, from 5.9.x to 5.10.x).
 

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.
 
* 
IMPORTANT: Foglight for Java EE Technologies version 5.9.x is the last major release that supports JBoss AS 4.2 and 5.0, and JBoss EAP 4.3. Support for these versions of JBoss will be discontinued after this release.
For an overview of the installation and integration process, see Installing the Agents .
To integrate with JBoss on UNIX or Windows:
 
* 
IMPORTANT: Ensure that the target application server has an active Foglight Agent Manager of a compatible version installed and running.
1
On the navigation panel, under Dashboards, click Application Servers > Administration > 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, Reusing a Previous 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 either JBoss on Solaris, Linux, HP-UX, or AIX, or JBoss on Windows, as appropriate.
a
The wizard refreshes, indicating that it will use the JBoss Startup Scripts. This option integrates the JBoss run.bat or run.sh startup scripts.
b
Click Next.
6
On the New Integration — Details page, specify any additional information required to integrate with the application sever.
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.
 
* 
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.
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
 
* 
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, separated by spaces, in the pre-instrumentor Options box.
For example, to set the memory limit for the pre-instrumentor to 256 MB, 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 Understanding the 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, you must 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 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 monitored host where the JBoss application server 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 new 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 empty.
 
* 
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: JBoss on Windows: ServerRunScript. 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 Monitoring Application Servers User and Reference Guide.
•
If you are running JBoss with Jetty, see Running JBoss with Jetty .
•
If you want to collect JTA metrics for JBoss AS 4.2, see Enabling JTA Metrics for JBoss Application Server 4.2 .
•
If you are integrating with the Java Service Wrapper, see Integrating a Java Service Wrapper Windows Service with a Java EE Agent .
If for any reason you need to perform a manual integration, see JBoss Remote Agent Integration from the Command-line .
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating