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.V19.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>