Provisionner l'agent Java APM

Vous pouvez provisionner le logiciel de l'agent Java APM après avoir terminé le téléchargement de l'agent Java APM.

Effectuez les étapes suivantes :

  1. Connectez-vous à l'hôte où le serveur d'applications est installé et copiez à un emplacement privilégié le fichier du logiciel d'agent Java APM que vous avez téléchargé.

    Veillez à vous connecter en tant qu'utilisateur ayant installé le serveur d'applications et que celui-ci dispose des autorisations de lecture et d'écriture pour le répertoire dans lequel l'agent Java APM est téléchargé ou copié.

  2. Assurez-vous d'être connecté en tant qu'utilisateur qui a installé le serveur d'applications et naviguez jusqu'au répertoire où vous avez téléchargé ou copié le logiciel d'agent Java APM. Notez que vous devez disposer des autorisations de lecture et d'écriture pour le répertoire qui héberge l'agent Java APM.
  3. Vérifiez les arguments obligatoires suivants qui doivent être spécifiés pour provisionner un agent Java APM.
    • -service-name : Nom du service surveillé. Cet argument vous permet de filtrer par service et de voir les traces dans l'interface utilisateur de l'explorateur de trace.
    • -destination : Répertoire de destination dans lequel l'agent Java APM sera provisionné. Idéalement, ce devrait être une variable pointant vers le répertoire de destination du serveur d'applications, que vous avez définie dans le cadre des tâches préalables. Par exemple, $DOMAIN_HOME pour l'emplacement du domaine Oracle WebLogic Server. Pour les microservices, le répertoire de destination peut être le répertoire de base standard ou tout répertoire vide.
    • -private-data-key : Clé d'installation de l'agent utilisée par les agents Java APM (clé de données privée), qui est générée lors de la création du domaine APM.
    • -data-upload-endpoint : URL dataUploadEndpoint générée lors de la création du domaine APM.

    Pour plus d'informations sur les clés de données privées et dataUploadEndpoint, voir Obtenir un point d'extrémité de chargement de données et des clés de données.

    Vous pouvez spécifier des arguments supplémentaires lors du provisionnement de l'agent Java APM. Pour plus d'informations sur ces arguments et les scénarios dans lesquels ils sont utiles, voir Sélectionner des arguments de mandataire.

    Pour voir les informations d'aide de l'argument provision-agent, exécutez les commandes suivantes :

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

    Pour plus de détails, voir Informations sur l'utilisation de l'aide.

  4. Provisionnez l'agent en spécifiant les arguments obligatoires décrits à l'étape précédente et en exécutant la commande java suivante :
    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>
    

    Voici un exemple :

    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
    
    Lors de l'exécution de la commande java, si l'agent Java APM est provisionné avec succès :
    • Le message Action [provision-agent] completed successfully s'affiche.
    • Le répertoire oracle-apm-agent est créé dans le répertoire de destination. Par exemple, $DOMAIN_HOME/oracle-apm-agent.

      Le répertoire oracle-apm-agent doit contenir les éléments suivants :

      • bin : Contient le démarreur de l'agrégation.
      • bootstrap : Contient les fichiers .jar de démarrage de l'agent qui seront utilisés par la commande -javaagent pour déployer l'agent Java APM.
      • config : Contient les fichiers de configuration globale, qui peuvent être modifiés. Ce répertoire contient :
        • Le fichier AgentConfig.properties, qui contient les arguments de configuration de l'agent Java APM.
        • Le fichier ProbeConfig.acml, qui contient les informations de configuration relatives aux sondes.
      • install : Contient le répertoire <release-version>/config, qui contient les fichiers binaires de l'agent Java APM et les fichiers de configuration par défaut. Notez que les fichiers de ce répertoire ne doivent pas être modifiés.
      • version : Fichier de version contenant des informations sur la version et la date d'activation de l'agent Java APM.

    Si l'agent Java APM n'est pas provisionné avec succès après exécution de la commande java, vous pouvez vérifier les détails des erreurs dans le fichier ApmAgentInstall.log et le journal de sortie du serveur d'applications pour corriger le problème.

Informations sur l'utilisation de l'aide

Pour voir les informations d'aide et la liste des options disponibles lors du provisionnement de l'agent, utilisez l'option -help.

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

Exemple :

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
Note

Vous pouvez également utiliser l'Assistant Installer l'agent APM pour obtenir de l'aide sur le téléchargement, le provisionnement et le déploiement de l'agent APM. Vous pouvez le trouver en haut de la page Télécharger les agents APM.