Настроить ведение журнала

Клиентская библиотека .NET регистрирует запросы, ответы и сводные сообщения, отправляемые в API Google Ads. Журналы могут записываться в пользовательский TraceListener или в пользовательский экземпляр ILogger .

TraceListener

Включить логирование в TraceListener можно, добавив следующие строки в метод Main перед выполнением любых вызовов API:

using Google.Ads.GoogleAds.Util;

// Detailed logs.
TraceUtilities.Configure(
    TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE,
    "logs/details.log",
    System.Diagnostics.SourceLevels.All);

// Summary logs.
TraceUtilities.Configure(
    TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE,
    "logs/summary.log",
    System.Diagnostics.SourceLevels.All);

ILogger

Если вы уже используете ILogger для ведения журналов вашего приложения, это решение позволит вам интегрировать журналы Google Ads API в вашу существующую инфраструктуру логирования.

Сначала создайте объект LoggerFactory , или, если он у вас уже есть, добавьте фильтры для логов Google Ads API:

var loggerFactory = LoggerFactory.Create(builder =>
{
    // Log to stdout.
    builder.AddConsole();
    builder.AddFilter(
        TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE, LogLevel.Trace);
    builder.AddFilter(
        TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE, LogLevel.Trace);
});

Затем используйте LoggerFactory для создания логгеров, регистрирующих сводки и подробные данные о запросах и ответах:

ILogger summaryLogger = loggerFactory.CreateLogger(
    TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE);
ILogger detailLogger = loggerFactory.CreateLogger(
    TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE);

Наконец, настройте клиентскую библиотеку для перенаправления трассировки на ваши экземпляры ILogger :

TraceUtilities.ConfigureSummaryLogger(summaryLogger);
TraceUtilities.ConfigureDetailLogger(detailLogger);

Это решение позволяет интегрировать журналы запросов и ответов API Google Ads в существующие системы логирования, такие как Log4Net, NLog и Serilog.

Уровни логарифма

Библиотека регистрирует различные типы событий на разных уровнях детализации:

• Успешный ответ API : сводная информация записана в INFO ; полный запрос и ответ записаны в DEBUG .
• Ошибка ответа API : краткое сообщение зарегистрировано в WARN ; полный запрос и ответ зарегистрированы в INFO .
• Частичные сбои : Зарегистрированы в DEBUG .

Идентификатор запроса

В большинстве случаев журналы, генерируемые клиентской библиотекой, содержат достаточно подробную информацию для устранения неполадок. При обращении в службу поддержки предоставьте либо сами журналы (которые по умолчанию скрывают конфиденциальные поля аутентификации), либо укажите идентификатор запроса, который записывается в журнал ответа.

Если вы предпочитаете получать идентификатор запроса программным способом, используйте один из следующих подходов.

Выдержка из обычных унарных вызовов API

Для захвата идентификаторов запросов из обычных унарных вызовов можно использовать пользовательские CallSettings с обработчиком TrailingMetadataHandler :

CallSettings callSettings = CallSettings.FromTrailingMetadataHandler(
    metadata =>
    {
        // Extract and log the request ID from the trailing metadata.
        string requestId = metadata.Get("request-id")?.Value;
        Console.WriteLine($"Request ID: {requestId}");
    });
// Add the campaigns.
MutateCampaignsResponse retVal = campaignService.MutateCampaigns(
    customerId.ToString(), operations.ToArray(), callSettings);

Фрагмент из вызовов потокового API

Идентификатор запроса возвращается в составе объекта ответа для потоковых вызовов API. Например, идентификатор запроса для вызова SearchStream можно получить следующим образом:

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V25.GoogleAdsService);

// Retrieve all campaigns.
string query = @"SELECT
                campaign.id,
                campaign.name,
                campaign.network_settings.target_content_network
            FROM campaign
            ORDER BY campaign.id";

// Issue a search request.
googleAdsService.SearchStream(
    customerId.ToString(),
    query,
    (SearchGoogleAdsStreamResponse resp) =>
    {
        // Extract the request ID from the response.
        string requestId = resp.RequestId;
        Console.WriteLine($"Request ID: {requestId}");
        foreach (GoogleAdsRow googleAdsRow in resp.Results)
        {
            Console.WriteLine(
                "Campaign with ID {0} and name '{1}' was found.",
                googleAdsRow.Campaign.Id,
                googleAdsRow.Campaign.Name);
        }
    }
);

Исключения

Идентификатор запроса возвращается в составе исключения GoogleAdsException всякий раз, когда вызов API завершается неудачей:

try
{
    // Make an API call.
}
catch (GoogleAdsException e)
{
    string requestId = e.RequestId;
    Console.WriteLine($"Failed Request ID: {requestId}");
}

Настройте расширенные параметры ведения журналов.

Если журнал API не предоставляет достаточно подробной информации, включите низкоуровневое логирование на уровне транспортного уровня gRPC. Имейте в виду, что объем выходных данных может быть большим.

При использовании стандартного транспорта Grpc.Net.Client настройте ведение журналов на уровне транспорта через поставщик ILogger в .NET, добавив фильтр для категории Grpc (например, builder.AddFilter("Grpc", LogLevel.Debug) ).

Если вы используете устаревший транспорт Grpc.Core ( UseGrpcCore = true ), журналы gRPC по умолчанию записываются в stderr , или вы можете подключить собственный логгер, как показано в следующем примере. Для получения более подробной информации см. поддерживаемые переменные среды gRPC .

Environment.SetEnvironmentVariable("GRPC_VERBOSITY", "DEBUG");
Environment.SetEnvironmentVariable("GRPC_TRACE", "http");
GrpcEnvironment.SetLogger(new ConsoleLogger());

Настройка TraceListener с помощью App.config (устаревшая версия)

Если ваше приложение создано для платформы .NET Framework, вы можете загрузить конфигурацию логирования из файла App.config или Web.config вашего приложения. Это устаревшая функция .NET, которая не поддерживается для приложений, созданных для современных платформ .NET.

Для использования этой функции внесите следующие изменения в файл конфигурации:

1. Добавьте следующий фрагмент кода в раздел <configuration> :

   <system.diagnostics>
     <sources>
       <source name="GoogleAds.DeprecationMessages"
           switchName="GoogleAds.DeprecationMessages"
           switchType="System.Diagnostics.SourceSwitch">
         <listeners>
           <add name="myListener"
                type="System.Diagnostics.EventLogTraceListener"
                initializeData="Application" />
         </listeners>
       </source>
       <source name="GoogleAds.DetailedRequestLogs"
           switchName="GoogleAds.DetailedRequestLogs"
           switchType="System.Diagnostics.SourceSwitch">
         <listeners>
           <add name="detailedRequestLogListener"
                type="System.Diagnostics.ConsoleTraceListener"
                initializeData="true" />
           <!-- Use the following to log to a file. Modify the initializeData
                attribute to control the path to the detailed request log
                file. -->
           <!--
           <add name="detailedRequestLogListener"
                type="System.Diagnostics.TextWriterTraceListener"
                initializeData="C:\Logs\detailed_logs.log" />
           <remove name="Default" />
           -->
         </listeners>
       </source>
       <source name="GoogleAds.SummaryRequestLogs"
           switchName="GoogleAds.SummaryRequestLogs"
           switchType="System.Diagnostics.SourceSwitch">
         <listeners>
           <add name="summaryRequestLogListener"
                type="System.Diagnostics.ConsoleTraceListener"
                initializeData="true" />
           <!-- Use the following to log to a file. Modify the initializeData
                attribute to control the path to the summary request log
                file. -->
           <!--
           <add name="summaryRequestLogListener"
                type="System.Diagnostics.TextWriterTraceListener"
                initializeData="C:\Logs\summary_logs.log" />
           -->
           <remove name="Default" />
         </listeners>
       </source>
     </sources>
     <switches>
       <!-- Use this trace switch to control the deprecation trace messages
            written by Google Ads .NET libraries. The default level is set to
            Warning. To disable all messages, set this value to Off. -->
       <add name="GoogleAds.DeprecationMessages" value="Warning" />
       <!-- Use this trace switch to control the detailed request logs written
            by Google Ads .NET libraries. The default level is set to Off.
            Logs are generated at both the Error and Information levels. -->
       <add name="GoogleAds.DetailedRequestLogs" value="Off" />
       <!-- Use this trace switch to control the summary request logs written
            by Google Ads .NET libraries. The default level is set to Off.
            Logs are generated at both the Error and Information levels. -->
       <add name="GoogleAds.SummaryRequestLogs" value="Off" />
     </switches>
     <trace autoflush="true" />
   </system.diagnostics>
   

2. Добавьте следующий фрагмент кода в раздел <configSections> :

   <section name="system.diagnostics"
            type="System.Diagnostics.SystemDiagnosticsSection" />
   

   В этом случае ваш App.config будет выглядеть следующим образом:

   <?xml version="1.0" encoding="utf-8"?>
   <configuration>
     <configSections>
       <section name="GoogleAdsApi"
                type="System.Configuration.DictionarySectionHandler" />
       <section name="system.diagnostics"
                type="System.Diagnostics.SystemDiagnosticsSection" />
     </configSections>
     <GoogleAdsApi>
       <!-- Google Ads API settings. -->
     </GoogleAdsApi>
     <system.diagnostics>
       <!-- Logging settings. -->
     </system.diagnostics>
   </configuration>