Logging

La libreria client .NET registra richieste, risposte e messaggi di riepilogo inviati l'API Google Ads. I log possono essere scritti in un ambiente TraceListener, o a un modello ILogger in esecuzione in un'istanza Compute Engine.

TraceListener

Puoi abilitare il logging a un TraceListener aggiungendo la seguente riga nella Main prima di effettuare qualsiasi chiamata 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

Se utilizzi già un'ILogger per i log delle applicazioni, questa soluzione ti consente di integrare i log dell'API Google Ads nei log esistenti.

Innanzitutto, crea un LoggerFactory o, se ne hai già uno, aggiungi i filtri Per i log dell'API Google Ads:

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

Poi, utilizza LoggerFactory per creare logger per richieste e risposte riepiloghi e dettagli:

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

Infine, configura la libreria client in modo che reindirizzi le sue tracce al tuo ILogger di Compute Engine:

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

Questa soluzione consente di integrare i log delle richieste e delle risposte dell'API Google Ads in framework di logging esistenti, come Log4Net, NLog e Serilog.

Livelli di log

La libreria registra diversi tipi di eventi in livelli di log differenti. Per un risposta API con esito positivo, il riepilogo viene registrato in INFO e i dati richieste e risposte vengono registrate in DEBUG.

Quando una richiesta genera un errore dell'API, il messaggio di riepilogo viene registrato WARN e la richiesta e la risposta complete vengono registrate in INFO.

Gli errori parziali vengono registrati alle ore DEBUG.

ID richiesta

Nella maggior parte dei casi, i log generati dalla libreria client forniscono i dettagli per risolvere i problemi. Quando contatti l'assistenza forum/alias, puoi fornire i log (che oscurano le informazioni per impostazione predefinita) o semplicemente l'ID richiesta (che viene registrato come nel log delle risposte).

Se preferisci acquisire l'ID richiesta personalmente, puoi utilizzare una delle seguenti opzioni i seguenti approcci:

Estrazione tramite chiamate API ordinarie

Puoi utilizzare un CallSetting personalizzato con un TrailingMetadataHandler per l'acquisizione gli ID richiesta delle normali chiamate unary.

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

Estrazione tramite chiamate API in modalità flusso

L'ID richiesta viene restituito come parte dell'oggetto risposta per l'API flusso di dati chiamate. Ad esempio, puoi ottenere l'ID richiesta per una chiamata SearchStream come che segue:

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

Eccezioni

L'ID richiesta viene restituito nell'ambito dell'eccezione GoogleAdsException ogni volta che una chiamata API non va a buon fine.

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

Logging avanzato

Se il log dell'API non fornisce dettagli sufficienti, abilita un logging di livello più basso all'indirizzo a livello di gRPC. Tieni presente che l'output può essere voluminoso. I log gRPC sono scritte in stderr, ma puoi collegare il tuo logger come mostrato di seguito. Ambiente supportato variabili.

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

Configurazione di TraceListener con App.config (legacy)

Se la tua app crea una destinazione per .NET Framework, puoi caricare il file configurazione dal file App.config o Web.config dell'app. Si tratta di un funzionalità .NET legacy non supportata per le app create per .NET Core target.

Per utilizzare questa funzionalità, devi aggiungere le seguenti modifiche alla configurazione file:

1. Aggiungi il seguente snippet nella sezione <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. Aggiungi il seguente snippet nella sezione <configSections>.

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

   Il tuo App.config avrà quindi questo aspetto:

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