JVMの引数にJavaエージェントを含める

このドキュメントでは、お使いのフレームワーク用のJVMに-javaagent引数を渡す方法を説明します。このインストール手順に従うと、アプリケーション内にエージェントを確実に含めることができます。すべてのアプリケーションサーバーに対して、newrelic.jarファイルへのフルパスを渡すようにしてください。

このドキュメントは、単に引数の渡し方を説明するための参考資料です。詳細なインストール手順については、「Javaエージェントのインストレーション」をご覧ください。

Coldfusion

Coldfusionで-javaagent引数を渡すには、次の手順を実行します:

  1. ColdFusionサーバーを起動して、ColdFusionアドミンコンソールに移動します。
  2. 左側のメニューから、SERVER SETTINGS > Java and JVM を選択します。
  3. エージェントAPIを使用している場合:ColdFusion Class Pathフィールドでnewrelic-api.jarへのパスを指定します。
  4. JVM Argumentsフィールドに-javaagent引数を追加します:

    -javaagent:/full/path/to/newrelic.jar
  5. 変更の送信を選択し、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引数を渡すには、次の手順を実行します:

  1. Glassfishのコンソールから、Application Server > JVM Settings > JVM Optionsを選択します。

  2. JVMオプションページで、Add JVM Optionを選択します。

  3. -javaagentエージェントに対してエントリを追加します:

    -javaagent:/full/path/to/newrelic.jar
  4. 保存してGlassfishを再起動します。

Glassfishが起動しない場合は、-javaagent引数が正しく設定されていない可能性があります。サーバーJVM引数は、domain.xmlファイルを編集することで変更できます。

Glassfish 2.1のバグにより、ブートストラップクラスローダーが読み込んだクラス(New Relicエージェント)ではJavaロギングAPIを使用できません。この問題は、2.1.1以上のリリースでは修正されているようです。

Grails

Grailsで-javaagent引数を渡すには、次の手順を実行します:

run-appで渡す
  1. 解凍されたバージョンのGrailsで開始します。
  2. 以下のコマンドを実行します。

    grails -noreloading -javaagent:/full/path/to/newrelic.jar run-app
run-warで渡す
  1. Grailsアプリケーションで、以下のファイルをテキストエディタで開きます。

    grails-app/conf/BuildConfig.groovy
  2. 以下のようにJVMの引数行に追加、または編集を行います。

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

JBoss

JBossで-javaagent引数を渡すには、次の手順を実行します:

ドメインモードでの設定(6.x EAPおよび7.0 AS)

JBossバージョン6.x EAPおよび7.0 AS以上では、ドメインモードを使用します。

  1. 以下のファイルに定義されているサーバーグループのJVM属性を編集します。

    domain/configuration/domain.xml
  2. プロパティを変更して-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>

7.0.2.Finalと7.1.0.Alpha1のJBossバグは、domain.xmlでのJVMオプションの設定を許可しません。この問題に遭遇した場合は、JBossアプリケーションサーバーをアップグレードしてください。

スタンドアロンモードでの設定(その他のバージョン)

その他のプラットフォームやバージョンでは、スタンドアロンモードを使用します。

プラットフォーム 手順

6.x EAPまたは7.0.x AS以上のUnix / Mac OS

bin/standalone.confの最終行に、以下の行を追加します。

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

6.x EAPまたは7.0.x AS以降のWindows

bin/standalone.batの以下の行の前に:

set JBOSS_ENDORSED_DIRS=%JBOSS_HOME%\lib\endorsed

以下の行を追加します。

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

6.x以前のUnix / Mac OS

bin/run.confの最終行に、以下の行を追加します。

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

6.x以前のWindows

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でexecを設定する場合

jetty.shスクリプトでJAVA_OPTIONSを編集します:

export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/full/path/to/newrelic.jar"
start.iniでexecを設定する場合

start.ini設定ファイルにエージェントのパスを追加します:

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

Play

Playで-javaagent引数を渡すには、次の手順を実行します:

Play 1.2.4

Playアプリケーションを実行するときに-javaagent引数を付加します:

