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 Spring Boot for Embedded Tomcat

You can use the Java EE Integration Agent to prepare the artifacts for the embedded Tomcat, to integrate the Java EE agent with Spring Boot startup scripts on Windows and Linux.

Prerequisites:
•
Spring Boot version 1.4.1, version 1.5.2, or version 2.0.0 must be installed in your environment.
•
Foglight for Java EE Technologies version 5.9.11 must be installed in your environment.
To integrate with Spring Boot on Linux® or on Windows®:
1
Create a Generic installation only integration on Linux or Windows. For more information, see Creating a Generic Installation for Manual Java EE Agent Integration.
•
New Integration - Type: Select Generic installation only on Solaris, Linux, HP-UX, or AIX for Linux, or select Generic installation only on Windows for Windows.
•
New Integration - Details: Type the same Java installation directory to run your Spring Boot application in the Java Home field.
2
Follow the wizard to complete the generic installation.
3
After the generic installation is complete, you can update either startup scripts or the command line tool to launch your Spring Boot application.
Consider for example you are using the java -jar example-application.jar command to launch your Spring Boot application. Update the original command to the following:
* 
IMPORTANT: During the integration, change the variables inside “<>” to the actual values used in your environment.
IMPORTANT: If the JDK version or any instrument configuration has been changed, make sure to redo the integration to generate a new bootstrap JAR.
 
* 
NOTE: The value of <Integration ID> is generated during the agent setup. In other words, the <Integration ID> is the value of the QUEST_INTEGRATIONID property in the integration file (either .sh or .cmd file) that is generated after the generic installation and located under the <FGLAM_HOME>\agents\JavaEE\ folder.
See the following samples for reference.
•
Linux: Assume the Java EE agent directory is “/opt/quest/foglightagentmanager/agents/JavaEE/5.9.11-20170410-1146”, the “QUEST_INTEGRATIONID” value is “8tKWIAFGo9xd82p”, and the target Spring Boot application jar is “example-application.jar”. Then update the original command to the following:
•
Windows: Assume the Java EE agent directory is “C:\Quest\foglightagentmanager\agents\JavaEE\5.9.11-20170410-1146”, the “QUEST_INTEGRATIONID” value is “8tKWIAFGo9xd82p”, and the target Spring Boot application jar is “example-application.jar”. Then update the original command to the following:

 

Creating a Generic Installation for Manual Java EE Agent Integration

Use this Generic installation only option in the Java agent setup wizard to create and deploy a Java EE Integration Agent to a host without a Java EE agent integration. This option is useful in situations where you need to create an installation directory and configure pre-instrumentation in preparation for manually integrating an agent.

Configuring Java Homes pre-instrumentation

Part of an application server’s integration with the Java EE agent includes a step known as pre-instrumentation. Pre-instrumentation prepares a special bootstrap jar file required for the operation of the Java EE agent. Many application server startup routines include the pre-instrumentation step as part of the integration with the Java EE agent, but some startup routines do not. In these cases (such as, WebLogic® Windows® Services, and Oracle® Application Server), pre-instrumentation must be run as a separate step from application server startup. Create a Generic installation only that includes a value for the JAVA_HOME option for each JDK used in your application server environment. This task creates the initial bootstrap jar, which may be referenced in your integrations, and it can also be used to update the bootstrap jar from time to time, as needed. The Java EE Integration Agent can be configured to complete this extra step as part of its activation routine.

To create a generic installation and pre-instrument:
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.
4
On the Setup Options page of the Java — Setup New Application Server Integration wizard, select Setup a new application server integration.
Click Next.
5
On the New Integration — Type page, select either Generic installation only on Windows or Generic installation only on Solaris, Linux, HP-UX, or AIX.
Click Next.
6
For Oracle AS only: On the New Integration — Details page, specify any agent or pre-instrumentor options that are required for integration.
* 
IMPORTANT: These settings are not applied to any integrations except Oracle AS. Other application servers ignore any values input here.
a
Click the arrow beside Command Line Options to show 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.
b
Click the down arrow beside Other Options to show the Java Home box.
If you specify a value for Java Home, the Java EE Integration Agent instruments Java Home and creates a bootstrap jar file. If you leave the Java Home box blank, the instrumentation script is created but the bootstrap jar is not. You can use the generated instrumentation script at any time to create or recreate the bootstrap jar.
For more information about pre-instrumentation, see Configuring Java Homes pre-instrumentation .
c
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 that you want to integrate with. 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. 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: Generic installation only on Windows: Install Configs and pre-instrument.
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 installation task appears in the Task History list, where you can monitor its progress. Wait for the Result column status to change to Success.

Next step:
•
Edit your application server startup script as necessary. For more information, see Manually Integrating Application Server.

 

Managing Java EE Agent Installations, Integrations, and Configurations

The Java Administration dashboard provides a centralized location for managing agent integrations, configurations, and installations. This dashboard is sub-divided into three tabs, each of which focuses on one aspect of agent management.

To access the Java Administration dashboard:
1
On the navigation panel, under Dashboards, click Application Servers > Administration.
2
On the Application Servers Administration dashboard, click the Java tab.

Next steps:

•
To learn more about agent monitoring configurations, including how to specify custom instrumentation settings, see Managing Java EE Agent Configurations .
•
To learn more about activating and deactivating the Java EE Integration Agent, viewing integration log files, or upgrading installations, see Managing Java EE Installation .
•
To learn more about integration configurations or the Nexus, or to learn how to manage Nexus connections, integrations, or logging information, see the following topics:
•
Managing agent integrations
•
Nexus and Agent-Nexus connections
•
Updating integration configuration properties
•
Java EE agent logging properties
•
Reintegrating existing targets
•
Deleting and undoing an integration
•
Reusing an integration configuration

Managing agent integrations

The Java EE Integration Agent creates and manages the integration between the Java EE agent and the monitored application server. The integration agent uses an integration configuration that consists of several key pieces of information: the startup method, pre-instrumentation options, the instrumentation settings for recording data, and the Agent Manager host. You can create or edit Nexus connections and logging configurations for a particular integration, or review the integration information. All these tasks are performed through the Java Administration dashboard, Integration Configurations tab.

To access the Java Administration dashboard:
1
On the navigation panel, under Dashboards, click Application Servers > Administration.
2
On the Application Servers Administration dashboard, click the Java tab.
3
Click the Integration Configurations tab.
From here you can review configured integrations, and manage Nexus connections and logging settings.
Related topics
•
Reviewing completed integrations
•
Updating integration configuration properties
•
Java EE agent logging properties
•
Reintegrating existing targets
•
Reusing an integration configuration
•
Nexus and Agent-Nexus connections
•
Java EE agent logging properties
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating