APM-Browser-Agent-Injection aktivieren

Voraussetzungen

  • Sie müssen ein öffentliches Datenelement anfordern, das beim Erstellen der APM-Domain generiert wird.

    Der öffentliche Datenschlüssel kann wie folgt abgerufen werden:

    1. Öffnen Sie das Navigationsmenü, und klicken Sie auf Observability and Management. Klicken Sie unter Application Performance Monitoring auf Administration.

      Wählen Sie auf der Seite "Administration" das gewünschte Compartment und die APM-Domain aus.

    2. Click on Data Keys under Resources to list the data keys.

      Wenn kein Datenschlüssel vorhanden ist, klicken Sie auf Datenschlüssel generieren, und wählen Sie den öffentlichen Datenschlüssel aus.

    3. Klicken Sie auf Kopieren, das neben einem Datenschlüssel des Typs Öffentlich liegt, um den Wert abzurufen. Dieser Wert wird später verwendet.

    Weitere Details finden Sie unter Datenuploadendpunkt und Datenschlüssel abrufen.

Über das Installationsprogramm aktivieren

Ab APM Agent Version 1.6 können Sie die APM Browser Agent-Injection aktivieren, wenn der Agent mit der Option -enable-browser-agent-injection bereitgestellt wird.

Beispiel:

java -jar apm-java-agent-installer-1.6 provision-agent -destination=/example/path/destination -service-name=example_apm_service -private-data-key=ExamplePrivateDataKey -data-upload-endpoint=https://dataUploadEndpoint.com -enable-browser-agent-injection -public-data-key=ExamplePublicDataKey

Dabei wird ExamplePublicDataKey durch den öffentlichen Datenschlüssel ersetzt, der zuvor in Schritt 3 bei den Voraussetzungen von der OCI-Konsole abgerufen wurde.

Der Java-Agent wird automatisch so konfiguriert, dass er beim Start Browser-Agent-Injection durchführt.

Um die Hilfeinformationen beim Provisioning des Agents anzuzeigen, verwenden Sie die Option -help. Beispiel:

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

options:
...
...
   -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.
...
...

Eine vollständige Liste der Optionen finden Sie unter Informationen zur Hilfeverwendung.

Verwenden der Datei AgentConfig.properties aktivieren

Wenn Sie ein Upgrade von einer älteren APM-Agent-Version durchführen oder die Browser-Agent-Injection nicht über das Installationsprogramm aktiviert haben, müssen Sie dieses Feature nach dem Agent-Upgrade oder der Agent-Installation manuell aktivieren.

  • Navigieren Sie in das vorhandene Verzeichnis oracle-apm-agent/config. Gehen Sie von dort aus in das Verzeichnis für die neueste Version, auf die Sie upgegradet haben.

  • Öffnen Sie die Datei AgentConfig.properties, und aktualisieren Sie die folgenden beiden Eigenschaften:
    Hinweis

    Sie müssen die Kommentarzeichen entfernen (Symbol # muss entfernt werden) und aktualisiert werden.
    • com.oracle.apm.agent.rum.enable.injection: Entfernen Sie # für diese Eigenschaft, und setzen Sie den Wert auf true.
    • com.oracle.apm.agent.public.data.key: Entfernen Sie # für diese Eigenschaft, und legen Sie den Wert auf den öffentlichen Datenschlüssel fest, der aus Schritt 3 während der vorhergehenden Voraussetzungen erworben wurde.
    Nach der Aktualisierung der Eigenschaften sieht die Datei in etwa wie folgt aus:
    # APM Agent public data key. This property is required for the injected Browser Agent to connect to server, which can be
    # obtained at APM service sign up.
    # 
    ... 
    ...
    ...
    #--------------------------- Start of Browser Agent (RUM) Injection Properties---------------------------------------
    # Enables browser agent injection.
    # Once enabled, the agent will inject a few lines of JavaScript code into the HTTP pages served by this AppServer.
    # It is recommended to test the application and exclude any pages that may be adversely affected by this injection.
    # See "Configure APM Browser Agent Injection using APM Java Agent" in the service documentation for more details.
    com.oracle.apm.agent.rum.enable.injection=true
    
    # APM Agent public data key. This property is required for the injected Browser Agent to connect to server, which can be
    # obtained at APM service sign up.
    com.oracle.apm.agent.public.data.key=ExamplePublicDataKey

Der APM-Java-Agent ist jetzt so konfiguriert, dass er mit der APM-Browser-Agent-Injection beginnt und detaillierte Einblicke in echte Benutzermetriken wie Pageload-Zeit, DNS-Zeit und SSL-Zeit sammeln kann.