このページでは、Gradleを使用してNew Relic Javaエージェントをインストールする方法について説明します。de.undercouch.downloadプラグインを利用したGradleタスクが、newrelic-java.zipを取得し、プロジェクトディレクトリに展開します。
互換性および要件
サポート対象
- Java 8、11、17、21、24、25、および26(Java 7はエージェント6.5.4以前でのみサポート)
- Gradle 6.x以降
de.undercouch.downloadプラグインバージョン5.3.0以降-javaagent引数を受け入れる、サポートされている任意のアプリケーションサーバーまたはスタンドアロンJVMプロセス- サポートされているフレームワークおよびライブラリのバージョン範囲については、互換性と要件をご覧ください
サポートされていない
- 他のAPMエージェントとの並行稼働 — 同じJVM内で別のAPMエージェントがアクティブな場合、Javaエージェントの正常な動作は保証されません。
必要なもの
- New Relicアカウントおよび
- SHA-2(256ビット)SSLをサポートするJVM
- 次を含むGradleプロジェクト:
build.gradle
インストール
ダウンロードプラグインを追加する
build.gradleのpluginsブロックにde.undercouch.downloadプラグインを追加します。
plugins { id "de.undercouch.download" version "5.3.0"}ダウンロードと解凍のタスクを追加する
build.gradleに2つのタスクを追加します — 1つはエージェントのzipをダウンロードするタスク、もう1つはそれを展開するタスクです。
task downloadNewrelic(type: Download) { mkdir 'newrelic' src 'https://download.newrelic.com/newrelic/java-agent/newrelic-agent/current/newrelic-java.zip' dest file('newrelic')}
task unzipNewrelic(type: Copy) { from zipTree(file('newrelic/newrelic-java.zip')) into rootDir}これにより、プロジェクトルートのnewrelic/ディレクトリにエージェントファイルが配置されます。このディレクトリには以下が含まれます。
newrelic.jar— Javaエージェントnewrelic.yml— エージェント設定ファイルnewrelic-api.jar— JavaエージェントAPIのjarREADME
タスクを実行する
エージェントをダウンロードして展開するために、両方のタスクを実行してください。
$./gradlew downloadNewrelic$./gradlew unzipNewrelic次を渡す: -javaagent
アプリケーションの起動時に、newrelic.jarを指す-javaagent JVM引数を追加します。具体的な方法はアプリケーションサーバーによって異なります — サーバー固有の手順については、サーバーに応じたJVM引数を渡すを参照してください。
たとえば、Spring Boot jarの場合は次のようになります。
$java -javaagent:/path/to/newrelic/newrelic.jar -jar my-app.jar設定
newrelic/newrelic.ymlを編集して、次の必須の2つの値を設定してください。
license_key: 'YOUR_LICENSE_KEY'app_name: 'My Application'エージェントは起動時に、newrelic.jarと同じディレクトリからnewrelic.ymlを読み取ります。Javaシステムプロパティを使用して任意の設定を上書きすることもできます(例:-Dnewrelic.config.license_key=YOUR_KEY)。または環境変数を使用することもできます。
利用可能なすべてのオプションについては、Javaエージェントの設定をご覧ください。
インストールの確認
アプリケーションを再起動します。少なくとも2回リクエストを送信してから2~3分待つと、アプリがAPM & servicesに表示されます。
5分経過してもデータが表示されない場合は、データが表示されない(Java)をご覧ください。