Mavenを使用したJavaエージェントのインストール

このページでは、Mavenを使用してNew Relic Javaエージェントをインストールする方法について説明します。Mavenはビルドの依存関係としてnewrelic-java.zipをダウンロードして展開し、エージェントファイルをビルドディレクトリに自動的に配置します。

互換性および要件

サポート対象

Java 8、11、17、21、24、25、および26（Java 7はエージェント6.5.4以前でのみサポート）
Maven 3.x
maven-dependency-plugin 3.1.1 以降
-javaagent引数を受け入れる、サポートされている任意のアプリケーションサーバーまたはスタンドアロンJVMプロセス
サポートされているフレームワークおよびライブラリのバージョン範囲については、互換性と要件をご覧ください

サポートされていない

他のAPMエージェントとの並行稼働 — 同じJVM内で別のAPMエージェントがアクティブな場合、Javaエージェントの正常な動作は保証されません。

必要なもの

New Relicアカウントおよび
SHA-2（256ビット）SSLをサポートするJVM
次を含むMavenプロジェクト： pom.xml

インストール

次をダウンロードするようMavenを設定： `newrelic-java.zip`

pom.xmlにprovided依存関係としてJavaエージェントを追加します。JAVA_AGENT_VERSIONを最新のJavaエージェントバージョンに置き換えます。

<dependency>
    <groupId>com.newrelic.agent.java</groupId>
    <artifactId>newrelic-java</artifactId>
    <version>JAVA_AGENT_VERSION</version>
    <scope>provided</scope>
    <type>zip</type>
</dependency>

エージェントを解凍するようMavenを設定

エージェントのzipファイルをビルドディレクトリに展開するには、pom.xmlの<build><plugins>セクションにmaven-dependency-pluginを追加します。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>3.1.1</version>
    <executions>
        <execution>
            <id>unpack-newrelic</id>
            <phase>package</phase>
            <goals>
                <goal>unpack-dependencies</goal>
            </goals>
            <configuration>
                <includeGroupIds>com.newrelic.agent.java</includeGroupIds>
                <includeArtifactIds>newrelic-java</includeArtifactIds>
                <overWriteReleases>false</overWriteReleases>
                <overWriteSnapshots>false</overWriteSnapshots>
                <overWriteIfNewer>true</overWriteIfNewer>
                <outputDirectory>${project.build.directory}</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

mvn packageを実行すると、target/に次の内容を含むnewrelic/フォルダーが表示されます。

newrelic.jar — Javaエージェント
newrelic.yml — エージェント設定ファイル
newrelic-api.jar — JavaエージェントAPIのjar
README

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example.application</groupId>
    <artifactId>my-example-app</artifactId>
    <packaging>war</packaging>
    <version>1.0</version>
    <name>My Example Application</name>
    <dependencies>
        <dependency>
            <groupId>com.newrelic.agent.java</groupId>
            <artifactId>newrelic-java</artifactId>
            <version>JAVA_AGENT_VERSION</version>
            <scope>provided</scope>
            <type>zip</type>
        </dependency>
    </dependencies>
    <build>
        <finalName>my-example-app</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.2.2</version>
                <configuration>
                    <failOnMissingWebXml>false</failOnMissingWebXml>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>3.1.1</version>
                <executions>
                    <execution>
                        <id>unpack-newrelic</id>
                        <phase>package</phase>
                        <goals>
                            <goal>unpack-dependencies</goal>
                        </goals>
                        <configuration>
                            <includeGroupIds>com.newrelic.agent.java</includeGroupIds>
                            <includeArtifactIds>newrelic-java</includeArtifactIds>
                            <overWriteReleases>false</overWriteReleases>
                            <overWriteSnapshots>false</overWriteSnapshots>
                            <overWriteIfNewer>true</overWriteIfNewer>
                            <outputDirectory>${project.build.directory}</outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

次を渡す： `-javaagent`

アプリケーションの起動時に、newrelic.jarを指す-javaagent JVM引数を追加します。具体的な方法はアプリケーションサーバーによって異なります — サーバー固有の手順については、サーバーに応じたJVM引数を渡すを参照してください。

たとえば、Spring Boot jarの場合は次のようになります。

bash

$java -javaagent:/path/to/target/newrelic/newrelic.jar -jar my-example-app.jar

設定

target/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）をご覧ください。