Installez l'agent Java sur les serveurs d'applications et les frameworks JVM

Cette page couvre le chemin d’installation standard de l’agent Java New Relic sur tout serveur d’application pris en charge ou framework basé sur la JVM. Suivez ces étapes pour télécharger l’agent, le configurer et vérifier que les données sont acheminées vers New Relic.

Compatibilité et exigences

Soutenu

Java 8, 11, 17, 21, 24, 25, et 26 (Java 7 pris en charge sur l’agent v6.5.4, et versions antérieures uniquement)
Langages basés sur la JVM : Java, Scala, Kotlin, et Clojure
Serveurs d’applications et frameworks : Tomcat, Spring Boot, JBoss/WildFly, Glassfish, Jetty, WebLogic, WebSphere, Grails, ColdFusion, Solr, Play, Resin, Tanuki Wrapper, et Geronimo ; voir la page compatibilité et exigences pour les plages de versions prises en charge
Tout processus JVM qui accepte un argument -javaagent

Non pris en charge

Exécution aux côtés d’autres agents APM : l’agent Java ne peut pas garantir un comportement correct lorsqu’un autre agent APM est actif dans la même JVM

Vous avez besoin de

Un compte New Relic et
Une JVM avec prise en charge de SSL SHA-2 (256 bits)
Autorisation de modifier les scripts de démarrage de votre serveur d'applications ou la configuration de la JVM
Autorisation de créer un répertoire pour contenir les fichiers de l’agent

Installation

Téléchargez l’agent Java

Téléchargez newrelic-java.zip en utilisant l’une de ces méthodes :

bash

$curl -O https://download.newrelic.com/newrelic/java-agent/newrelic-agent/current/newrelic-java.zip
$unzip newrelic-java.zip

Invoke-WebRequest -Uri https://download.newrelic.com/newrelic/java-agent/newrelic-agent/current/newrelic-java.zip -OutFile newrelic-java.zip
Expand-Archive -Path newrelic-java.zip -DestinationPath .

Téléchargez newrelic-java.zip depuis la page des notes de sortie de l’agent Java.

Après la décompression, le répertoire newrelic/ contient le jar de l’agent (newrelic.jar) et le fichier de configuration (newrelic.yml) que vous configurerez lors des prochaines étapes.

Placez les fichiers de l’agent

Créez un répertoire permanent et déplacez les fichiers de l'agent dans celui-ci :

bash

