Inclure l'agent Java avec un argument JVM

Ce document décrit comment transmettre l'argument -javaagent à la JVM pour votre framework. Cette étape d'installation garantit que l'agent est inclus dans votre application. Pour tous les serveurs d’applications, assurez-vous de transmettre le chemin d’accès complet au fichier newrelic.jar .

Ce document est simplement une référence sur la manière de transmettre l'argument. Pour les procédures d'installation détaillées, voir Installation de l'agent Java.

ColdFusion

Pour passer l'argument -javaagent sur ColdFusion :

Démarrez votre serveur ColdFusion et accédez à votre console d’administration 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 l'argument -javaagent :
```
-javaagent:/full/path/to/newrelic.jar
```
Sélectionnez Submit Changes, puis redémarrez votre serveur ColdFusion.

Geronimo

Pour transmettre l'argument -javaagent sur Geronimo, reportez-vous au fichier jar de l'agent New Relic dans la variable d'environnement JAVA_OPTS lors de l'exécution de la commande de démarrage :

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar" && geronimo run

Glassfish

Pour passer l'argument -javaagent sur Glassfish :

Depuis la console Glassfish, sélectionnez Application Server > JVM Settings > JVM options.
Sur la page des options JVM, sélectionnez Add JVM option.
Ajoutez une entrée pour l'argument -javaagent :
```
-javaagent:/full/path/to/newrelic.jar
```
Enregistrez et redémarrez Glassfish.

Si Glassfish ne démarre pas, l'argument -javaagent n'a peut-être pas été défini correctement. Vous pouvez modifier les arguments JVM du serveur en modifiant le fichier domain.xml .

Important

Un bogue dans Glassfish 2.1 empêche les classes du chargeur de classes d'amorçage (l'agent New Relic) d'utiliser l'API de logging Java. Cela semble être corrigé dans la version 2.1.1 ou supérieure.

Grails

Pour passer l'argument -javaagent sur Grails :

Dans votre application Grails, ouvrez ce fichier avec votre éditeur de texte :
```
grails-app/conf/BuildConfig.groovy
```

Ajoutez ou modifiez la ligne d’arguments JVM :

grails.tomcat.jvmArgs = ["-javaagent:/full/path/to/newrelic.jar"]

JBoss

Pour passer l’argument -javaagent sur JBoss :

Utilisez le mode domaine pour les versions JBoss 6.x EAP et 7.0 AS ou supérieures :

Modifiez les propriétés JVM de votre groupe de serveurs, situées dans :
```
domain/configuration/domain.xml
```
Modifiez les propriétés pour inclure l’argument -javaagent :
```
<server-group name="main-server-group" profile="full">
  <jvm name="default">
    <jvm-options>
      <option value="-javaagent:/full/path/to/newrelic.jar"/>
    </jvm-options>
  </jvm>
  ...
</server-group>
```
Prudence
Un bogue JBoss dans 7.0.2.Final et 7.1.0.Alpha1 ne permet pas de définir les options JVM dans domain.xml. Si vous rencontrez ce problème, mettez à niveau votre serveur application JBoss.

Utiliser le mode autonome pour les autres plateformes et versions :

plateforme	Instructions
Unix ou macOS avec 6.x EAP ou 7.0.x AS et au-dessus	Au bas de `bin/standalone.conf`, ajoutez : `JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"`
Windows avec EAP 6.x ou 7.0.x AS ou supérieur	Dans `bin/standalone.bat`, avant la ligne : `set JBOSS_ENDORSED_DIRS=%JBOSS_HOME%\lib\endorsed` Ajouter: `set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"`
Unix ou macOS avec 6.x ou version antérieure	Au bas de `bin/run.conf`, ajoutez ceci : `JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"`
Windows avec 6.x ou version antérieure	Dans `bin/run.bat`, avant la ligne : `set JBOSS_CLASSPATH=%RUN_CLASSPATH%` Ajouter: `set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"`

Jetty

Pour passer l'argument -javaagent sur Jetty :

Play

Pour passer l'argument -javaagent sur Play :

Commencez avec une distribution unzipped contenant le script start :
bash
```
$play clean dist && unzip dist/*.zip
```

Ajoutez l’argument -javaagent lors du démarrage de votre application Play :

bash

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

Commencez avec une distribution unzipped contenant le script start :
bash
```
$play clean dist && unzip target/directory/universal/*.zip
```
Ajoutez l’argument -J-javaagent lors du démarrage de votre application Play :
bash
```
$cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar
```
Conseil
Pour activer le temps de chargement des pages, voir Instrumentation manuelle avec Play 2.2.

