Logging

ไลบรารีของไคลเอ็นต์ .NET จะบันทึกคำขอ การตอบกลับ และข้อความสรุปที่ส่งไปยัง Google Ads API คุณเขียนบันทึกไปยัง TraceListener ที่กำหนดเองหรืออินสแตนซ์ ILogger ที่กำหนดเองก็ได้

TraceListener

คุณเปิดใช้การบันทึกไปยัง TraceListener ได้โดยการเพิ่มบรรทัดต่อไปนี้ในเมธอด Main ก่อนที่จะทำการเรียก 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

หากคุณใช้ ILogger สำหรับบันทึกของแอปพลิเคชันอยู่แล้ว โซลูชันนี้จะให้คุณผสานรวมบันทึก Google Ads API ไว้ในบันทึกที่มีอยู่

ก่อนอื่นให้สร้าง LoggerFactory หรือหากมีอยู่แล้ว ให้เพิ่มตัวกรองสำหรับบันทึก 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);
});

จากนั้นใช้ LoggerFactory เพื่อสร้างตัวบันทึกสำหรับข้อมูลสรุปคำขอและการตอบกลับ ตลอดจนรายละเอียดดังนี้

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

สุดท้าย กำหนดค่าไลบรารีของไคลเอ็นต์เพื่อเปลี่ยนเส้นทางการติดตามไปยังอินสแตนซ์ ILogger ดังนี้

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

โซลูชันนี้ให้คุณผสานรวมคำขอและบันทึกการตอบกลับของ Google Ads API เข้ากับเฟรมเวิร์กการบันทึกที่มีอยู่ เช่น Log4Net, NLog และ Serilog

ระดับบันทึก

ไลบรารีจะบันทึกเหตุการณ์ประเภทต่างๆ ในระดับการบันทึกที่ต่างกัน เพื่อให้การตอบกลับจาก API เสร็จสมบูรณ์ ระบบจะบันทึกสรุปไว้ที่ INFO และจะบันทึกคำขอแบบเต็มและการตอบกลับที่ DEBUG

ในคำขอที่ส่งผลให้เกิดข้อผิดพลาดของ API ระบบจะบันทึกข้อความสรุปไว้ที่ WARN และจะบันทึกคำขอแบบเต็มและการตอบกลับที่ INFO

ระบบจะบันทึกความล้มเหลวบางส่วนที่ DEBUG

รหัสคำขอ

ในกรณีส่วนใหญ่ บันทึกที่สร้างโดยไลบรารีของไคลเอ็นต์จะมีรายละเอียดที่เพียงพอในการแก้ปัญหาของคุณ เมื่อคุณติดต่อฟอรัมการสนับสนุน/ชื่อแทน คุณสามารถให้บันทึก (ซึ่งจะปกปิดข้อมูลที่ละเอียดอ่อนโดยค่าเริ่มต้น) หรือแชร์รหัสคำขอ (ซึ่งเป็นส่วนหนึ่งของบันทึกการตอบกลับ) ก็ได้

หากคุณต้องการบันทึกรหัสคำขอด้วยตัวเอง ให้ใช้วิธีใดวิธีหนึ่งต่อไปนี้

การดึงข้อมูลผ่านการเรียก API ทั่วไป

คุณใช้ CallSetting ที่กำหนดเองกับ TrailingMetadataHandler เพื่อบันทึกรหัสคำขอจากการเรียกอิสระปกติได้

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

การดึงข้อมูลผ่านการเรียก API สตรีมมิง

รหัสคำขอจะแสดงเป็นส่วนหนึ่งของออบเจ็กต์การตอบกลับสำหรับการเรียก API สตรีมมิง ตัวอย่างเช่น คุณจะรับรหัสคำขอสำหรับการโทรด้วย SearchStream ได้ดังนี้

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V16.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);
        }
    }
);

ข้อยกเว้น

ระบบจะส่งรหัสคำขอกลับมาเป็นส่วนหนึ่งของข้อยกเว้น GoogleAdsException เมื่อการเรียก API ล้มเหลว

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

การบันทึกขั้นสูง

หากบันทึก API ให้รายละเอียดไม่เพียงพอ ให้เปิดใช้การบันทึกในระดับต่ำมากขึ้นที่ระดับ gRPC โปรดทราบว่าเอาต์พุตอาจมีขนาดใหญ่ ระบบจะเขียนบันทึก gRPC ลงใน stderr แต่คุณจะแนบบันทึกของตนเองได้ดังที่แสดงด้านล่าง ตัวแปรสภาพแวดล้อมที่รองรับ

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

การกำหนดค่า TraceListener โดยใช้ App.config (เดิม)

หากแอปสร้างขึ้นสำหรับเป้าหมาย .NET Framework คุณจะโหลดการกำหนดค่าการบันทึกจากไฟล์ App.config หรือ Web.config ของแอปได้ นี่คือฟังก์ชันการทำงานของ .NET เดิมที่ไม่รองรับสำหรับแอปที่สร้างขึ้นสำหรับเป้าหมาย .NET Core

หากต้องการใช้ฟีเจอร์นี้ คุณต้องเพิ่มการเปลี่ยนแปลงต่อไปนี้ลงในไฟล์การกำหนดค่า

1. เพิ่มข้อมูลโค้ดต่อไปนี้ในส่วน <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. เพิ่มข้อมูลโค้ดต่อไปนี้ในส่วน <configSections>

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

   จากนั้น App.config จะมีลักษณะดังนี้

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