設定記錄功能

Java 用戶端程式庫中的記錄功能是透過 SLF4J 設定,這是 Java 的一般記錄門面元件,可將記錄導向許多不同的記錄實作項目,例如 Log4j 2、Logback 或 java.util.logging (JUL)。我們提供 Log4j 2 和 JUL 的範例設定檔。

記錄版面配置和功能

系統會記錄要求,並提供一行摘要,以及完整的要求和回應內文與標頭。

記錄類型 記錄檔名稱 成功等級 失敗等級
摘要 com.google.ads.googleads.lib.request.summary 資訊 WARN
詳細資料 com.google.ads.googleads.lib.request.detail 偵錯 資訊

詳細記錄截斷

為避免產生過大的記錄檔,系統預設會截斷詳細記錄。如要變更記錄檔的截斷長度,請設定 JVM 屬性 -Dapi.googleads.maxLogMessageLength=<number>。如果設為 -1,系統就會停用記錄截斷功能。

Log4j 2

  1. 新增 log4j-slf4j2-impl 程式庫的依附元件,並將 2.x.y 替換為專案中使用的 Log4j 2 版本:

    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-slf4j2-impl</artifactId>
      <version>2.x.y</version>
    </dependency>
    
  2. (選用) 在資源目錄中建立 log4j2.xml 設定檔 (例如 Maven 中的 src/main/resources)。Log4j 2 會從類別路徑載入設定檔,而非目前使用的目錄,因此請務必在資源目錄中建立設定檔。

  3. 執行應用程式,並指定 -Dlog4j.configurationFile=<CONFIG_FILE_PATH>。您可以指定 CONFIG_FILE_PATH=googleads-logging/log4j2.xml,使用用戶端程式庫隨附的預設設定檔。

Log4j 1.2 (舊版)

  1. 新增對 slf4j-log4j12 程式庫的依附元件,並將 1.x.y 替換為專案中使用的 Log4j 1.2 版本:

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.x.y</version>
    </dependency>
    
  2. (選用) 在專案的資源目錄中建立設定檔,例如 Maven 中的 src/main/resources。Log4j 1.2 會從類別路徑載入設定檔,而非目前使用的目錄,因此請務必將設定檔複製到資源目錄。

  3. 執行應用程式,並指定 -Dlog4j.configuration=<CONFIG_FILE_PATH>。 您可以指定 CONFIG_FILE_PATH=googleads-logging/log4j.properties,使用用戶端程式庫隨附的預設設定檔。

Java Util Logging

  1. 新增 slf4j-jdk14 程式庫的依附元件,並將 2.x.y 替換為專案中使用的 SLF4J 版本:

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-jdk14</artifactId>
      <version>2.x.y</version>
    </dependency>
    
  2. 在檔案系統中,於應用程式可讀取的路徑 (例如 ./jdk-logger.properties) 建立 JUL 設定檔。範本位於 google-ads/src/main/resources/googleads-logging/jdk-logger.properties。JUL 只能從檔案系統讀取,因此請勿只將其複製到類別路徑資源目錄。

  3. 執行應用程式,並指定 -Djava.util.logging.config.file=./jdk-logger.properties。