Simple Log Service:Log4j ログを収集する

前提条件

• プロジェクトとログストアが作成されていること。詳細については、「プロジェクトを作成する」および「ログストアを作成する」をご参照ください。

• Alibaba Cloud アカウントではなく RAM (Resource Access Management) ユーザーを使用する場合、RAM ユーザーには 特定のログストアにデータを書き込む権限が必要です。権限を付与するには、最初に カスタムポリシーを作成し、次に RAM ユーザーに権限を付与します。

手順

ステップ 1: Log4j2 の構成ファイルをプロジェクトに追加する

1. Maven プロジェクトに依存関係を追加します。

   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-api</artifactId>
       <version>2.23.1</version>
     </dependency>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-core</artifactId>
       <version>2.23.1</version>
     </dependency>
   </dependencies>

2. 構成ファイルを変更します。

   デフォルトでは、システムはクラスパスのパスで構成ファイルを検索します。構成ファイルが存在しない場合は、手動でファイルを作成する必要があります。次の例では、log4j2.xml ファイルに 2 つのアペンダーが定義されています。アペンダーは、それぞれログを Simple Log Service コンソールと app.log ファイルに出力するために使用されます。ルートロガーのログレベルは ERROR として定義され、ログは Simple Log Service コンソールに出力されます。 com.example.demo.log という名前のロガーのログレベルは WARN として定義され、ログは app.log ファイルに出力されます。 Log4j2 の構成方法の詳細については、「Log4j - Configuring Log4j 2 (apache.org)」をご参照ください。

   !" -- status="WARN". Log4j2 の内部ステータス。このパラメーターは、構成中の潜在的な問題をキャプチャして報告するためには使用されません。 -->
   <Configuration status="WARN">
       <! -- 2 つのアペンダーを定義する 開始 -->
       <Appenders>
           <! -- Console という名前のアペンダーを定義して、ログをシステム標準出力に出力します。 -->
           <Console name="Console" target="SYSTEM_OUT">
               <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss:SSS zzz} [%t] %-5level %logger{36} - %msg%n"/>
           </Console>
           <! -- MyFile という名前のアペンダーを定義して、ログを app.log ファイルに出力します。 -->
           <File name="MyFile" fileName="app.log">
               <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss:SSS zzz} [%t] %-5level %logger{36} - %msg%n"/>
           </File>
       </Appenders>
       <! -- 2 つのアペンダーを定義する 終了 -->
   
       <!-- ロガーを構成する 開始 -->
       <Loggers>
           <! -- com.example.demo.log という名前のロガーを定義し、ログレベルを TRACE に設定します。 com.example.demo.log ロガーは MyFile アペンダーを参照します。ロガーは、レベルが TRACE 以上のログを MyFile アペンダーに出力します。 -->
           <Logger name="com.example.demo.log" level="warn">
               <AppenderRef ref="MyFile" />
           </Logger>
           <!-- ルートロガーを定義し、ログレベルを ERROR に設定します。ルートロガーは Console アペンダーを参照します。ロガーは、レベルが ERROR 以上のログを Simple Log Service コンソールに出力します。 -->
           <Root level="error">
               <AppenderRef ref="Console" />
           </Root>
       </Loggers>
       <!-- ロガーを構成する 終了 -->
   </Configuration>

3. ログの出力を開始します。

   定義されたアペンダーを読み取ってログを出力するテストコードを記述します。サンプルコード:

       public void logExampleDemo() {
           // com.example.demo.log という名前のロガーを取得します。
           Logger logger = LogManager.getLogger("com.example.demo.log");
   
           // 異なるレベルでログデータを記録します。
           logger.trace("trace level");
           logger.debug("debug level");
           logger.info("info level");
           logger.warn("warn level");
           logger.error("error level");
           logger.fatal("fatal level");
       }

