Настройка ведения журналов

Ведение журнала в клиентской библиотеке 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	ОТЛАДКА	ИНФОРМАЦИЯ

Важно! Запросы mutate, в которых для параметра partial failure задано значение true, не приводят к сбою всего запроса. Таким образом, журналы частичных сбоев всегда регистрируются на уровне Success, а не на уровне Failure.

Усечение подробного журнала

По умолчанию подробные журналы усекаются, чтобы избежать создания больших файлов. Чтобы изменить длину, при которой журналы усекаются, задайте свойство 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 в каталоге ресурсов (например, src/main/resources в Maven). 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. При необходимости создайте файл конфигурации в каталоге ресурсов проекта, например src/main/resources в Maven. 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. Создайте файл конфигурации JUL в файловой системе по пути, доступном для чтения из вашего приложения (например, ./jdk-logger.properties). Шаблон доступен по адресу google-ads/src/main/resources/googleads-logging/jdk-logger.properties. JUL считывает данные только из файловой системы, поэтому не копируйте его в каталог ресурсов classpath.

3. Запустите приложение, указав -Djava.util.logging.config.file=./jdk-logger.properties.