Logging

Library klien .NET mencatat log permintaan, respons, dan pesan ringkasan yang dibuat ke Google Ads API. Log dapat ditulis ke logger default di library .NET, atau TraceListener kustom.

Konfigurasi

Anda dapat mengaktifkan logging 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,
    "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);

Konfigurasi menggunakan App.config (lama)

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

Untuk menggunakan fitur ini, Anda perlu menambahkan 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 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 bagian <configSections>.

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

    Kemudian, App.config 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>
    

Level log

Library mencatat berbagai jenis peristiwa ke tingkat log yang berbeda. Untuk respons API yang berhasil, ringkasan akan dicatat di INFO, dan permintaan serta respons selengkapnya akan dicatat ke dalam log di DEBUG. Pada permintaan yang menghasilkan error API, pesan ringkasan dicatat dalam log di WARN, dan permintaan serta respons lengkap akan dicatat ke dalam log di INFO.

Kegagalan sebagian dicatat di DEBUG.

ID permintaan

Dalam sebagian besar kasus, log yang dihasilkan oleh library klien menyediakan detail yang memadai untuk memecahkan masalah Anda. Saat menghubungi forum/alias dukungan, Anda dapat memberikan log (yang mengedit informasi sensitif secara default) atau cukup membagikan ID permintaan (yang dicatat ke dalam log sebagai bagian dari log respons).

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

Ekstraksi melalui panggilan API biasa

Anda dapat menggunakan CallSetting kustom dengan TrailingMetadataHandler untuk mengambil ID permintaan dari panggilan uner 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);

Ekstraksi melalui panggilan API streaming

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

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V11.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 memadai, aktifkan logging tingkat rendah yang lebih banyak pada tingkat gRPC. Perlu diingat bahwa output tersebut bisa sangat besar. Log gRPC ditulis pada stderr, tetapi Anda dapat melampirkan logger Anda sendiri seperti yang ditunjukkan di bawah ini. Variabel lingkungan yang didukung.

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