Java：コンテキストでログを構成する

これは最も単純なアプローチであり、ログフォワーダーの設定にアクセスしたり関心を持ったりしていない開発者や、アプリのコンテキストでログやその他のリンクメタデータの機能を確認したいアカウントに最適です。多くのオーバーヘッド。

このオプションを使用すると、ログにspan.id 、 trace.id 、 hostname 、 entity.guid 、およびentity.nameが含まれます。これらの属性は、ログをスパン、トレース、およびその他のテレメトリに自動的にリンクし、トラブルシューティングを容易にします。

この機能はデフォルトで有効になっています。

ログ転送機能を備えたエージェントバージョン（ Javaエージェント7.6.0以降）をインストールし、設定を更新して転送を有効にするだけです。

構成ファイル（ newrelic.yml ）、共通スタンザの下に2つのスペースをインデントします。

application_logging:
  enabled: true
  forwarding:
    enabled: true
    max_samples_stored: 10000 
  local_decorating: 
    enabled: false

環境変数：

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED=10000
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=false

システムプロパティ：

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=true
-Dnewrelic.config.application_logging.forwarding.max_samples_stored=10000
-Dnewrelic.config.application_logging.local_decorating.enabled=false

オプションの調整（max_samples_stored）：

この機能を有効にすると、1分ごとにNewRelicに送信されるログ行の最大数も制御できます。デフォルト値は10,000です。エージェントが60秒のウィンドウで10,000を超えるログ行を確認すると、ログのサンプリングが開始されます。

より多くのログを受信するには、より大きな数値に設定します。受け取るログの数を減らすには、数値を小さく設定します。負でない整数はすべて有効です。

構成ファイル（ newrelic.yml ）：

application_logging:
  enabled: true
  forwarding:
    enabled: true
      max_samples_stored: 10000
  local_decorating: 
    enabled: false

環境変数：

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED=10000
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=false

システムプロパティ：

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=true
-Dnewrelic.config.application_logging.forwarding.max_samples_stored=10000
-Dnewrelic.config.application_logging.local_decorating.enabled=false

あなたが好きなログフォワーダーをすでに持っていますか？私たちはあなたをカバーしています！Javaエージェントは、自動ログインコンテキスト機能へのアクセスを提供するために必要なリンクメタデータでログを装飾でき、手動ログフォワーダーを使用してそれらをNewRelicに送信できます。

エージェントの構成を更新してログ転送を無効にし、ローカルデコレーションを有効にしてから、エージェントを再起動してログのデコレーションを開始します。

構成ファイル（ newrelic.yml ）、共通スタンザの下に2つのスペースをインデントします。

application_logging:
   enabled: true
   local_decorating: 
     enabled: true
   forwarding:
     enabled: false

環境変数：

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=false

システムプロパティ：

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.local_decorating.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=false

デコレータは、アプリケーションログファイルのすべてのログメッセージに、 entity.guid 、 hostname 、 trace.id 、 span.id 、 entity.nameの5つの属性を追加します。例：

This is my log message. NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|

ログがトランザクションの外部で発生した場合、またはアプリケーションのコンテキストに適用できない場合、一部の属性は空になる可能性があります。

Javaエージェントとのコンテキストでログ用のDropwizard拡張機能を提供します。開始するには、GitHubのコードとサンプルアプリケーションを確認してください。

DropWizard拡張機能を使用してJavaアプリのコンテキストでログを構成するには：

1. Dropwizard 1.3以降のパッケージがインストールされ、アプリケーションで動作していることを確認してください。インストールされ、アプリケーションで動作している元のDropwizardアペンダーとロギングファクトリを使用します。

2. アプリケーションにNewRelicJavaエージェントバージョン5.6.0以降がインストールされていること、およびJVM引数-javaagentが有効になっていることを確認してください。

3. プロジェクトの依存関係を更新して、必要に応じてDropwizard1.3拡張機能を含めます。

   Gradle： build.gradleファイルに以下を追加します。

   dependencies {
       implementation("com.newrelic.logging:dropwizard:2.0")
       }

   コピー

   Maven： pom.xmlファイルに以下を追加します。

   <dependencies>
       <dependency>
           <groupId>com.newrelic.logging</groupId>
           <artifactId>dropwizard</artifactId>
           <version>2.0</version>
       </dependency>
   </dependencies>

   コピー

