Simple Log Service：採集Log4j日誌

前提條件

• 已建立Project和Logstore。更多資訊，請參見管理Project和管理Logstore。

• 如果使用Appender方式採集，則必須建立RAM使用者並授予Log ServiceLogstore的寫入許可權，配置許可權的步驟請參見配置許可權助手。

操作步驟

步驟一：在專案中添加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. 修改設定檔。

   預設會在classpath路徑下尋找設定檔，如果不存在則需要手動建立。下面以log4j2.xml為例，log4j2.xml中定義兩個Appender，分別輸出到控制台和檔案app.log中。定義根日誌器的記錄層級是error，輸出到控制台。定義名為com.example.demo.log的日誌器層級是warn，輸出到檔案中。更多Log4j2配置方式，請參見官網Log4j – Configuring Log4j 2 (apache.org)

   <!-- status="WARN"，設定Log4j 2自身的內部狀態，而不是應用程式的日誌記錄，它用於在配置過程中捕獲和報告潛在問題。 -->
   <Configuration status="WARN">
       <!-- 定義兩個輸出日誌的目標（Appender）  start  -->
       <Appenders>
           <!-- 定義了一個名為"Console"的控制台輸出Appender，日誌將被列印到系統標準輸出。 -->
           <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"的檔案輸出Appender，日誌會被寫入到”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>
       <!-- 定義兩個輸出日誌的目標（Appender）  end  -->
   
       <!-- 配置日誌記錄的行為（Logger）      start  -->
       <Loggers>
           <!-- 定義了名為com.example.demo.log的日誌器，其層級設定為trace。它引用了"MyFile" Appender，即"com.example.demo.log" Logger會將trace及以上的日誌會輸出到它自己的Appender("MyFile")。 -->
           <Logger name="com.example.demo.log" level="warn">
               <AppenderRef ref="MyFile" />
           </Logger>
           <!-- 定義了根日誌器（Root Logger），其層級設定為error。它引用了"Console" Appender，即error及以上的日誌會輸出到控制台。 -->
           <Root level="error">
               <AppenderRef ref="Console" />
           </Root>
       </Loggers>
       <!-- 配置日誌記錄的行為（Logger）      end  -->
   </Configuration>

3. 基本使用。

   編寫測試代碼，讀取定義好的Appender，進行日誌輸出，程式碼範例如下：

       public void logExampleDemo() {
           // 擷取名為 "com.example.demo.log" 的 Logger 執行個體
           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

步驟二：採集Log4j日誌到Log Service

步驟三：查看日誌

1. 登入Log Service控制台。

2. 在Project列表地區，單擊目標Project。

   

3. 在控制台左側，單擊日誌儲存，在日誌庫列表中單擊目標Logstore。

   

4. 查看日誌資料是否上傳成功。在Logstore中查詢和分析日誌，單擊消費預覽快速查看日誌。

   

5. 查詢分析日誌。

   重要

   日誌上傳到Logstore後，必須建立索引才能進行查詢分析。配置索引，具體操作，請參見建立索引。

   輸入查詢和分析語句，然後單擊最近15分鐘，設定查詢和分析的時間範圍。日誌查詢結果如下所示。

   Appender方式採集

   日誌樣式如下。

   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

   在Logstore頁面進行查詢分析。

   

   使用Logtail方式採集

   在Logstore頁面進行查詢分析。

   

   您可以輸入查詢語句用於日誌資料的查看、簡單搜尋和過濾。更多資訊，請參見查詢和分析日誌。簡單樣本如下。

   • 統計最近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採集日誌時，可能遇到正則解析失敗、檔案路徑不正確、流量超過Shard服務能力等錯誤。查看Logtail採集錯誤的步驟，請參見如何查看Logtail採集錯誤資訊。採集資料常見的錯誤類型請參見Log Service採集資料常見的錯誤類型。

• 使用Log4j2 Appender採集Log4j日誌的使用執行個體以及常見問題，請查看Log4j2 Appender，以下版本請查看Log4j Appender。

• 使用Log4j2 Appender採集Log4j日誌時，配置accessKeyId和accessKeySecret，擷取方式，請參見建立AccessKey。配置Log Service提供的訪問網域名稱（Endpoint），請參考服務存取點。