Activer l'injection d'agent de navigateur APM

Préalables

  • Vous devez acquérir une liaison de données publique générée lors de la création du domaine APM.

    La clé de données publiques peut être obtenue de la façon suivante :

    1. Ouvrez le menu de navigation, cliquez sur Observabilité et gestion. Sous Surveillance de la performance des applications, cliquez sur Administration.

      Dans la page Administration, sélectionnez le compartiment et le domaine APM souhaités.

    2. Cliquez sur Clés de données sous Ressources pour lister les clés de données.

      Si aucune clé de données n'existe, cliquez sur Générer une clé de données et sélectionnez la clé de données publique.

    3. Cliquez sur Copier à côté d'une clé de données de type Public pour extraire la valeur. Cette valeur sera utilisée ultérieurement.

    Pour plus de détails, voir Obtenir un point d'extrémité de chargement de données et des clés de données.

Activer via le programme d'installation

À partir de la version 1.6 de l'agent APM, vous pouvez activer l'injection d'agent de navigateur APM lorsque l'agent est provisionné à l'aide de l'option -enable-browser-agent-injection.

Exemple :

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

ExamplePublicDataKey serait remplacé par la clé de données publique extraite de la console OCI à l'étape 3 au cours des préalables.

L'agent Java sera automatiquement configuré pour effectuer l'injection d'agent de navigateur au démarrage.

Pour voir les informations d'aide lors du provisionnement de l'agent, utilisez l'option -help. Par exemple :

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

Pour obtenir la liste complète des options, voir Informations sur l'utilisation de l'aide.

Activer l'utilisation du fichier AgentConfig.properties

Si vous effectuez une mise à niveau à partir d'une ancienne version de l'agent APM ou si vous n'avez pas activé l'injection d'agent de navigateur au moyen du programme d'installation, vous devrez activer cette fonction manuellement après la mise à niveau ou l'installation de l'agent.

  • Naviguez jusqu'au répertoire oracle-apm-agent/config existant. À partir de là, accédez au répertoire de la dernière version vers laquelle vous avez effectué la mise à niveau.

  • Ouvrez le fichier AgentConfig.properties et mettez à jour les deux propriétés suivantes :
    Note

    Ils doivent être annulés (le symbole # doit être supprimé) et mis à jour.
    • com.oracle.apm.agent.rum.enable.injection : Supprimez # pour cette propriété et réglez la valeur à true
    • com.oracle.apm.agent.public.data.key : Supprimez # pour cette propriété et réglez la valeur à la clé de données publique acquise à l'étape 3 lors des préalables.
    Une fois les propriétés mises à jour, le fichier ressemble à ce qui suit :
    # 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

L'agent Java APM est maintenant configuré pour commencer à effectuer l'injection de l'agent de navigateur APM et peut recueillir des informations détaillées sur les mesures réelles des utilisateurs telles que l'heure de chargement de pageload, l'heure DNS et l'heure SSL.