4. Dropwizard .yaml構成ファイルをnewrelic-jsonレイアウトで更新し、現在使用されているtype: consoleまたはtype: fileを必要に応じてtype: newrelic-consoleまたはtype: newrelic-fileに置き換えます。例えば：

   logging:
     appenders:
       - type: newrelic-console
         # Add the two lines below if you don't have a layout specified on the appender.
         # If you have a layout, remove all parameters to the layout and set the type.
         layout:
           type: newrelic-json

   コピー

   New Relic Dropwizard拡張機能は、標準のDropwizardログを使用するlog-formatレイアウトタイプもサポートしています。テストの目的で、1行の変更でレイアウトのタイプを変更できます。

   logging:
     appenders:
       - type: newrelic-file
         # This format will be ignored by the newrelic-json layout, but used by the log-format layout.
         logFormat: "%date{ISO8601} %c %-5p: %m trace.id=%mdc{trace.id} span.id=%mdc{span.id}%n"
         layout:
           # type: newrelic-json
           type: log-format

   コピー

Javaエージェントとのコンテキストでログ用のjava.util.logging拡張子を提供します。開始するには、GitHubのコードとサンプルアプリケーションを確認してください。

java.util.logging拡張子の付いたJavaアプリのコンテキストでログを構成するには：

1. java.util.loggingパッケージがインストールされ、アプリケーションで動作していることを確認してください。

2. アプリケーションにNewRelicJavaエージェントバージョン5.6.0以降がインストールされていること、およびJVM引数-javaagentが有効になっていることを確認してください。

3. プロジェクトの依存関係を更新して、必要に応じてjava.util.logging拡張子を含めます。これらのファイルを編集できない場合は、代わりにjarをアプリケーションclasspathに直接追加できます。

   Gradle： build.gradleファイルに以下を追加します。

   dependencies {
     implementation("com.newrelic.logging:jul:2.0")
     }

   コピー

   Maven： pom.xmlファイルに以下を追加します。

   <dependencies>
     <dependency>
         <groupId>com.newrelic.logging</groupId>
         <artifactId>jul</artifactId>
         <version>2.0</version>
     </dependency>
   </dependencies>

   コピー

4. ログファイルのhandlersプロパティがNewRelicMemoryHandler以外に設定されているかどうかを確認してください。次のように、ルートロガーのハンドラーを一覧表示する行を探します。

   handlers = java.util.logging.FileHandler

   コピー

5. ロギングプロパティファイルを更新して、ルートロガーのハンドラーをNewRelicMemoryHandlerに設定し、別のハンドラー宛てのメッセージをインターセプトします。

   handlers = com.newrelic.logging.jul.NewRelicMemoryHandler

   コピー

6. 以前にルートロガーに割り当てられたハンドラーにターゲットを設定してNewRelicMemoryHandlerを構成します。これにより、ログメッセージの送信元のスレッドでNewRelicが必要とするデータがキャプチャされます。

   com.newrelic.logging.jul.NewRelicMemoryHandler.target = java.util.logging.FileHandler

   コピー

7. 最終ハンドラーにはNewRelicFormatterを使用します。次の例のように、ログプロパティファイルを更新してformatterプロパティを設定します。フォーマッタを設定するハンドラが前の手順のtargetハンドラ（この例ではjava.util.logging.FileHandler ）であることを確認してください。

   java.util.logging.FileHandler.formatter = com.newrelic.logging.jul. NewRelicFormatter

   コピー

   New Relicのログ形式は、トランザクションとログを相互に関連付けるために使用するテレメトリメタデータを使用したJSONです。現在、その形式のカスタマイズはサポートされていません。

   完了すると、テキストの代わりにJSONがログに記録されます。JSONは、1行に1つずつ、単一のオブジェクトとしてフォーマットする必要があり、 log.levelやthread.nameなどのフィールドを含める必要があります。コンテキスト内のログに必要なtrace.idは、トランザクション内で発生するログメッセージの値のみを持つ必要があります。

