Provisionnement de l'agent Java APM

Vous pouvez provisionner le logiciel de l'agent Java APM une fois le téléchargement de l'agent Java APM terminé.

Procédez comme suit :

  1. Connectez-vous à l'hôte sur lequel le serveur d'applications est installé, puis copiez le fichier du logiciel de l'agent Java APM que vous avez téléchargé dans l'emplacement de votre choix.

    Assurez-vous que vous vous connectez en employant le même utilisateur qui a installé le serveur d'applications et que l'utilisateur de serveur d'applications dispose des droits d'accès en lecture et en écriture sur le répertoire dans lequel l'agent Java APM est téléchargé ou copié.

  2. Vérifiez que vous vous êtes connecté en employant l'utilisateur qui a installé le serveur d'applications et accédez au répertoire dans lequel vous avez téléchargé ou copié le logiciel de l'agent Java APM. Vous devez disposer des droits d'accès en lecture et en écriture sur le répertoire qui héberge l'agent Java APM.
  3. Passez en revue 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 les résultats par service et de visualiser les traces dans l'interface utilisateur de l'explorateur de traces.
    • -destination : répertoire de destination dans lequel l'agent Java APM sera provisionné. Idéalement, vous définissez cette variable dans le cadre des tâches de prérequis de façon à pointer vers le répertoire de destination du serveur d'applications. Par exemple, $DOMAIN_HOME pour l'emplacement du domaine Oracle WebLogic Server. Pour les microservices, le répertoire de destination peut correspondre au répertoire de base standard ou à n'importe quel répertoire vide.
    • -private-data-key : clé d'installation d'agent utilisée par les agents Java APM (clé de données privée), générée lors de la création du domaine APM.
    • -data-upload-endpoint : URL d'adresse de téléchargement de données générée lors de la création du domaine APM.

    Pour plus d'informations sur la clé de données privée et d'adresse de téléchargement de données, reportez-vous à Obtention de l'adresse de télé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 sur les scénarios dans lesquels ils sont utiles, reportez-vous à Définition des arguments proxy.

    Pour afficher les informations d'aide de l'argument provision-agent, exécutez la commande suivante :

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

    Pour plus de détails, reportez-vous à la section Help Usage Information.

  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 a été provisionné, les opérations suivantes sont effectuées :
    • Le message Action [provision-agent] completed successfully apparaît.
    • 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éclencheur de l'opérateur d'agrégation.
      • bootstrap : contient les fichiers .jar de démarrage de l'agent utilisés par la commande -javaagent pour déployer l'agent Java APM.
      • config : contient les fichiers de configuration globale. Ces fichiers sont modifiables. Le répertoire contient les fichiers suivants :
        • 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 comporte les fichiers de configuration par défaut et les fichiers binaires de l'agent Java APM. Les fichiers de ce répertoire ne doivent pas être modifiés.
      • version : fichier de version contenant des informations sur la version (release) de l'agent Java APM et la date d'activation.

    Si la commande java prend fin et que l'agent Java APM n'est pas provisionné, vous pouvez examiner les détails de l'erreur dans le fichier ApmAgentInstall.log et dans le journal de sortie du serveur d'applications pour corriger le problème.

Informations sur l'utilisation de l'aide

Pour afficher 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
Remarque

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.