このドキュメントでは、フレームワーク用のJVMに-javaagent
引数を渡す方法を説明します。このインストール手順に従うと、アプリにエージェントを確実に含めることができます。すべてのアプリサーバーに、newrelic.jar
ファイルへのフルパスを渡すようにしてください。
このドキュメントは、単に引数の渡し方を説明するための参照資料です。インストレーション手順の詳細については、Javaエージェントのインストレーションを参照してください。
ColdFusion
ColdFusionで-javaagent
引数をパスする場合は、次の手順に従います。
ColdFusionサーバーを起動して、ColdFusionアドミンコンソールに移動します。
左側のメニューから、サーバー設定 > JavaおよびJVMを選択します。
エージェントAPIを使用している場合: ColdFusionクラスパスフィールドでnewrelic-api.jar
へのパスを指定します。
JVM引数フィールドに、-javaagent
引数を追加します。
-javaagent:/full/path/to/newrelic.jar
変更の送信を選択し、ColdFusionサーバーを再起動します。
Geronimo
Geronimoで-javaagent
引数をパスする場合は、startupコマンドを実行中に、JAVA_OPTS
環境変数内のNew Relic agent jarを参照します。
export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar" && geronimo run
Glassfish
Glassfishで-javaagent
引数をパスする場合は、次の手順に従います。
Glassfishのコンソールから、アプリケーションサーバー > JVM設定 > JVMオプションを選択します。
JVMオプションページで、JVMオプションの追加を選択します。
-javaagent
引数のエントリの追加:
-javaagent:/full/path/to/newrelic.jar
保存して、Glassfishを再起動します。
Glassfishが起動しない場合は、-javaagent
引数が正しく設定されていない可能性があります。サーバーJVM引数は、domain.xml
ファイルを編集することで変更できます。
重要
Glassfish 2.1のバグにより、ブートストラップクラスローダーが読み込んだクラス(New Relicエージェント)ではJavaロギングAPIを使用できません。この問題は、2.1.1以上のリリースでは修正されているようです。
Grails
Grailsで-javaagent
引数をパスする場合は、次の手順に従います。
解凍されたバージョンのGrailsで開始します。
以下のコマンドを実行します。
grails -noreloading -javaagent:/full/path/to/newrelic.jar run-app
Grailsアプリで、このファイルをテキストエディタで開きます。
grails-app/conf/BuildConfig.groovy
JVM引数行の追加または編集:
grails.tomcat.jvmArgs = ["-javaagent:/full/path/to/newrelic.jar"]
JBoss
JBossで-javaagent
引数をパスする場合は、次の手順に従います。
JBossバージョン6.x EAPおよび7.0 AS以上では、ドメインモードを使用します。
以下にあるサーバーグループのJVM属性を編集します。
domain/configuration/domain.xml
プロパティを変更し、-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>
その他のプラットフォームおよびバージョンには、スタンドアロンモードを使用します。
プラットフォーム | 手順 |
---|
Unix / macOS、6.x EAPまたは7.0.xAS以上 | bin/standalone.conf の最終行に以下を追加します。
JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"
|
Windows、6.x EAPまたは7.0.x AS以上 | bin/standalone.bat では、行前:
set JBOSS_ENDORSED_DIRS=%JBOSS_HOME%\lib\endorsed
以下を追加します。 set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"
|
Unix / MacOS、6.x以下 | bin/run.conf の最終行に以下を追加します。
JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"
|
Windows、6.x以下 | bin/run.bat では、行前:
set JBOSS_CLASSPATH=%RUN_CLASSPATH%
以下を追加します。 set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"
|
Jetty
Jettyで-javaagent
引数をパスする場合は、次の手順に従います。
jetty.sh
スクリプトでJAVA_OPTIONS
を編集します。
export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/full/path/to/newrelic.jar"
start.ini
設定ファイルにエージェントのパスを追加します。
-javaagent:/full/path/to/newrelic.jar
Play
Playで-javaagent
引数をパスする場合は、次の手順に従います。
Playアプリケーションを実行中に、-javaagent
引数を付加します。
play run your_app_name -javaagent:/full/path/to/newrelic.jar
start
スクリプトを含む解凍済みの配布ファイルから開始します。
play clean dist && unzip dist/*.zip
Playアプリ起動時に、-javaagent
引数を付加します。
cd unzipped/folder; chmod a+x start; ./start -javaagent:/full/path/to/newrelic.jar
start
スクリプトを含む解凍済みの配布ファイルから開始します。
play clean dist && unzip target/directory/universal/*.zip
Playアプリ起動時に、-J-javaagent
引数を付加します。
cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar
start
スクリプトを含む解凍済みの配布ファイルから開始します。
activator clean dist && unzip target/directory/universal/*.zip
Playアプリ起動時に、-J-javaagent
引数を付加します。
cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar
Play 2.4でTypesafe Activatorをお使いの場合は、この行をbuild.sbt
に追加します。
javaOptions ++= Seq("-javaagent:/full/path/to/newrelic.jar")
Resin
Java 8
Resinで-javaagent
引数を渡すには、この引数をconf/resin.conf
またはconf/resin.xml
ファイルの<jvm-args>
セクションに追加します。
<jvm-arg>-javaagent:/full/path/to/newrelic.jar</jvm-arg>
Java 9以降
Java 9で導入されたモジュールシステムは、-javaagent
プロパティがconf/resin.conf
またはconf/resin.xml
ファイルに追加された場合に例外NoClassDefFoundError: java/sql/SQLException
を引き起こす可能性があります。Java 9以降を使用している場合は、-javaagent
プロパティがこれらのファイルに含まれていないことを確認してください。
ResinはJava 9以降で実行でき、Javaエージェントは次のいずれかのオプションを使用します。
- オプション1 - コマンドラインで
-javaagent
プロパティを指定します。
java -javaagent:/path/to/newrelic.jar -jar lib/resin.jar start
- オプション2 -
bin/resin.sh
スクリプトに-javaagent
プロパティを追加します。
bin/resin.sh
スクリプトに-javaagent
プロパティを直接追加し、この行exec $JAVA_EXE -jar lib/resin.jar $@
を以下のように変更します。
exec $JAVA_EXE -javaagent:/path/to/newrelic/newrelic.jar -jar lib/resin.jar $@
Resinサーバーは./bin/resin.sh start
で実行できます。
Solr
Solrで-javaagent
引数をパスする場合は、次の手順に従います。
-javaagent
プロパティをbin/solr.in.sh
に追加します。
SOLR_OPTS="$SOLR_OPTS -javaagent:/full/path/to/newrelic.jar"
start.jar
の前に-javaagent
を追加します。
java -javaagent:/full/path/to/newrelic.jar -jar start.jar
アプリケーションサーバーでSolrを実行する際は、該当するアプリケーションサーバーの手順に従って、-javaagent
フラグを追加してください。また、アプリケーションサーバーでJMXが有効化されていることを確認します。APM UIのSolrページにデータが表示されない場合は、Solrデータのトラブルシューティング手順に従ってください。
Spring Boot
Spring Bootで-javaagent
引数をパスするには、アプリを起動するコマンドラインにこの引数を追加します。この引数は、-jar
引数の前に追加するようにしてください。
java -javaagent:/full/path/to/newrelic.jar -jar app.jar
Tanuki Wrapper
Tanuki Wrapperで-javaagent
引数をパスするには、wrapperオプションwrapper.conf
を追加します。下の行で、このファイルで未使用の番号をXXX
に置き換えます。
wrapper.java.additional.XXX=-javaagent:/full/path/to/newrelic.jar
ヒント
Linuxシステムでは、この値を設定する際に引用符は不要です。この動作は、他のオペレーティングシステムでは異なる場合があります。
Tomcat
Tomcatで-javaagent
引数をパスする場合は、次の手順に従います。
スクリプトが存在しない場合は、CATALINA_BASE/bin/setenv.sh
スクリプトを作成します。CATALINA_OPTS
環境変数を使用して、New Relicエージェントを使用できるように、setenv.sh
スクリプトを設定します。
export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/full/path/to/newrelic.jar"
スクリプトが存在しない場合は、CATALINA_BASE/bin/setenv.bat
スクリプトを作成します。CATALINA_OPTS
環境変数を使用して、New Relicエージェントを使用できるように、setenv.bat
スクリプトを設定します。
SET "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:/full/path/to/newrelic.jar"
ヒント
このスクリプトでは変数は設定しないことを推奨します。代わりに、スクリプトsetenv.sh
をCATALINA_BASE/bin
に配置し、カスタマイズを別に保管します。
JAVA_OPTS
環境変数を使用して、New Relicエージェントを使用できるように、catalina.sh
ファイルを設定します。
export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"
ヒント
このスクリプトでは変数は設定しないことを推奨します。代わりに、スクリプトsetenv.bat
をCATALINA_BASE/bin
に配置し、カスタマイズを別に保管します。
Tomcatの起動にcatalina.bat
を使用する場合は、JAVA_OPTS
変数をファイルの先頭付近に設定します。
SET JAVA_OPTS=%JAVA_OPTS% -javaagent:/full/path/to/newrelic.jar
起動 > Apache Tomcat X.Y.Z. > Tomcatの設定 > Javaを選択します。
Javaオプションテキストボックスに、引数を入力します。パスの区切り文字には、フォワードスラッシュ/
を使用します。Tomcat 6の場合は、-javaagent
引数の後に改行を追加します。
-javaagent:/full/path/to/newrelic.jar
適用を選択し、Tomcatを再起動します。
Tomcat 6に含まれているApache Commons Daemon(jsvc)のバージョンでは、New Relicが使用する-javaagent
引数はサポートされていません。ただし、trunkソースからのjsvcデーモンのビルドは、-X
プレフィックスで-javaagent
引数をサポートします。Apacheバグで問題を追跡を参照してください。
Apache Commonsのソースリポジトリには修正があります。詳細については、
WebLogic
WebLogicで-javaagent
引数をパスする場合は、次の手順に従います。
ドメインのbin
ディレクトリにあるstartWebLogic.sh
ファイルを編集します。
ファイルの先頭付近に、以下を追加します。
export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/full/path/to/newrelic.jar"
ドメインのbin
ディレクトリにあるstartWebLogic.bat
ファイルを編集します。
ファイルの先頭付近に、以下を追加します。
set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:"C:\full\path\to\newrelic.jar"
管理サーバーのインスタンスについては、Linux/MacOSまたはWindowsの手順に従ってください。管理コンソールを使用して、管理サーバーのインスタンスをインストールすることはできません。
管理対象サーバーのインスタンスについては、アドミンコンソールを使用します。
管理コンソールから、環境 > サーバー > (サーバーを選択) > サーバー起動 > 引数に移動します。
引数から、以下を追加します。
-javaagent:/full/path/to/newrelic.jar
ページの内容を保存して、サーバーインスタンスを再起動します。
WebSphere
WebSphereで-javaagent
引数をパスする場合は、次の手順に従います。
アドミンコンソールから、サーバー > アプリケーションサーバー > (サーバーを選択) > 設定 > サービスインフラストラクチャ > Javaおよびプロセス管理を選択します。
プロセス定義 > 追加プロパティを選択し、Java仮想マシンを選択します。
汎用JVM引数フィールドに、newrelic.jar
ファイル用の-javaagent
引数を追加します。
-javaagent:/full/path/to/newrelic.jar
適用 を選択し、保存を選択します。
サーバーを再起動します。
詳細については、WebSphere PMIメトリクスの収集に関するドキュメントを参照してください。
WebSphereコミュニティエディションで、-javaagent
引数をパスする場合は、startupコマンド実行時に、JAVA_OPTS
環境変数でNew Relic エージェントのjarを参照します。
export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar" && startup
WebSphere Libertyプロファイル
WebSphere Libertyプロファイルで-javaagent
引数をパスする場合は、次の手順に従います。
${server.config.dir}/jvm.options
を編集します。
newrelic.jar
ファイルを指す-javaagent
引数を追加します。
-javaagent:/full/path/to/newrelic.jar
サーバーを再起動します。
Wildfly
Wildflyで-javaagent
引数をパスする場合は(Wildfly 11以上を使用中の場合、追加インストール手順を参照してください)。
以下にあるサーバーグループのJVM属性を編集します。
domain/configuration/domain.xml
プロパティを変更し、-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>
プラットフォーム | 手順 |
---|
UnixまたはMacOS | bin/standalone.conf の最終行に以下を追加します。
JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"
|
Windows | bin/standalone.bat で、以下の行を探します。
rem Setup JBoss specific properties
その後、以下を追加します。 set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"
|
その他のアプリケーションサーバー
New Relic Javaエージェントは任意のサポート対象のアプリサーバーで動作します。アプリサーバーがこのドキュメントに記載されていない場合は、アプリサーバーの標準手順に従い、この引数をアプリjarの前のJVMにパスしてください。
-javaagent:/full/path/to/newrelic.jar