ログインコンテキスト拡張機能を取得する最も直接的な方法は、これらの依存関係をMavenのpom.xmlまたはGradleのbuild.gradleに追加することです。これにより、パッケージツールは正しい依存関係を取得できます。

これらのファイルを編集できない場合は、代わりに、ロギングフレームワークの構成用のアプリケーションclasspathにjarを直接追加できます。

クラスパスを変更する前に：

1. アプリのJavaエージェントでJVM引数-javaagentを有効にします。
2. アプリケーションが使用しているロギングフレームワークを確認します。
3. ロギングフレームワークの構成を変更できることを確認してください。
4. 次の3つのjarがまだ存在しない場合は、クラスパスに追加します。通常、MavenCentralで公開されている最新バージョンを使用することをお勧めします。

• グループID com.newrelic.loggingとアーティファクトID： Mavenでのアプリケーションのロギングフレームワークにちなんで名付けられたアーティファクトを選択します。
• グループID com.fasterxml.jackson.coreおよびアーティファクトID： jackson-coreを使用します。
• グループID com.newrelic.agent.javaおよびアーティファクトID： newrelic-apiを使用します。

Javaエージェントに関連する手動ログ用のLog4j1.x拡張機能を提供します。開始するには、GitHubのコードとサンプルアプリケーションを確認してください。

Log4j 1.x拡張機能を使用してJavaアプリのコンテキストで手動ログを構成するには、コードまたはXMLを介してLog4j拡張機能を構成する必要があります。AsyncAppenderインスタンスはXMLを介してのみ自動的に構成できるため、プロパティファイルはサポートされていません。

1. Log4j 1.xパッケージがインストールされ、アプリケーションで動作していることを確認してください。

2. アプリケーションにNewRelicJavaエージェントバージョン5.6.0以降がインストールされていること、およびJVM引数-javaagentが有効になっていることを確認してください。

3. プロジェクトの依存関係を更新して、必要に応じてLog4j1.x拡張機能を含めます。

   Gradle： build.gradleファイルに以下を追加します。

   dependencies {
     implementation("com.newrelic.logging:log4j1:2.0")
     }

   コピー

   Maven： pom.xmlファイルに以下を追加します。

   <dependencies>
       <dependency>
           <groupId>com.newrelic.logging</groupId>
           <artifactId>log4j1</artifactId>
           <version>2.0</version>
       </dependency>
   </dependencies>

   コピー

4. ロギング構成XMLファイルで、 <appender>要素をNewRelicLayoutで更新し、 <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/>を追加します。

   <appender name="TypicalFile" class="org.apache.log4j.FileAppender">
     <param name="file" value="logs/log4j1-app.log"/>
     <param name="append" value="false"/>
     <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/> <!-- only this line needs to be added -->
   </appender>

   コピー

5. NewRelicAsyncAppenderを使用して、NewRelicのログフォワーダーを対象とするすべてのアペンダーをラップします。例えば：

   <appender name="NewRelicFile" 
             class="com.newrelic.logging.log4j1.NewRelicAsyncAppender">
     <appender-ref ref="TypicalFile" />
   </appender>

   コピー

6. ルートロガーで非同期アペンダーを使用します。例えば：

   <root>
       <appender-ref ref="NewRelicFile" />
   </root>

   コピー

   Log4j 1.x拡張機能の構成ファイルの例：

   <?xml version="1.0" encoding="UTF-8" ?>
   <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
   <log4j:configuration debug="false">
     <appender name="TypicalFile" class="org.apache.log4j.FileAppender">
         <param name="file" value="logs/log4j1-app.log"/>
         <param name="append" value="false"/>
         <!-- layout has been replaced -->
         <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/>
     </appender>
   
       <!-- this appender was added -->
     <appender name="NewRelicFile" 
               class="com.newrelic.logging.log4j1.NewRelicAsyncAppender">
         <appender-ref ref="TypicalFile" />
     </appender>
   
     <appender name="TypicalConsole" class="org.apache.log4j.ConsoleAppender">
       <layout class="org.apache.log4j.PatternLayout"> 
         <param name="ConversionPattern" value="%-5p %c{1} - %m%n"/> 
       </layout> 
     </appender>
   
     <root>        ​
         <!-- the new appender was used here -->​​
         <appender-ref ref="NewRelicFile" />
         <appender-ref ref="TypicalConsole" />
     </root>
   
   </log4j:configuration>

   コピー

