логирование

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

TraceListener

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

using Google.Ads.GoogleAds.Util;
...

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

// Summary logs.
TraceUtilities.Configure(TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE,
    "C:\\logs\\details.log", System.Diagnostics.SourceLevels.All);

ILogger

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

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

var loggerFactory = LoggerFactory.Create(delegate (ILoggingBuilder 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);

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

Уровни журнала

Библиотека регистрирует различные типы событий на разных уровнях журнала. Для успешного ответа API сводка записывается в INFO , а полный запрос и ответы записываются в DEBUG .

Для запроса, который приводит к ошибке API, сводное сообщение регистрируется в WARN , а полный запрос и ответ — в INFO .

Частичные сбои регистрируются в DEBUG .

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

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

Если вы предпочитаете получать идентификатор запроса самостоятельно, вы можете использовать один из следующих подходов:

Извлечение через обычные вызовы API

Вы можете использовать настраиваемый CallSetting с TrailingMetadataHandler для захвата идентификаторов запросов из обычных унарных вызовов.

CallSettings callSettings = CallSettings.FromTrailingMetadataHandler(
    delegate (Metadata metadata) {
        // Extract the request ID from the trailing metadata.
        string requestId = metadata.Get("request-id").Value;
    });
// Add the campaigns.
MutateCampaignsResponse retVal = campaignService.MutateCampaigns(
    customerId.ToString(), operations.ToArray(), callSettings);

Извлечение через вызовы потокового API

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

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V13.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,
    delegate (SearchGoogleAdsStreamResponse resp)
    {
        // Extract the request ID from the response.
        string requestId = resp.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;
}

Расширенное ведение журнала

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

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 Core.

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

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 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 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 Ads* .NET libraries. The default is level is set to
            Warning. To disable all messages, set this value to Off. See
            msdn.microsoft.com/en-us/library/system.diagnostics.sourcelevels.aspx
            for all possible values this key can take. -->
       <add name="GoogleAds.DeprecationMessages" value="Warning"/>
       <!-- Use this trace switch to control the detailed request logs written by 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
            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>