$mkdir -p /opt/newrelic
$mv newrelic/* /opt/newrelic/

Nous recommandons /opt/newrelic sur Linux/macOS ou C:\opt\newrelic sur Windows. Assurez-vous que newrelic.jar n’est pas dans le classpath de votre application ou dans tout répertoire listé dans java.endorsed.dirs.

Passez le `-javaagent`

Ajoutez l’indicateur -javaagent à la configuration de démarrage de la JVM de votre serveur d’application, en pointant vers le chemin complet de newrelic.jar. La méthode diffère selon le serveur : développez celle qui correspond à votre environnement :

Choisissez la méthode pour votre configuration Tomcat :

Créez CATALINA_BASE/bin/setenv.sh s’il n’existe pas, puis ajoutez :

bash

$export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/opt/newrelic/newrelic.jar"

Créez CATALINA_BASE/bin/setenv.bat s’il n’existe pas, puis ajoutez :

SET "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:C:\opt\newrelic\newrelic.jar"

Sélectionnez Start > Apache Tomcat X.Y.Z > Configure Tomcat > Java.
Dans la zone de texte Java Options, saisissez l’argument. Utilisez des barres obliques / comme séparateur de chemin. Pour Tomcat 6, ajoutez un saut de ligne après l’argument -javaagent.
```
-javaagent:/opt/newrelic/newrelic.jar
```
Sélectionnez Apply, puis redémarrez Tomcat.

La version d'Apache Commons daemon (jsvc) incluse avec Tomcat 6 ne prend pas en charge l'argument -javaagent. Une construction à partir de la source du trunk le prend en charge via le préfixe -X. Consultez le rapport de bug Apache et le référentiel source d'Apache Commons.

Modifiez domain/configuration/domain.xml et ajoutez l’option -javaagent aux options de la JVM de votre groupe de serveurs :

<server-group name="main-server-group" profile="full">
    <jvm name="default">
        <jvm-options>
            <option value="-javaagent:/opt/newrelic/newrelic.jar"/>
        </jvm-options>
    </jvm>
</server-group>

Prudence

Un bug JBoss dans les versions 7.0.2.Final et 7.1.0.Alpha1 empêche de définir les options de la JVM dans domain.xml. Mettez à niveau votre serveur d’applications JBoss si vous rencontrez ce problème.

plateforme	Instructions
Unix/macOS — JBoss 6.x EAP ou 7.0.x AS+	Au bas de `bin/standalone.conf` , ajoutez : `JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"`
Windows - JBoss 6.x EAP ou 7.0.x AS+	Dans `bin/standalone.bat` , avant `set JBOSS_ENDORSED_DIRS` , ajoutez : `set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"`
Unix/macOS - JBoss 6.x ou version antérieure	Au bas de `bin/run.conf` , ajoutez : `JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"`
Windows - JBoss 6.x ou version antérieure	Dans `bin/run.bat` , avant `set JBOSS_CLASSPATH` , ajoutez : `set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"`

Conseil

WildFly 11 ou supérieur nécessite des étapes d’installation supplémentaires.

Modifiez domain/configuration/domain.xml et ajoutez l’option -javaagent aux options de la JVM de votre groupe de serveurs :

<server-group name="main-server-group" profile="full">
    <jvm name="default">
        <jvm-options>
            <option value="-javaagent:/opt/newrelic/newrelic.jar"/>
        </jvm-options>
    </jvm>
</server-group>

plateforme	Instructions
Unix/macOS	Au bas de `bin/standalone.conf` , ajoutez : `JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"`
Windows	Dans `bin/standalone.bat` , après `rem Setup JBoss specific properties` , ajoutez : `set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"`

plateforme

Instructions

Unix/macOS

Au bas de

bin/standalone.conf

, ajoutez :

JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"

Windows

Dans

bin/standalone.bat

, après

rem Setup JBoss specific properties

, ajoutez :

set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"

Depuis la console admin Glassfish, sélectionnez Application Server > JVM Settings > JVM Options.
Sélectionnez Add JVM Option et ajoutez :
```
-javaagent:/opt/newrelic/newrelic.jar
```
Enregistrez et redémarrez Glassfish.
Si Glassfish ne démarre pas, le chemin -javaagent peut être incorrect. Vous pouvez également définir les arguments JVM en modifiant domain.xml directement.
Important
Un bogue dans Glassfish 2.1 empêche les classes du chargeur de classes bootstrap d’utiliser l’API de logging Java. Cela est corrigé dans la version 2.1.1 et supérieure.

Modifiez JAVA_OPTIONS dans votre script jetty.sh :

bash

$export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/opt/newrelic/newrelic.jar"

Ajoutez à votre fichier de configuration start.ini :

-javaagent:/opt/newrelic/newrelic.jar

Modifiez startWebLogic.sh dans le répertoire bin/ du domaine.

Au début du fichier, ajoutez :

bash

$export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/opt/newrelic/newrelic.jar"

Modifiez startWebLogic.bat dans le répertoire bin/ du domaine.

Au début du fichier, ajoutez :

set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:"C:\opt\newrelic\newrelic.jar"

Pour les instances de serveur d’administration, utilisez les instructions Linux/macOS ou Windows ci-dessus ; vous ne pouvez pas configurer les instances de serveur d’administration via la console admin.

Pour l'instance de serveur gérée, utilisez la console d'administration :

Accédez à Environments > Servers > (sélectionnez un serveur) > Server Start > Arguments.
Ajouter:
```
-javaagent:/opt/newrelic/newrelic.jar
```
Enregistrez et redémarrez l’instance du serveur.

Depuis la console admin, sélectionnez Servers > Application servers > (sélectionnez un serveur) > Configuration > Service Infrastructure > Java and Process Management.
Sélectionnez Process Definition > Additional Properties, puis sélectionnez Java Virtual Machine.
Dans le champ Generic JVM arguments, ajoutez :
```
-javaagent:/opt/newrelic/newrelic.jar
```
Sélectionnez Apply, puis Save.
Redémarrez votre serveur.
Pour plus d’informations, consultez la collecte des métriques PMI WebSphere.

Ajoutez l’agent à JAVA_OPTS lors de l’exécution de la commande de démarrage :

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar" && startup

Modifier ${server.config.dir}/jvm.options.
Ajouter:
```
-javaagent:/opt/newrelic/newrelic.jar
```
Redémarrez votre serveur.

bash

$grails -noreloading -javaagent:/opt/newrelic/newrelic.jar run-app

Dans grails-app/conf/BuildConfig.groovy, ajoutez ou modifiez :

grails.tomcat.jvmArgs = ["-javaagent:/opt/newrelic/newrelic.jar"]

Démarrez votre serveur ColdFusion et ouvrez la console admin ColdFusion.
Dans le menu de gauche, sélectionnez SERVER SETTINGS > Java and JVM.
Si vous utilisez l’API d’agent, spécifiez le chemin vers newrelic-api.jar dans le champ ColdFusion Class Path.
Dans le champ JVM Arguments, ajoutez :
```
-javaagent:/opt/newrelic/newrelic.jar
```
Sélectionnez Submit Changes, puis redémarrez ColdFusion.

Ajoutez la propriété -javaagent à bin/solr.in.sh:

bash

$SOLR_OPTS="$SOLR_OPTS -javaagent:/opt/newrelic/newrelic.jar"

Ajoutez le -javaagent avant start.jar:

bash

$java -javaagent:/opt/newrelic/newrelic.jar -jar start.jar

Lorsque vous exécutez Solr dans un serveur d’applications, suivez les instructions de ce serveur d’applications (voir les autres entrées de cette liste). Assurez-vous également que JMX est activé. Si les données Solr n’apparaissent pas dans APM, consultez les procédures de dépannage pour les données Solr.

bash

$play run your_app_name -javaagent:/opt/newrelic/newrelic.jar

Commencez par une distribution décompressée contenant le script start :
bash
```
$play clean dist && unzip dist/*.zip
```

Commencez par l’argument -javaagent :

bash

$cd unzipped/folder; chmod a+x start; ./start -javaagent:/opt/newrelic/newrelic.jar

Commencez avec une distribution décompressée :

bash

$play clean dist && unzip target/directory/universal/*.zip

Utilisez le préfixe -J-javaagent :

bash

$cd unzipped/folder; ./bin/scriptname -J-javaagent:/opt/newrelic/newrelic.jar

Commencez avec une distribution décompressée :

bash

$activator clean dist && unzip target/directory/universal/*.zip

Utilisez le préfixe -J-javaagent :

bash

$cd unzipped/folder; ./bin/scriptname -J-javaagent:/opt/newrelic/newrelic.jar

Si vous utilisez Typesafe Activator avec Play 2.4, ajoutez également à build.sbt:
```
javaOptions ++= Seq("-javaagent:/opt/newrelic/newrelic.jar")
```

Ajoutez à la section <jvm-args> dans conf/resin.conf ou conf/resin.xml:

<jvm-arg>-javaagent:/opt/newrelic/newrelic.jar</jvm-arg>

Le système de modules Java 9 peut causer NoClassDefFoundError: java/sql/SQLException si -javaagent est ajouté à conf/resin.conf ou conf/resin.xml. Utilisez plutôt l’une de ces alternatives :

Option 1 — Ligne de commande :

bash

$java -javaagent:/opt/newrelic/newrelic.jar -jar lib/resin.jar start

Option 2 - Éditez bin/resin.sh, en modifiant :

bash

$exec $JAVA_EXE -javaagent:/opt/newrelic/newrelic.jar -jar lib/resin.jar $@

Ensuite, démarrez Resin avec ./bin/resin.sh start.

Dans wrapper.conf, ajoutez une nouvelle option wrapper.java.additional. Remplacez XXX par un numéro inutilisé dans le fichier :

wrapper.java.additional.XXX=-javaagent:/opt/newrelic/newrelic.jar

Conseil

Sous Linux, aucun guillemet n’est nécessaire autour du chemin. Cela peut varier sur d’autres systèmes d’exploitation.

Passez le jar de l’agent dans JAVA_OPTS lors de l’exécution de la commande de démarrage de Geronimo :

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar" && geronimo run

Configure

Modifiez newrelic/newrelic.yml et définissez ces deux valeurs requises :

license_key: 'YOUR_LICENSE_KEY'
app_name: 'My Application'

L’agent lit newrelic.yml depuis le même répertoire que newrelic.jar au démarrage. Vous pouvez également remplacer n’importe quel paramètre à l’aide des propriétés système Java (par exemple -Dnewrelic.config.license_key=YOUR_KEY) ou des variables d’environnement.

Lors de l’utilisation du fichier de configuration, restreignez les autorisations de lecture/écriture au seul propriétaire du processus du serveur d’applications :

bash

$chmod 600 /opt/newrelic/newrelic.yml

Consultez la configuration de l’agent Java pour toutes les options disponibles.

Vérifiez votre installation

Redémarrez votre serveur d’application. Envoyez au moins deux requests, puis patientez 2 - 3 minutes et votre application apparaît dans APM & services.

Si aucune donnée n’apparaît après cinq minutes, consultez Aucune donnée n’apparaît (Java).

Cette traduction automatique est fournie pour votre commodité.

Installez l'agent Java sur les serveurs d'applications et les frameworks JVM

Compatibilité et exigences

Soutenu

Non pris en charge

Vous avez besoin de

Installation

Téléchargez l’agent Java

Placez les fichiers de l’agent

Passez le `-javaagent`

Tomcat

Spring Boot

JBoss/WildFly

Prudence

WildFly (autonome)

Conseil

Glassfish

Important

Jetty

WebLogic

WebSphere

Grails

ColdFusion

Solr

Framework Play

Resin

Tanuki Wrapper (Java Service Wrapper)

Conseil

Geronimo

Configure

Vérifiez votre installation

Cette traduction automatique est fournie pour votre commodité.

Installez l'agent Java sur les serveurs d'applications et les frameworks JVM

Compatibilité et exigences .css-21sua1{background:none;border:none;width:0;padding:0;}

Soutenu

Non pris en charge

Vous avez besoin de

Installation

Téléchargez l’agent Java

Placez les fichiers de l’agent

Passez le -javaagent

Spring Boot

JBoss/WildFly

WildFly (autonome)

Glassfish

Jetty

WebLogic

WebSphere

Grails

ColdFusion

Solr

Framework Play

Resin

Tanuki Wrapper (Java Service Wrapper)

Geronimo

Configure

Vérifiez votre installation

Articles connexes

Compatibilité et exigences

Passez le `-javaagent`