Javaエージェントとの関連でログ用のLog4j2.x拡張機能を提供します。開始するには、GitHubのコードとサンプルアプリケーションを確認してください。

Log4j 2.x拡張機能を使用してJavaアプリのコンテキストでログを構成するには、次のようにします。

1. Log4j2.13.2以降またはLogs4j2バインディングパッケージがインストールされ、アプリケーションで動作していることを確認してください。

2. アプリケーションにNewRelicJavaエージェントバージョン5.6.0以降がインストールされていること、およびJVM引数-javaagentが有効になっていることを確認してください。

3. プロジェクトの依存関係を更新して、必要に応じてLog4j2.x拡張機能を含めます。

   Gradle：強調表示されたセクションをbuild.gradleファイルに追加します：

   dependencies {
       implementation("com.newrelic.logging:log4j2:2.0")
   }

   コピー

   Maven：強調表示されたセクションをpom.xmlファイルに追加します。

   <dependencies>
     <dependency>
             <groupId>com.newrelic.logging</groupId>
             <artifactId>log4j2</artifactId>
             <version>2.0</version>
           </dependency>
   </dependencies>

   コピー

4. ロギング構成XMLファイルで、強調表示されたセクションを追加して<configuration>要素を更新します。

   <Configuration xmlns="http://logging.apache.org/log4j/2.0/config"
         packages="com.newrelic.logging.log4j2"
   >

   コピー

   プロパティファイルを使用している場合は、 packages=com.newrelic.logging.log4j2を追加します。

5. <NewRelicLayout/>を追加して、いずれかのアペンダー内でNewRelicLayout要素を使用します。例えば：

   <File name="MyFile" fileName="logs/app-log-file.log">
       <NewRelicLayout/>
   </File>

   コピー

   プロパティファイルを使用している場合は、 layout.typeのみを変更してください。

   appender.console.type = Console
   appender.console.name = STDOUT
   appender.console.layout.type = NewRelicLayout

   コピー

6. 既存のアペンダーのみを変更した場合は、この手順をスキップしてください。新しいアペンダーを追加した場合は、 <Root> }内に<AppenderRef/>を追加して、このアペンダーを使用します。ref属性を使用して、前の手順で作成したアペンダーnameを参照します。例えば：

   <Root level="info">
       <AppenderRef ref="MyFile"/>
   
   </Root>

   コピー

   プロパティファイルを使用していて、新しいアペンダーを追加した場合は、次を追加します。

   rootLogger.level = info
       rootLogger.appenderRef.stdout.ref = STDOUT
   ​​​​​

   コピー

Javaエージェントに関連するログのログバック拡張機能を提供します。開始するには、GitHubのコードとサンプルアプリケーションを確認してください。

Logbackを使用してJavaアプリのコンテキストでログを構成するには：

1. Logbackバージョン1.2.0以降とNewRelicJavaエージェントバージョン5.6.0以降がインストールされ、アプリケーションで動作していることを確認してください。

2. アプリケーションにNewRelicJavaエージェントバージョン5.6.0以降がインストールされていること、およびJVM引数-javaagentが有効になっていることを確認してください。

3. プロジェクトの依存関係を更新して、必要に応じてLogback拡張機能を含めます。

   Gradle：強調表示されたセクションをbuild.gradleファイルに追加します：

   dependencies {
       implementation("com.newrelic.logging:logback:2.0")
   }

   コピー

   Maven：強調表示されたセクションをpom.xmlファイルに追加します。

   <dependencies>
     <dependency>
             <groupId>com.newrelic.logging</groupId>
             <artifactId>logback</artifactId>
             <version>2.0</version>
           </dependency>
   </dependencies>

   コピー

