Aprovisionamiento del agente Java de APM

Puede proceder a aprovisionar el software del agente de APM Java después de completar la descarga del agente de APM Java.

Lleve cabo los siguientes pasos:

  1. Conéctese al host donde está instalado el servidor de aplicaciones y copie el archivo de software del agenta Java de APM que ha descargado en cualquier ubicación de su preferencia.

    Asegúrese de conectarse como el mismo usuario que instaló el servidor de aplicaciones y de que el usuario del servidor de aplicaciones tenga permisos de lectura y escritura en el directorio en el que se descarga o se copia el agente Java de APM.

  2. Asegúrese de que se ha conectado como el usuario que instaló el servidor de aplicaciones y desplácese hasta el directorio donde ha descargado o copiado el software del agente Java de APM. Tenga en cuenta que debe tener permisos de lectura y escritura en el directorio que aloja el agente Java de APM.
  3. Revise los siguientes argumentos obligatorios que se deben especificar para aprovisionar un agente Java de APM.
    • -service-name: nombre del servicio que se está supervisando. Este argumento permite filtrar por servicio y ver los rastreos en la interfaz de usuario del Explorador de rastreo.
    • -destination: directorio de destino en el que se aprovisionará el agente Java de APM. Lo ideal sería que este fuera una variable que defina como parte de las tareas previas necesarias para apuntar al directorio de destino del servidor de aplicaciones. Por ejemplo, $DOMAIN_HOME para la ubicación del dominio de Oracle WebLogic Server. Para los microservicios, el directorio de destino puede ser el directorio de inicio estándar o cualquier directorio vacío.
    • -private-data-key: clave de instalación del agente utilizada por los agentes Java de APM (private dataKey), que se genera cuando se crea el dominio de APM.
    • -data-upload-endpoint: URL de dataUploadEndpoint que se genera cuando se crea el dominio de APM.

    Para obtener más información sobre dataKey y dataUploadEndpoint privados, consulte Obtención del punto final de carga de datos y las claves de datos.

    Puede especificar argumentos adicionales al aprovisionar el agente Java de APM. Para obtener información sobre estos argumentos y los escenarios en los que son útiles, consulte Especificación de argumentos de proxy.

    Para ver la información de ayuda para el argumento provision-agent, ejecute lo siguiente:

    java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help

    Para obtener más información, consulte Información de uso de ayuda.

  4. Aprovisione el agente especificando los argumentos obligatorios descritos en el paso anterior y ejecutando el siguiente comando java:
    java -jar ./apm-java-agent-installer-<version>.jar provision-agent -service-name=<Name of the Service> -destination=<Destination_Directory> -private-data-key=<Agent installation key generated during APM domain creation> -data-upload-endpoint=<dataUploadEndpoint URL generated during APM domain creation>
    

    A continuación le mostramos un ejemplo:

    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
    
    Al ejecutar el comando java, si el agente Java de APM se aprovisiona correctamente:
    • Aparecerá el mensaje Action [provision-agent] completed successfully.
    • Se creará el directorio oracle-apm-agent en el directorio de destino. Por ejemplo, $DOMAIN_HOME/oracle-apm-agent.

      El directorio oracle-apm-agent debe contener lo siguiente:

      • bin: contiene el iniciador del agregador.
      • bootstrap: contiene los archivos .jar de inicio del agente que utilizará el comando -javaagent para desplegar el agente Java de APM.
      • config: contiene los archivos de configuración globales, que se pueden editar. Este directorio contiene:
        • El archivo AgentConfig.properties, que contiene argumentos de configuración del agente Java de APM.
        • El archivo ProbeConfig.acml, que contiene la información de configuración relacionada con los sondeos.
      • install: contiene el directorio <release-version>/config, que tiene los binarios del agente Java de APM y los archivos de configuración por defecto. Tenga en cuenta que los archivos de este directorio no se deben cambiar.
      • version: archivo de versión que tiene información sobre la versión y la fecha de activación del agente Java de APM.

    Si el comando java termina y el agente Java de APM no se aprovisiona correctamente, puede revisar los detalles del error en el archivo ApmAgentInstall.log y el log de salida del servidor de aplicaciones para corregir la incidencia.

Información de uso de la ayuda

Para ver la información de ayuda y una lista de opciones disponibles al aprovisionar el agente, utilice la opción -help.

java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help

Por ejemplo:

java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help

Usage: 
apm-java-agent-installer-<version>.jar provision-agent [options ...] 

options:
   -service-name=<service name>
       (Required) Name of the service being monitored.

   -destination=<path>
       (Required) Path to create Agent home directory. The Agent software will be
       deployed to a 'oracle-apm-agent' sub-directory in the specified path.

   -private-data-key=<private_data_key>
       (Required) APM Agent private
      data key for Appserver Agents. This property
       is required for the APM Agent to connect to the Oracle APM Cloud, and it
       is specific to your APM Cloud Domain.

   -data-upload-endpoint=<https://host:port>
            (Required) Endpoint of Oracle APM Cloud. This property is required for the
            APM Agent to connect to the Oracle APM Cloud, and it is specific to your
            APM Cloud Domain.

   -enable-browser-agent-injection
       Enables the APM Agent to automatically inject the browser agent into HTML
       pages.  Make sure '-public-data-key' is also set, otherwise injection will
       not be enabled until one is provided.

   -public-data-key=<public_data_key>
       APM Agent public data key for Appserver Agents. This property is required
       for the injected browser agent to connect to the Oracle APM Cloud, and it
       is specific to your APM Cloud Domain.

   -activation-date=<YYYY-MM-DD>
       To stage newly installed Agent, and defer Agent running until Appserver
       restart on or later than specified date.

   -property=<key=value>
       Agent specific (i.e. starting with 'com.oracle.apm.agent') configuration
       properties. Multiple instances of -property can be specified.
       Alternatively, you can add these properties to the
       "AgentConfig.properties" file located in the Agent config directory
       (oracle-apm-agent/config/<version>).

   -overwrite
       Overwrite Agent deployment.

 Example:
   - Deploy Agent to user home directory      
      provision-agent -service-name=myservice -destination=/home/user
                      -private-data-key=12345 -data-upload-endpoint=https://<endpoint>
   - Deploy Agent to user home directory with additional properties
       provision-agent -service-name=myservice -destination=/home/user
                       -private-data-key=12345 -data-upload-endpoint=https://<endpoint>
                       -property=com.oracle.apm.agent.logging.level=WARNING
Nota

También puede utilizar el asistente Instalar agente de APM para obtener ayuda con la descarga, el aprovisionamiento y el despliegue del agente de APM. Puede encontrarlo en la parte superior de la página Descargar agentes de APM.