Oracle Cloud Infrastructure Documentation

Provision and Deploy APM Java Agent on Oracle E-Business Suite

The APM monitoring requires the deployment of the APM Java agent to capture what happens on the WebLogic server. In this case, this needs to happen on oacore and oafm WebLogic clusters.

Download the APM Java Agent

  1. Sign in to the Oracle Cloud Infrastructure console.
  2. Open the navigation menu, click Observability & Management. Under Application Performance Monitoring, click Administration.
  3. On the Administration page, click Download APM Agents from the left menu to open the Download APM Agents page.
  4. On the Download APM Agents page, select Java Agent to download the APM Java Agent.

    The APM Java agent software file is downloaded and it contains the apm-java-agent-installer-<version>.jar file.

Provision the APM Java Agent

  1. Connect to the host where the application server is installed, login as the same user who installed the application server and confirm that the application server user has read and write permissions to the directory where the APM Java agent file is downloaded. Copy the APM Java agent software file that you downloaded to any desired directory:
  2. Ensure that you are logged in as the user who installed the application server and navigate to the directory where you copied the APM Java agent software. Note that you must have read and write permissions to the directory that hosts the APM Java agent.
  3. Review the following mandatory arguments that must be specified to provision an APM Java agent.
    • -service-name: The name of the service being monitored. This argument enables you to filter by service and view traces in the Trace Explorer user interface. For EBS environment, use EBS_WLS as a temporary value. Later, you will override the configuration with specific values for each of the monitored WLS clusters.
    • -destination: The destination directory in which the APM Java agent will be provisioned. In this case, this should point to the EBS destination directory: <PATH_TO_fs_ne> which is the EBS full path for the non edition directory. For example: /u01/ebs122/fs_ne/ directory.
    • -private-data-key: The agent installation key used by APM Java agents (private datakey), which is generated when the APM domain is created.
    • -data-upload-endpoint: The dataUploadEndpoint URL that is generated when the APM domain is created.

      For more information on private datakey and dataUploadEndpoint, see Obtain Data Upload Endpoint and Data Keys.

    Optional:

    • You can specify additional arguments when provisioning the APM Java agent. For information, see Specify Proxy Arguments.

    • You can run the following command to view the help on provision-agent arguments:
      java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help
  4. Provision the agent by specifying the mandatory arguments described in the previous step and running the following java command:
    java -jar ./apm-java-agent-installer-<version>.jar provision-agent -service-name=EBS_WLS -destination=/u01/ebs122/fs_ne/ -private-data-key=<Agent installation key generated during APM domain creation> -data-upload-endpoint=<dataUploadEndpoint URL generated during APM domain creation>

    Here's an example:

    java -jar ./apm-java-agent-installer-1.1.jar provision-agent -service-name=apm_service -destination=$DOMAIN_HOME -private-data-key=IMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZD -data-upload-endpoint=https://dataUploadEndpoint.com
    On running the java command, if the APM Java agent is provisioned successfully:
    • The Action [provision-agent] completed successfully message is displayed.
    • The oracle-apm-agent directory is created in the destination directory. For example, /u01/ebs122/fs_ne/oracle-apm-agent.

      The oracle-apm-agent directory should contain the following:

      • bin: Contains the starter of the aggregator.
      • bootstrap: Contains the agent startup .jar files that will be used by the -javaagent command to deploy the APM Java agent.
      • config: Contains the global configuration files, which can be edited. This directory contains:
        • The AgentConfig.properties file, which contains APM Java agent configuration arguments.
        • The ProbeConfig.acml file, which contains the configuration information related to probes.
      • install: Contains the <release-version>/config directory, which has the APM Java agent binaries and default configuration files. Note that the files in this directory must not be changed.
      • version: The version file that has information regarding the APM Java agent release version and activation date.

    If the java command terminates and the APM Java agent is not provisioned successfully, then you can review the error details in the ApmAgentInstall.log file and the application server output log to correct the issue.

Note

For more details about downloading and provisioning the APM Java agent, see Provision and Deploy APM Java Agent on Application Servers.

Enable the APM Java Agent in the WebLogic Managed Server

To enable the access to Oracle E-Business Suite from Oracle Application Performance Monitoring, JVM configuration changes must be made to the WebLogic Managed Servers.

Perform the following steps on each of the managed servers of the oacore and oafm services:

  1. Log in to the WebLogic Server Administration Console as a user with admin security role. By default, it’s the user weblogic.
  2. Click Servers. The WebLogic Administration Server and Managed Servers summary page is displayed.
  3. Choose the WebLogic managed servers to deploy the APM Java agent on: oacore and oafm.
  4. A page containing various tabs for the settings of the managed server appears.

    Click Server Start tab.

  5. In the Change Center, click Lock and Edit. Update the Arguments field with the parameters required for Oracle Application Performance Monitoring. Ensure that the existing arguments are not altered.

    For oacore service, add the following: 

    -javaagent:<PATH_TO_fs_ne>/oracle-apm-agent/bootstrap/ApmAgent.jar -Dcom.oracle.apm.agent.service.name=oacore

    For oafm service, add the following: 

    -javaagent:<PATH_TO_fs_ne>/oracle-apm-agent/bootstrap/ApmAgent.jar -Dcom.oracle.apm.agent.service.name=oafm
  6. Click Save.
  7. In the Change Center, click Activate Changes to activate the changes.
  8. Repeat all the above steps for each of the managed servers of the oacore and oafm services until each managed server has the JVM arguments updated.
  9. Restart the managed servers using the script available at $ADMIN_SCRIPTS_HOME in the Oracle E-Business Suite environment for stopping and starting the managed servers.

Once you have successfully installed an APM Agent, you can enable End User Monitoring in an Oracle E-Business Suite environment by configuring browser agents with Reference injection type for APM Agents related to oacore managed servers.