Logowanie

Biblioteka klienta .NET rejestruje żądania, odpowiedzi i podsumowania komunikatów wysyłanych do interfejsu Google Ads API. Logi można zapisywać w niestandardowym TraceListener, lub w niestandardowej ILogger instancji.

TraceListener

Aby włączyć rejestrowanie w elemencie TraceListener, dodaj ten wiersz w metodzie Main przed wykonaniem jakichkolwiek wywołań interfejsu 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);

Pamiętaj, że TraceListeners.Configure należy wywołać tylko raz w cyklu życia aplikacji, ponieważ utworzony przez nią element TraceListener będzie automatycznie używany we wszystkich żądaniach interfejsu API wysyłanych przez aplikację. Nie musisz tworzyć nowego elementu dla każdego żądania interfejsu API.

ILogger

Jeśli używasz już elementu ILogger do rejestrowania logów aplikacji, to rozwiązanie umożliwia zintegrowanie logów interfejsu Google Ads API z dotychczasowymi logami.

Najpierw utwórz element LoggerFactory lub, jeśli już go masz, dodaj filtry logów interfejsu 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);
});

Następnie użyj elementu LoggerFactory, aby utworzyć rejestratory podsumowań i szczegółów żądań oraz odpowiedzi:

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

Na koniec skonfiguruj bibliotekę klienta, aby przekierowywała ślady do instancji ILogger:

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

To rozwiązanie umożliwia zintegrowanie logów żądań i odpowiedzi interfejsu Google Ads API z dotychczasowymi platformami rejestrowania, takimi jak Log4Net, NLog i Serilog.

Poziomy rejestrowania

Biblioteka rejestruje różne typy zdarzeń na różnych poziomach rejestrowania. W przypadku udanej odpowiedzi interfejsu API podsumowanie jest rejestrowane na poziomie INFO, a pełne żądanie i odpowiedzi są rejestrowane na poziomie DEBUG.

W przypadku żądania, które powoduje błąd interfejsu API, komunikat podsumowania jest rejestrowany na poziomie WARN, a pełne żądanie i odpowiedź są rejestrowane na poziomie INFO.

Częściowe niepowodzenia są rejestrowane na poziomie DEBUG.

Identyfikator żądania

W większości przypadków logi generowane przez bibliotekę klienta zawierają wystarczające szczegóły, aby rozwiązać problemy. Gdy skontaktujesz się z zespołem pomocy, podaj logi (które domyślnie usuwają informacje poufne) lub udostępnij identyfikator żądania, który jest rejestrowany jako część logu odpowiedzi.

Jeśli wolisz samodzielnie przechwytywać identyfikator żądania, możesz użyć jednej z tych metod:

Wyodrębnianie za pomocą zwykłych wywołań interfejsu API

Możesz użyć niestandardowego elementu CallSetting z elementem TrailingMetadataHandler, aby przechwytywać identyfikatory żądań ze zwykłych wywołań jednoargumentowych.

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);

Wyodrębnianie za pomocą wywołań interfejsu API przesyłania strumieniowego

Identyfikator żądania jest zwracany jako część obiektu odpowiedzi w przypadku wywołań interfejsu API przesyłania strumieniowego. Na przykład identyfikator żądania wywołania SearchStream możesz uzyskać w ten sposób:

// 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,
    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);
        }
    }
);

Wyjątki

Identyfikator żądania jest zwracany jako część wyjątku GoogleAdsException za każdym razem, gdy wywołanie interfejsu API nie powiedzie się.

try
{
  // Make an API call.
  ...
}
catch (GoogleAdsException e)
{
    string requestId = e.RequestId;
}

Zaawansowane rejestrowanie

Jeśli log interfejsu API nie zawiera wystarczających szczegółów, włącz rejestrowanie na niższym poziomie w gRPC. Pamiętaj, że dane wyjściowe mogą być obszerne. Logi gRPC są zapisywane w stderr, ale możesz dołączyć własny rejestrator, jak pokazano w tym przykładzie. Obsługiwane zmienne środowiskowe.

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

Konfiguracja TraceListener za pomocą pliku App.config (starsza wersja)

Jeśli Twoja aplikacja jest tworzona na platformie .NET Framework, możesz wczytać konfigurację rejestrowania z pliku App.config lub Web.config aplikacji. Jest to starsza funkcja .NET, która nie jest obsługiwana w przypadku aplikacji tworzonych na platformie .NET Core.

Aby korzystać z tej funkcji, musisz wprowadzić te zmiany w pliku konfiguracyjnym:

1. Dodaj ten fragment kodu w sekcji <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. Dodaj ten fragment kodu w sekcji <configSections>.

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

   Plik App.config będzie wyglądać tak:

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