4. ロギング構成xmlを更新して、既存の<encoder>要素を置き換えます。

   コンソール（ stdout/stderr ）にログを記録している場合は、 ConsoleAppenderを探して置き換えます。

   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   </appender>

   コピー

   ファイルにログを記録している場合は、 FileAppenderを探して{ <encoder> }を置き換えます。

   <appender name="LOG_FILE" class="ch.qos.logback.core.FileAppender">
       <file>logs/app-log-file.log</file>
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   </appender>

   コピー

5. ロギング設定xmlをNewRelicAsyncAppenderで更新します。NewRelicAsyncAppenderがNewRelicのログフォワーダーをターゲットとするすべてのアペンダーを確実にラップするようにするには、次のセクションを追加します。"LOG_FILE"を、前の手順で更新したアペンダーの名前に変更します。

   <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="LOG_FILE" />
   </appender>

   コピー

6. NewRelicAsyncAppenderがロガーで使用される最初のアペンダーであることを確認してください。ルートロガーのアペンダーを、前の手順で作成したASYNCアペンダーに置き換えます。次に、 <root>リストのNewRelicAsyncAppenderの後に他のアペンダーをリストします。

   <root>
       <appender-ref ref="ASYNC" />
   </root>

   コピー

   Logback拡張機能の更新されたログ.xmlファイルの例を次に示します。GitHubでも実際の例を見ることができます。

   シングルコンソールアペンダーの例

   ロギング拡張情報を追加した後の構成ファイルの例：

   <configuration>
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
   
       <!-- changed the encoder -->
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   
     </appender>
   
     <!-- added the ASYNC appender -->
     <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="STDOUT" />
     </appender>
   
     <root level="debug">
   
       <!-- changed the root logger -->
       <appender-ref ref="ASYNC" /> 
   
     </root>
   </configuration>

   コピー

   2つのコンソールアペンダーの例

   この例では、New Relicのログをファイルに送信しますが、標準のログをコンソールに送信します。

   <configuration>
     <appender name="FILE" class="ch.qos.logback.core.FileAppender">
       <file>myApp.log</file>
       <!-- encoder changed -->
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
     </appender>
   
     <!-- this appender does normal console logging -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <encoder>
         <pattern>%msg%n</pattern>
       </encoder>
     </appender>
   
     <!-- The required New Relic ASYNC appender wraps the FILE appender -->
     <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="FILE" /> 
     </appender>
   
     <root level="debug">
       <!-- ASYNC is one of the main appenders -->
       <appender-ref ref="ASYNC" /> 
   
       <!-- Send every message to normal console logging, as well. -->
       <appender-ref ref="STDOUT" />
     </root>
   </configuration>

   コピー

SpringおよびSpringBootの現在のバージョンの拡張機能を提供しています。ロギングライブラリをすでに知っている場合は、そのドキュメントに直接スキップできます。

• java.util.logging

• log4j 1

• log4j 2

• ログバック

  拡張機能は、SpringBoot2.0以降でのみデフォルト構成をサポートします。

  スプリングブーツ付き：

  使用しているロギングライブラリを判別するためのヒントは次のとおりです。

• 依存関係にspring-boot-starter-log4j2がある場合は、 log4j2.xを使用しています。基本的な構成についてはSpringBootlog4j 2.xのドキュメントを、構成のカスタマイズについてはNew Reliclog4j2拡張機能を参照してください。

• Spring Bootを使用しているがstarter-log4j2を使用していない場合は、デフォルトでログバックを使用しています。基本的な設定についてはSpringBootログバックのドキュメントを、設定のカスタマイズについてはNewRelicログバック拡張機能を参照してください。

  Springあり（Spring Bootではない）：

  春5以降：

  Springは、他のロギングライブラリへのブリッジを実装して、それらを自動的に検出します。ただし、これらの個々のライブラリを構成し、プロジェクトの依存関係に明示的に含める必要があります。

  ロギングの依存関係を特定するには、 Gradle 、 Maven 、またはその他のビルドツールの依存関係ツリーを参照してください。次に、手順に従って、その拡張子を持つJavaアプリのコンテキストでログを構成します。

  春4以下：

  Springバージョン4以前では、ブリッジにApacheCommonsLoggingを使用しています。ブリッジの構成については、 Springのドキュメントを参照してください。