play run your_app_name -javaagent:/full/path/to/newrelic.jar
Play 2.0
  1. startスクリプトを含む解凍済みの配布ファイルから開始します:

    play clean dist && unzip dist/*.zip
  2. Playアプリケーションを起動するときに-javaagent引数を付加します:

    cd unzipped/folder; chmod a+x start; ./start -javaagent:/full/path/to/newrelic.jar
Play 2.2
  1. startスクリプトを含む解凍済みの配布ファイルから開始します:

    play clean dist && unzip target/directory/universal/*.zip
  2. Playアプリケーションを起動するときに-J-javaagent引数を付加します:

    cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar

ページロードタイミングを有効化するには、「Play 2.2での手動インストゥルメンテーション」をご覧ください。

Play 2.3、2.4、2.5
  1. startスクリプトを含む解凍済みの配布ファイルから開始します:

    activator clean dist && unzip target/directory/universal/*.zip
  2. Playアプリケーションを起動するときに-J-javaagent引数を付加します:

    cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar
  3. Play 2.4でTypesafe Activatorをお使いの場合は、この行をbuild.sbtに追加します:

    javaOptions ++= Seq("-javaagent:/full/path/to/newrelic.jar")

Resin

Resinで-javaagent引数を渡すには、この引数をresin.confまたはresin.xmlファイルの<jvm-args>セクションに追加します:

<jvm-arg>-javaagent:/full/path/to/newrelic.jar</jvm-arg>

Solr

Solrで-javaagent引数を渡すには、次の手順を実行します:

スタンドアロンのSolr 5.x以上

-javaagentプロパティをbin/solr.in.shに追加します:

SOLR_OPTS="$SOLR_OPTS -javaagent:/full/path/to/newrelic.jar"
スタンドアロンのSolr 4.x以下

-javaagentstart.jarの前に追加します:

java -javaagent:/full/path/to/newrelic.jar -jar start.jar
アプリケーションサーバーのSolr

アプリケーションサーバーで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.shの場合

JAVA_OPTS環境変数を使用して、New Relicエージェントを使用するようにcatalina.shファイルを設定します:

export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"
catalina.batの場合

Tomcatの起動にcatalina.batを使用する場合は、JAVA_OPTS変数をファイルの先頭付近に設定します:

SET JAVA_OPTS=%JAVA_OPTS% -javaagent:/full/path/to/newrelic.jar
Windowsの場合
  1. Start > Apache Tomcat X.Y.Z. > Configure Tomcat > Javaと選択します。
  2. Javaオプションテキストボックスに、引数を入力します。パスの区切り文字には、フォワードスラッシュ「/」を使用します。Tomcat 6の場合は、-javaagent引数の後に改行を追加します。

    -javaagent:/full/path/to/newrelic.jar
  3. Applyを選択し、Tomcatを再起動します。
Apache Commons Daemonの場合

Tomcat 6に含まれているApache Commons Daemon(jsvc)は、New Relicが使用する-javaagent引数をサポートしません。ただし、trunkソースからのjsvcデーモンのビルドは、-Xプレフィックスで-javaagent引数をサポートします。「問題を追跡中のApacheバグ」をご覧ください。

Apache Commonsのソースリポジトリでは修正が行われています。詳細について:

WebLogic

WebLogicで-javaagent引数を渡すには、次の手順を実行します:

管理サーバー(LinuxまたはMacOS)
  1. ドメインのbinディレクトリにあるstartWebLogic.shファイルを編集します。
  2. 該当ファイルの先頭付近に、以下の行を追加します。

    export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/full/path/to/newrelic.jar"
管理サーバー(Windows)
  1. ドメインのbinディレクトリにあるstartWebLogic.batファイルを編集します。
  2. 該当ファイルの先頭付近に、以下の行を追加します。

    set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:"C:\full\path\to\newrelic.jar"
管理対象サーバー・インスタンス

管理サーバーのインスタンスについては、Linux/MacOSまたはWindowsの手順に従ってください。管理コンソールを使用して、管理サーバーのインスタンスをインストールすることはできません。

管理対象サーバーのインスタンスについては、アドミンコンソールを使用します。

  1. アドミンコンソールから、Environments > Servers > (サーバーを選択) > Server Start > Argumentsに移動します。

  2. 引数から、以下を追加します。

    -javaagent:/full/path/to/newrelic.jar
  3. ページの内容を保存して、サーバーインスタンスを再起動します。

WebSphere

WebSphereで-javaagent引数を渡すには、次の手順を実行します:

  1. アドミンコンソールから、Servers > Application servers > (サーバーを選択) > Configuration > Service Infrastructure > Java and Process Managementを選択します。
  2. Process Definition > Additional Propertiesを選択し、Java Virtual Machineを選択します。
  3. Generic JVM argumentsフィールドに、newrelic.jarファイル用の-javaagent引数を追加します:

    -javaagent:/full/path/to/newrelic.jar
  4. 適用 を選択し、保存を選択します。
  5. サーバーを再起動します。

詳細については、「WebSpherePMIメトリックスの収集」に関するドキュメントをご覧ください。

WebSphere Community

WebSphere Community Editionで-javaagent引数を渡すには、startupコマンドを実行するときに、JAVA_OPTS環境変数でNew Relic エージェントのjarを参照します:

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

WebSphere Libertyプロファイル

WebSphere Libertyプロファイルで-javaagent引数を渡すには、次の手順を実行します:

  1. ${server.config.dir}/jvm.optionsを編集します。

  2. newrelic.jarファイルをポイントするように-javaagent引数を追加します。

    -javaagent:/full/path/to/newrelic.jar
  3. サーバーを再起動します。

Wildfly

Wildflyで-javaagent引数を渡すには(Wildfly 11以降をお使いの場合は、追加のインストール手順を参照):

ドメインモードで設定する
  1. 以下のファイルに定義されているサーバーグループのJVM属性を編集します。

    domain/configuration/domain.xml
  2. プロパティを変更して-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またはMac OS

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

その他のヘルプ

推奨する詳細情報: