Eseguire il provisioning dell'agente Java APM

È possibile procedere al provisioning del software dell'agente Java APM dopo aver completato il download dell'agente Java APM.

Effettuare le seguenti operazioni:

  1. Connettersi all'host in cui è installato il server applicazioni e copiare il file software APM Java Agent scaricato in qualsiasi posizione preferita.

    Assicurarsi di eseguire il login come lo stesso utente che ha installato l'Application Server e che l'utente dell'Application Server disponga delle autorizzazioni di lettura e scrittura per la directory in cui viene scaricato o copiato l'agente Java APM.

  2. Assicurarsi di aver eseguito il login come utente che ha installato l'Application Server e passare alla directory in cui è stato scaricato o copiato il software dell'agente Java APM. Tenere presente che è necessario disporre delle autorizzazioni di lettura e scrittura nella directory che ospita l'agente Java APM.
  3. Rivedere i seguenti argomenti obbligatori che devono essere specificati per eseguire il provisioning di un agente Java APM.
    • -service-name: il nome del servizio monitorato. Questo argomento consente di filtrare per servizio e visualizzare i trace nell'interfaccia utente di Trace Explorer.
    • -destination: la directory di destinazione in cui verrà eseguito il provisioning dell'agente Java APM. Idealmente, questa dovrebbe essere una variabile impostata come parte dei task prerequisiti per puntare alla directory di destinazione di Application Server. Ad esempio, $DOMAIN_HOME per la posizione del dominio di Oracle WebLogic Server. Per i microservizi, la directory di destinazione può essere la directory home standard o qualsiasi directory vuota.
    • -private-data-key: la chiave di installazione dell'agente utilizzata dagli agenti Java APM (dataKey privato), generata al momento della creazione del dominio APM.
    • -data-upload-endpoint: l'URL dataUploadEndpoint generato quando viene creato il dominio APM.

    Per ulteriori informazioni su dataKey e dataUploadEndpoint privati, vedere Ottenere endpoint di caricamento dati e chiavi dati.

    È possibile specificare argomenti aggiuntivi durante il provisioning dell'agente Java APM. Per informazioni su questi argomenti e sugli scenari in cui sono utili, vedere Specificare gli argomenti proxy.

    Per visualizzare le informazioni della Guida per l'argomento provision-agent, eseguire le operazioni riportate di seguito.

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

    Per informazioni dettagliate, vedere Informazioni sull'uso della Guida.

  4. Eseguire il provisioning dell'agente specificando gli argomenti obbligatori descritti nel passo precedente ed eseguendo il seguente 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>
    

    Di seguito viene fornito un esempio.

    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
    
    Quando si esegue il comando java, se il provisioning dell'agente Java APM è riuscito:
    • Viene visualizzato il messaggio Action [provision-agent] completed successfully.
    • La directory oracle-apm-agent viene creata nella directory di destinazione. Ad esempio, $DOMAIN_HOME/oracle-apm-agent.

      La directory oracle-apm-agent deve contenere quanto segue:

      • bin: contiene l'inizio dell'aggregatore.
      • bootstrap: contiene i file .jar di avvio dell'agente che verranno utilizzati dal comando -javaagent per distribuire l'agente Java APM.
      • config: contiene i file di configurazione globali che possono essere modificati. Questa directory contiene:
        • Il file AgentConfig.properties, che contiene gli argomenti di configurazione dell'agente Java APM.
        • Il file ProbeConfig.acml, che contiene le informazioni di configurazione relative alle sonde.
      • install: contiene la directory <release-version>/config contenente i file binari dell'agente Java APM e i file di configurazione predefiniti. Tenere presente che i file in questa directory non devono essere modificati.
      • version: il file di versione contenente informazioni sulla versione e sulla data di attivazione dell'agente Java APM.

    Se il comando java termina e il provisioning dell'agente Java APM non viene eseguito correttamente, è possibile esaminare i dettagli dell'errore nel file ApmAgentInstall.log e nel log di output dell'Application Server per risolvere il problema.

Informazioni sull'uso della Guida

Per visualizzare le informazioni della Guida e una lista di opzioni disponibili durante il provisioning dell'agente, utilizzare l'opzione -help.

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

Ad esempio:

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

In alternativa, è possibile utilizzare la procedura guidata Installa agente APM per ottenere assistenza per il download, il provisioning e la distribuzione dell'agente APM. È possibile trovarlo nella parte superiore della pagina Scarica agenti APM.