APM-Java-Agent durch Provisioning bereitstellen

Sie können die APM-Java-Agent-Software durch Provisioning bereitstellen, nachdem Sie den APM-Java-Agent heruntergeladen haben.

Führen Sie die folgenden Schritte durch:

  1. Stellen Sie eine Verbindung zum Host her, auf dem der Anwendungsserver installiert ist, und kopieren Sie die heruntergeladene APM-Java-Agent-Softwaredatei an einen beliebigen Speicherort.

    Stellen Sie sicher, dass Sie sich als der Benutzer anmelden, der den Anwendungsserver installiert hat, und dass der Anwendungsserverbenutzer Lese- und Schreibberechtigungen für das Verzeichnis hat, in das der APM-Java-Agent heruntergeladen oder kopiert wird.

  2. Melden Sie sich als der Benutzer an, der den Anwendungsserver installiert hat, und navigieren Sie zu dem Verzeichnis, in das Sie die APM-Java-Agent-Software heruntergeladen oder kopiert haben. Beachten Sie, dass Sie Lese- und Schreibberechtigungen für das Verzeichnis benötigen, das den APM-Java-Agent hostet.
  3. Prüfen Sie die folgenden obligatorischen Argumente, die für das Provisioning eines APM-Java-Agent angegeben werden müssen.
    • -service-name: Der Name des überwachten Service. Mit diesem Argument können Sie auf der Trace-Explorer-Benutzeroberfläche nach Service filtern und Traces anzeigen.
    • -destination: Das Zielverzeichnis, in dem der APM-Java-Agent durch Provisioning bereitgestellt wird. Im Idealfall sollte es sich um eine Variable handeln, die Sie im Rahmen der erforderlichen Aufgaben festlegen und die auf das Zielverzeichnis des Anwendungsservers verweist. Beispiel: $DOMAIN_HOME für den Speicherort der Oracle WebLogic Server-Domain. Bei Microservices kann das Zielverzeichnis das Standard-Home-Verzeichnis oder ein leeres Verzeichnis sein.
    • -private-data-key: Der von APM-Java-Agents verwendete Agent-Installationsschlüssel (private Datenschlüssel), der beim Erstellen der APM-Domain generiert wird.
    • -data-upload-endpoint: Die URL des Datenuploadendpunkts, die beim Erstellen der APM-Domain generiert wird.

    Weitere Informationen zum privaten Datenschlüssel und zum Datenuploadendpunkt finden Sie unter Datenuploadendpunkt und Datenschlüssel abrufen.

    Beim Provisioning des APM-Java-Agent können Sie zusätzliche Argumente angeben. Weitere Informationen zu diesen Argumenten und den Szenarios, in denen sie nützlich sind, finden Sie unter Proxyargumente angeben.

    Um die Hilfeinformationen für das Argument provision-agent anzuzeigen, führen Sie Folgendes aus:

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

    Weitere Informationen finden Sie unter Informationen zur Hilfeverwendung.

  4. Stellen Sie den Agent durch Provisioning bereit, indem Sie die im vorherigen Schritt beschriebenen obligatorischen Argumente angeben und den folgenden java-Befehl ausführen:
    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>
    

    Beispiel:

    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
    
    Wenn der APM-Java-Agent erfolgreich durch Provisioning bereitgestellt wurde, geschieht beim Ausführen des java-Befehls Folgendes:
    • Die Meldung Action [provision-agent] completed successfully wird angezeigt.
    • Das Verzeichnis oracle-apm-agent wird im Zielverzeichnis erstellt. Beispiel: $DOMAIN_HOME/oracle-apm-agent.

      Das Verzeichnis oracle-apm-agent sollte Folgendes enthalten:

      • bin: Enthält den Starter des Aggregators.
      • bootstrap: Enthält die .jar-Startdateien des Agent, die vom Befehl -javaagent für das Deployment des APM-Java-Agent verwendet werden.
      • config: Enthält die globalen Konfigurationsdateien, die bearbeitet werden können. Dieses Verzeichnis enthält Folgendes:
        • Die Datei AgentConfig.properties, die Konfigurationsargumente für den APM-Java-Agent enthält.
        • Die Datei ProbeConfig.acml, die die Konfigurationsinformationen für Probes enthält.
      • install: Enthält das Verzeichnis <release-version>/config, das die Binärdateien und Standardkonfigurationsdateien des APM-Java-Agent enthält. Beachten Sie, dass die Dateien in diesem Verzeichnis nicht geändert werden dürfen.
      • version: Die Versionsdatei mit Informationen zur Version und zum Aktivierungsdatum des APM-Java-Agent.

    Wenn der java-Befehl beendet wird und der APM-Java-Agent nicht erfolgreich durch Provisioning bereitgestellt wurde, können Sie die Fehlerdetails in der Datei ApmAgentInstall.log und im Ausgabelog des Anwendungsservers prüfen, um das Problem zu beheben.

Hilfeverwendungsinformationen

Um die Hilfeinformationen und eine Liste der beim Provisioning des Agents verfügbaren Optionen anzuzeigen, verwenden Sie die Option -help.

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

Beispiel:

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
Hinweis

Alternativ können Sie den Assistenten APM-Agent installieren zum Herunterladen, Bereitstellen und Bereitstellen des APM-Agent verwenden. Sie finden sie oben auf der Seite APM-Agents herunterladen.