Mengonfigurasi 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:

using Google.Ads.GoogleAds.Util;

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

// Summary logs.
TraceUtilities.Configure(
    TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE,
    "logs/summary.log",
    System.Diagnostics.SourceLevels.All);

ILogger

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

Pertama, buat LoggerFactory, atau jika Anda sudah memilikinya, tambahkan filter untuk log Google Ads API:

var loggerFactory = LoggerFactory.Create(builder =>
{
    // Log to stdout.
    builder.AddConsole();
    builder.AddFilter(
        TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE, LogLevel.Trace);
    builder.AddFilter(
        TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE, LogLevel.Trace);
});

Kemudian, gunakan LoggerFactory untuk 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, konfigurasi library klien untuk mengalihkan jejaknya 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 mencatat berbagai jenis peristiwa pada berbagai level log:

• Respons API yang berhasil: Ringkasan dicatat di INFO; permintaan dan respons lengkap dicatat di DEBUG.
• Respons error API: Pesan ringkasan dicatat di WARN; permintaan dan respons lengkap dicatat di INFO.
• Kegagalan parsial: Dicatat dalam log pada DEBUG.

ID Permintaan

Biasanya, log yang dihasilkan oleh library klien memberikan detail yang cukup untuk memecahkan masalah Anda. Saat Anda menghubungi dukungan, berikan log (yang secara default menyamarkan kolom autentikasi sensitif) atau bagikan ID permintaan, yang dicatat sebagai bagian dari log respons.

Jika Anda lebih suka mengambil ID permintaan secara terprogram, gunakan salah satu pendekatan berikut.

Ekstrak dari panggilan API unary biasa

Anda dapat menggunakan CallSettings kustom dengan TrailingMetadataHandler untuk merekam ID permintaan dari panggilan unary reguler:

CallSettings callSettings = CallSettings.FromTrailingMetadataHandler(
    metadata =>
    {
        // Extract and log the request ID from the trailing metadata.
        string requestId = metadata.Get("request-id")?.Value;
        Console.WriteLine($"Request ID: {requestId}");
    });
// Add the campaigns.
MutateCampaignsResponse retVal = campaignService.MutateCampaigns(
    customerId.ToString(), operations.ToArray(), callSettings);

Mengekstrak dari panggilan API streaming

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

// 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,
    (SearchGoogleAdsStreamResponse resp) =>
    {
        // Extract the request ID from the response.
        string requestId = resp.RequestId;
        Console.WriteLine($"Request ID: {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;
    Console.WriteLine($"Failed Request ID: {requestId}");
}

Mengonfigurasi logging lanjutan

Jika log API tidak memberikan detail yang cukup, aktifkan logging tingkat yang lebih rendah di tingkat transportasi gRPC. Perlu diingat bahwa outputnya bisa sangat banyak.

Saat menggunakan transportasi Grpc.Net.Client default, konfigurasikan log tingkat transportasi melalui penyedia ILogger .NET dengan menambahkan filter untuk kategori Grpc (misalnya, builder.AddFilter("Grpc", LogLevel.Debug)).

Jika Anda menggunakan transportasi Grpc.Core lama (UseGrpcCore = true), log gRPC ditulis ke stderr secara default, atau Anda dapat melampirkan logger Anda sendiri seperti yang ditunjukkan dalam contoh berikut. Untuk mengetahui detail selengkapnya, lihat variabel lingkungan gRPC 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 modern.

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

1. Tambahkan cuplikan berikut di 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 a 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 a 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 Google Ads .NET libraries. The default level is set to
            Warning. To disable all messages, set this value to Off. -->
       <add name="GoogleAds.DeprecationMessages" value="Warning" />
       <!-- Use this trace switch to control the detailed request logs written
            by Google 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 Google 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 bagian <configSections>:

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

   App.config Anda kemudian 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>