Oracle Cloud Infrastructure Documentation

Specify Proxy Arguments

You can specify proxy arguments in the java command when provisioning the APM Java agent, or you can do it at a later time by specifying values for the arguments in the AgentConfig.properties file in the <Destination Directory>/oracle-apm-agent/config directory, and restarting the application server.

Note that <Destination Directory> in the previous sentence is the directory in which the APM Java agent is provisioned.

Specify a Proxy Environment

If using a proxy server, you must specify the proxy environment details.

  • If you are provisioning the APM Java agent:

    Add -property=com.oracle.apm.agent.data.upload.proxy.url=http://<host>:<port> to the java command. Here's an example: 

    java -jar ./apm-java-agent-installer-<version>.jar provision-agent -service-name=apm_service -destination=$DOMAIN_HOME -private-data-key=IMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZD -data-upload-endpoint=https://dataUploadEndpoint.com -property=com.oracle.apm.agent.data.upload.proxy.url=http://proxy.example.com:80
  • If you have already provisioned the APM Java agent:

    Specify a value for the com.oracle.apm.agent.data.upload.proxy.url argument in the AgentConfig.properties file, and restart the application server.

  • If you are using Management Gateway:
    Configure the APM Java Agent with the following arguments to route all traffic of APM Java Agent or Tracer through the Management Gateway:
    com.oracle.apm.agent.data.upload.proxy.url=<Management Gateway URL>
com.oracle.apm.agent.data.upload.proxy.username=<User name for Proxy Server authentication>
com.oracle.apm.agent.data.upload.proxy.password=<Password for Proxy Server authentication>
com.oracle.apm.agent.data.upload.proxy.scheme=basic

    Management Gateway can be used to communicate to APM Agent. For information about installing and configuring Management Gateway, see Management Gateway.

If the proxy server needs authentication, then you must specify the authentication arguments in the -property=<key>=<value> format when provisioning the APM Java agent or update the AgentConfig.properties file if you've already provisioned the agent:

  • Specify the proxy user name and password in the following arguments:
    com.oracle.apm.agent.data.upload.proxy.username=<User name for proxy server authentication>
com.oracle.apm.agent.data.upload.proxy.password=<Password for proxy server authentication>

  • Default authentication scheme is digest.

    An additional argument can be set for basic authentication scheme:
    com.oracle.apm.agent.data.upload.proxy.scheme=basic