پیکربندی ثبت گزارش

ثبت گزارش در کتابخانه کارخواه Java با SLF4J پیکربندی می‌شود که یک نمای ثبت گزارش عمومی برای Java است و امکان هدایت گزارش‌ها به پیاده‌سازی‌های مختلف ثبت گزارش مانند Log4j 2،‏ Logback، یا java.util.logging (JUL) را فراهم می‌کند. ما فایل‌های پیکربندی نمونه برای Log4j 2 و JUL ارائه می‌دهیم.

ثبت چیدمان و عملکرد

درخواست‌ها با خلاصه یک‌خطی و بدنه و سرصفحه کامل درخواست و پاسخ ثبت می‌شوند.

نوع گزارش	نام گزارش	سطح موفقیت	سطح خرابی
خلاصه	com.google.ads.googleads.lib.request.summary	اطلاعات	هشدار
جزئیات	com.google.ads.googleads.lib.request.detail	اشکال‌زدایی	اطلاعات

نکته کلیدی: درخواست‌های تغییر که در آن‌ها شکست جزئی true است باعث نمی‌شود کل درخواست ناموفق شود. بنابراین، گزارش‌های خرابی جزئی همیشه در سطح «موفقیت» ثبت می‌شوند، نه در سطح «خرابی».

کوتاه کردن گزارش جزئیات

گزارش‌های دقیق به‌طور پیش‌فرض کوتاه می‌شوند تا گزارش‌های بزرگ ایجاد نشود. برای تغییر طولی که گزارش‌ها در آن کوتاه می‌شوند، ویژگی 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 فایل پیکربندی خود را از classpath بار می‌کند، نه از فهرست راهنمای کاری، بنابراین مطمئن شوید که آن را در فهرست راهنمای منابع ایجاد می‌کنید.

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 فایل پیکربندی خود را از classpath بار می‌کند، نه از فهرست راهنمای کاری، بنابراین مطمئن شوید که آن را در فهرست راهنمای منابع کپی کنید.

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 اجرا کنید.