Logowanie

Biblioteka klienta .NET rejestruje żądania, odpowiedzi i komunikaty z podsumowaniem wysyłane do za pomocą interfejsu Google Ads API. Dzienniki mogą być zapisywane w niestandardowym TraceListener lub zmień ILogger instancji.

TraceListener

Aby włączyć logowanie w TraceListener, dodaj ten wiersz w Main.

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

Jeśli używasz już ILogger do obsługi logów aplikacji, to rozwiązanie umożliwia integrację dzienników interfejsu Google Ads API z istniejącymi dziennikami.

Najpierw utwórz LoggerFactory, a jeśli masz już takie konto, dodaj filtry w przypadku dziennikó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 za pomocą LoggerFactory utwórz rejestratory żądań i odpowiedzi podsumowania i szczegóły:

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 jej logi czasu do usługi ILogger instancji:

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

To rozwiązanie umożliwia integrację logów żądań i odpowiedzi interfejsu Google Ads API z z istniejących platform logowania, takich jak Log4Net, NLog czy Serilog.

Poziomy logu

Biblioteka rejestruje różne typy zdarzeń na różnych poziomach logów. Dla pomyślna odpowiedź interfejsu API, podsumowanie jest rejestrowane na stronie INFO, a pełne żądania i odpowiedzi są logowane pod adresem DEBUG.

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

Częściowe błędy są logowane DEBUG.

Identyfikator żądania

W większości przypadków logi generowane przez bibliotekę klienta zapewniają wystarczającą ilość danych, . Kontakt z zespołem pomocy lub aliasów, można udostępnić dzienniki (usuwające dane poufne) domyślnych informacji o usłudze) lub po prostu udostępnić identyfikator żądania (zapisywany jako w dzienniku odpowiedzi).

Jeśli wolisz samodzielnie przechwytywać identyfikator żądania, możesz użyć jednej z następujące działania:

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

Do rejestrowania możesz użyć niestandardowego atrybutu CallSetting z parametrem TrailingMetadataHandler żądania identyfikatorów ze zwykłych jednoargumentowych wywołań.

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 strumieniowania

Identyfikator żądania jest zwracany jako część obiektu odpowiedzi interfejsu API strumieniowania. połączeń. Identyfikator żądania dla wywołania SearchStream możesz na przykład uzyskać jako następujące:

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V17.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 w ramach wyjątku GoogleAdsException za każdym razem, gdy wywołanie interfejsu API się nie powiedzie.

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

Zaawansowane logowanie

Jeśli dziennik interfejsu API nie zawiera wystarczających informacji, włącz bardziej szczegółowe rejestrowanie na stronie na poziomie gRPC. Pamiętaj, że wyniki mogą być bardzo obszerne. Logi gRPC są zapisywane do stderr, ale można dołączyć własny rejestrator, jak pokazano poniżej. Obsługiwane środowisko .

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

Konfiguracja TraceListener z użyciem pliku App.config (starsza wersja)

Jeśli Twoja aplikacja kompiluje się na potrzeby środowiska docelowego .NET Framework, możesz wczytać tag logowania z pliku App.config lub Web.config aplikacji. To jest starsza funkcja .NET, która nie jest obsługiwana w przypadku aplikacji utworzonych na potrzeby .NET Core celów.

Aby korzystać z tej funkcji, musisz dodać do konfiguracji te zmiany plik:

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

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

   App.config wygląda wtedy tak:

   <?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>