Commencez avec une distribution unzipped contenant le script start :
bash
```
$activator clean dist && unzip target/directory/universal/*.zip
```
Ajoutez l’argument -J-javaagent lors du démarrage de votre application Play :
bash
```
$cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar
```
Si vous utilisez Typesafe Activator avec Play 2.4, ajoutez cette ligne à votre build.sbt:
```
javaOptions ++= Seq("-javaagent:/full/path/to/newrelic.jar")
```

Resin

Java 8

Option 1 : ajoutez l'argument javaagent via la propriété jvmargs dans le fichier resin.properties du serveur :
```
jvm_args  : -javaagent:/full/path/to/newrelic.jar
```
Option 2 : spécifiez l'argument -javaagent en l'ajoutant à la section <jvm-args> de votre fichier conf/resin.conf ou conf/resin.xml :
```
<jvm-arg>-javaagent:/full/path/to/newrelic.jar</jvm-arg>
```

Java 9 ou supérieur

Le système de modules introduit dans Java 9 peut conduire à l'exception NoClassDefFoundError: java/sql/SQLException si la propriété -javaagent est ajoutée aux fichiers conf/resin.conf ou conf/resin.xml . Si vous utilisez Java 9 ou supérieur, assurez-vous que la propriété -javaagent n'est pas incluse dans ces fichiers.

Resin peut être exécuté sur Java 9 ou supérieur, avec l'agent Java utilisant l'une des options suivantes :

Option 1 : ajoutez l'argument javaagent via la propriété jvmargs dans le fichier resin.properties du serveur :
```
jvm_args  : -javaagent:/full/path/to/newrelic.jar
```
Le serveur Resin peut alors être exécuté avec ./bin/resin.sh start.
Option 2 : Exécutez le pot de résine avec la propriété -javaagent sur la ligne de commande :
bash
```
$java -javaagent:/path/to/newrelic.jar -jar lib/resin.jar start
```

Important

L'agent ne fonctionnera pas avec Resin sous Windows lors de l'utilisation de Java 9 ou supérieur.

Solr

Pour passer l'argument -javaagent sur Solr:

Spring Boot

Pour transmettre l’argument -javaagent sur Spring Boot, ajoutez-le à la ligne de commande dans laquelle vous démarrez votre application. Assurez-vous de l'ajouter avant l'argument -jar :

bash

$java -javaagent:/full/path/to/newrelic.jar -jar app.jar

Emballage Tanuki

Pour passer l'argument -javaagent sur Tanuki Wrapper, ajoutez une option wrapper wrapper.conf. Dans la ligne ci-dessous, remplacez XXX par un numéro inutilisé dans ce fichier :

wrapper.java.additional.XXX=-javaagent:/full/path/to/newrelic.jar

Conseil

Sur le système Linux, aucun guillemet n'est requis lors de la définition de cette valeur. Ce comportement peut varier sur d'autres systèmes d'exploitation.

Tomcat

Pour passer l'argument -javaagent sur Tomcat :

Créez un script CATALINA_BASE/bin/setenv.sh s'il n'existe pas déjà. Configurez votre script setenv.sh pour utiliser l'agent New Relic à l'aide de la variable d'environnement CATALINA_OPTS :

bash

$export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/full/path/to/newrelic.jar"

Créez un script CATALINA_BASE/bin/setenv.bat s'il n'existe pas déjà. Configurez votre script setenv.bat pour utiliser l'agent New Relic à l'aide de la variable d'environnement CATALINA_OPTS :

SET "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:/full/path/to/newrelic.jar"

Conseil

Nous vous recommandons de ne définir aucune variable dans ce script. Au lieu de cela, placez-les dans un script setenv.sh dans CATALINA_BASE/bin pour garder vos personnalisations séparées.

Configurez votre fichier catalina.sh pour utiliser l'agent New Relic à l'aide de la variable d'environnement JAVA_OPTS :

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"

Conseil

Nous vous recommandons de ne définir aucune variable dans ce script. Au lieu de cela, placez-les dans un script setenv.bat dans CATALINA_BASE/bin pour garder vos personnalisations séparées.

Si vous utilisez catalina.bat pour lancer Tomcat, définissez la variable JAVA_OPTS en haut du fichier :

SET JAVA_OPTS=%JAVA_OPTS% -javaagent:/full/path/to/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:/full/path/to/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 utilisé par New Relic. Cependant, une construction du daemon jsvc à partir de la source du trunk prendra en charge l'argument -javaagent via le préfixe -X . Consultez le suivi des bogues Apache pour connaître le problème.

