Logging

Library klien .NET mencatat permintaan, respons, dan pesan ringkasan yang dibuat ke Google Ads API. Log dapat ditulis ke TraceListener kustom atau ke instance ILogger kustom.

TraceListener

Anda dapat mengaktifkan logging ke TraceListener dengan menambahkan baris berikut dalam metode Main sebelum melakukan panggilan API apa pun.

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

Jika Anda sudah menggunakan ILogger untuk log aplikasi, solusi ini memungkinkan Anda mengintegrasikan log Google Ads API ke dalam log yang sudah ada.

Pertama-tama, buat LoggerFactory, atau jika sudah memilikinya, tambahkan filter untuk log 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);
});

Selanjutnya, gunakan LoggerFactory guna membuat logger untuk ringkasan dan detail permintaan dan respons:

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

Terakhir, konfigurasikan library klien untuk mengalihkan trace-nya ke instance ILogger Anda:

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

Solusi ini memungkinkan Anda mengintegrasikan log permintaan dan respons Google Ads API ke dalam framework logging yang ada, seperti Log4Net, NLog, dan Serilog.

Level log

Library ini mencatat berbagai jenis peristiwa ke dalam berbagai level log. Agar respons API berhasil, ringkasan dicatat ke dalam log pada INFO, dan permintaan serta respons lengkap dicatat dalam log pada DEBUG.

Pada permintaan yang menyebabkan error API, pesan ringkasan akan dicatat ke dalam log di WARN, serta permintaan dan respons lengkap dicatat ke dalam log pada INFO.

Kegagalan sebagian dicatat pada DEBUG.

ID Permintaan

Pada umumnya, log yang dibuat oleh library klien memberikan detail yang memadai untuk memecahkan masalah Anda. Saat menghubungi forum/alias dukungan, Anda dapat memberikan log (yang menyamarkan informasi sensitif secara default) atau cukup membagikan ID permintaan (yang dicatat dalam log sebagai bagian dari log respons).

Jika ingin mengambil ID permintaan sendiri, Anda dapat menggunakan salah satu pendekatan berikut:

Mengekstraksi melalui panggilan API biasa

Anda dapat menggunakan CallSetting kustom dengan TrailingMetadataHandler untuk mengambil ID permintaan dari panggilan unary reguler.

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

Mengekstraksi melalui panggilan API streaming

ID permintaan ditampilkan sebagai bagian dari objek respons untuk panggilan API streaming. Misalnya, Anda bisa mendapatkan ID permintaan untuk panggilan SearchStream seperti berikut:

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

Pengecualian

ID permintaan ditampilkan sebagai bagian dari pengecualian GoogleAdsException setiap kali panggilan API gagal.

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

Logging lanjutan

Jika log API tidak memberikan detail yang cukup, aktifkan lebih banyak logging tingkat rendah di tingkat gRPC. Perlu diingat bahwa outputnya bisa sangat besar. Log gRPC ditulis ke stderr, tetapi Anda dapat melampirkan logger Anda sendiri seperti yang ditunjukkan di bawah. Variabel lingkungan yang didukung.

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

Konfigurasi TraceListener menggunakan App.config (lama)

Jika aplikasi Anda dibangun untuk target .NET Framework, Anda dapat memuat konfigurasi logging dari file App.config atau Web.config aplikasi Anda. Ini adalah fungsi .NET lama yang tidak didukung untuk aplikasi yang dibangun untuk target .NET Core.

Untuk menggunakan fitur ini, Anda perlu menambahkan perubahan berikut ke file konfigurasi:

1. Tambahkan cuplikan berikut di bawah bagian <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. Tambahkan cuplikan berikut di bawah bagian <configSections>.

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

   App.config Anda akan terlihat seperti ini:

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