4. 次のサンプルコードは、ログ出力の例を示しています。

   2024-05-28 13:37:16:295 CST [http-nio-8080-exec-8] TRACE com.example.demo.log - trace level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] DEBUG com.example.demo.log - debug level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] INFO  com.example.demo.log - info level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] WARN  com.example.demo.log - warn level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] ERROR com.example.demo.log - error level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] FATAL com.example.demo.log - fatal level

ステップ 2: Log4j ログを Simple Log Service に収集する

ステップ 3: ログを表示する

1. Simple Log Service コンソール にログオンします。

2. [プロジェクト] セクションで、管理するプロジェクトをクリックします。

   

3. [ログストレージ] > [ログストア] タブで、管理するログストアをクリックします。

   

4. ログがログストアにアップロードされているかどうかを確認します。ログストアで ログクエリと分析のガイド。次に、[消費プレビュー] をクリックしてログを表示します。

   

5. ログのクエリと分析

   重要

   ログがログストアにアップロードされた後、ログをクエリおよび分析するには、インデックスを作成する必要があります。詳細については、「インデックスを作成する」をご参照ください。インデックスの作成方法については、「インデックスを作成する」をご参照ください。

   検索ボックスにクエリ文を入力し、[過去 15 分] をクリックして、クエリ時間範囲を指定します。

   次のサンプルコードは、ログの例を示しています。

   level: ERROR
   location: com.aliyun.openservices.log.log4j.example.Log4jAppenderExample.main(Log4jAppenderExample.java:16)
   message: error log
   throwable: java.lang.RuntimeException: xxx
   thread: main
   time: 2018-01-02T03:15+0000
   log: 0 [main] ERROR com.aliyun.openservices.log.log4j.example.Log4jAppenderExample - error log
   __source__: xxx
   __topic__: yyy

   ログストアページでログのクエリと分析を行います。

   

   クエリ文を入力して、ログデータの表示、検索、フィルタリングを行うことができます。詳細については、「ログのクエリと分析」をご参照ください。次の文は例として提供されています。

   • 過去 1 時間以内に最も多くのエラーが発生した 3 つの場所をクエリします。

     level: ERROR | select location ,count(*) as count GROUP BY  location  ORDER BY count DESC LIMIT 3

   • 過去 15 分以内に生成された各ログレベルのログ数をクエリします。

     | select level ,count(*) as count GROUP BY level ORDER BY count DESC

関連情報

• Logtail を使用してサーバーからログを収集する方法については、「サーバーからテキストログを収集する」をご参照ください。複数のプラグインが利用可能です。詳細については、「正規表現モードでの解析」をご参照ください。

• Logtail を使用してログを収集するときに、プレビューページが空白であるか、クエリページにデータが表示されない場合は、「Logtail を使用してログを収集するときにエラーが発生した場合はどうすればよいですか?」の指示に従って問題をトラブルシューティングできます。 Logtail を使用してログを収集すると、エラーが発生する場合があります。たとえば、正規表現が解析に失敗したり、無効なファイルパスが存在したり、トラフィックがシャードの処理能力を超えたりする場合があります。 Logtail 収集エラーは、「Logtail 収集エラーを表示するにはどうすればよいですか?」の指示に従って表示できます。データ収集における一般的なエラーについては、「Simple Log Service がログを収集するときに発生する可能性のある一般的なエラーをトラブルシューティングするにはどうすればよいですか?」をご参照ください。

• Log4j2 アペンダーを使用して Log4j ログを収集する場合のユースケースとよくある質問 (FAQ) については、「Log4j2 Appender」をご参照ください。 Log4j2 より前の Log4j バージョンを使用して Log4j ログを収集する場合のユースケースと FAQ については、「Log4j Appender」をご参照ください。

• Log4j2 アペンダーを使用して Log4j ログを収集する場合は、AccessKey ペアを構成する必要があります。 AccessKey ペアの取得方法については、「AccessKey ペアを作成する」をご参照ください。 Simple Log Service によって提供されるエンドポイントの構成方法については、「エンドポイント」をご参照ください。