Il existe un correctif dans le référentiel source d'Apache Commons. Pour plus d'informations :

Consultez la documentation du référentiel source Apache.
Accédez directement au référentiel source SVN.

WebLogic

Pour passer l'argument -javaagent sur WebLogic :

Pour l'instance du serveur d'administration, suivez les instructions Linux/macOS ou Windows . Vous ne pouvez pas utiliser la console d’administration pour installer l’instance du serveur d’administration.

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

Depuis la console d’administration, accédez à Environments > Servers > (select a server) > Server Start > Arguments.
À partir de Arguments, ajoutez :
```
-javaagent:/full/path/to/newrelic.jar
```
Enregistrez la page, puis redémarrez votre instance de serveur.

WebSphere

Pour passer l’argument -javaagent sur WebSphere :

Depuis la console d’administration, sélectionnez Servers > Application servers > (select a server) > 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 l'argument -javaagent pour votre fichier newrelic.jar :
```
-javaagent:/full/path/to/newrelic.jar
```
Sélectionnez Apply, puis sélectionnez Save.
Redémarrez votre serveur.

Pour plus d'informations, consultez la documentation sur la collecte des métriques WebSphere PMI.

Communauté WebSphere

Pour transmettre l'argument -javaagent sur WebSphere Community Edition, reportez-vous au fichier jar de l'agent New Relic dans la variable d'environnement JAVA_OPTS lors de l'exécution de la commande de démarrage :

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar" && startup

Profil WebSphere Liberty

Pour transmettre l’argument -javaagent sur WebSphere Liberty Profile :

Modifier ${server.config.dir}/jvm.options.
Ajoutez l'argument -javaagent pour pointer vers votre fichier newrelic.jar :
```
-javaagent:/full/path/to/newrelic.jar
```
Redémarrez votre serveur.

Wildfly

Pour passer l'argument -javaagent sur Wildfly (si vous utilisez Wildfly 11 ou supérieur, consultez les instructions d'installation supplémentaires) :

Modifiez les propriétés JVM de votre groupe de serveurs, situées dans :
```
domain/configuration/domain.xml
```

Modifiez les propriétés pour inclure l’argument -javaagent :

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

plateforme	Instructions
Unix ou macOS	Au bas de `bin/standalone.conf`, ajoutez : `JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"`
Windows	Dans `bin/standalone.bat`, recherchez cette ligne : `rem Setup JBoss specific properties` Ajoutez ensuite : `set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"`

plateforme

Instructions

Unix ou macOS

Au bas de bin/standalone.conf, ajoutez :

JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"

Windows

Dans bin/standalone.bat, recherchez cette ligne :

rem Setup JBoss specific properties

Ajoutez ensuite :

set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"

Autres serveurs application

L'agent Java New Relic fonctionne sur n'importe quel serveur d'applications pris en charge. Si votre serveur d'applications n'est pas répertorié dans ce document, suivez les procédures standard pour que votre serveur d'applications transmette cet argument à la JVM avant le fichier jar de l'application :

-javaagent:/full/path/to/newrelic.jar

Cette traduction automatique est fournie pour votre commodité.

Inclure l'agent Java avec un argument JVM

ColdFusion .css-21sua1{background:none;border:none;width:0;padding:0;}

Geronimo

Glassfish

Important

Grails

Passer avec run-war

JBoss

Définir avec le mode domaine (6.x EAP et 7.0 AS)

Ensemble avec mode autonome (autres versions)

Jetty

Si vous définissez exec dans jetty.sh

Si vous définissez exec dans start.ini

Play

Play 1.2.4

Play 2.0

Play 2.2

Play versions 2.3, 2.4 et 2.5

Resin

Important

Solr

Solr 5.x autonome ou supérieur

Solr 4.x autonome ou inférieur

Serveur d'applications Solr

Spring Boot

Emballage Tanuki

Conseil

Tomcat

Avec setenv.sh

Avec setenv.bat

Avec catalina.sh (NON RECOMMANDÉ)

Avec catalina.bat (NON RECOMMANDÉ)

Avec Windows

Avec le daemon Apache Commons

WebLogic

Serveurs d'administration sous Linux ou macOS

Serveurs d'administration sous Windows

Instance de serveur gérée

WebSphere

Communauté WebSphere

Profil WebSphere Liberty

Wildfly

Définir avec le mode domaine

Définir avec le mode autonome

Autres serveurs application

ColdFusion

Si vous définissez exec dans `jetty.sh`

Si vous définissez exec dans `start.ini`