लॉगिंग कॉन्फ़िगर करें

.NET क्लाइंट लाइब्रेरी, Google Ads API को भेजे गए अनुरोधों, जवाबों, और खास जानकारी वाले मैसेज को लॉग करती है. लॉग को कस्टम TraceListener या कस्टम ILogger इंस्टेंस में लिखा जा सकता है.

TraceListener

एपीआई कॉल करने से पहले, अपने Main तरीके में यहां दी गई लाइनें जोड़कर, TraceListener में लॉगिंग चालू की जा सकती है:

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);
TraceListener से जनरेट किया गया टोकन, ऐप्लिकेशन से किए गए सभी एपीआई अनुरोधों में अपने-आप इस्तेमाल होता है. आपको हर एपीआई अनुरोध के लिए नया टोकन बनाने की ज़रूरत नहीं होती.

ILogger

अगर ऐप्लिकेशन के लॉग के लिए पहले से ही किसी ILogger का इस्तेमाल किया जा रहा है, तो इस समाधान की मदद से, Google Ads API के लॉग को अपने मौजूदा लॉगिंग इन्फ़्रास्ट्रक्चर में इंटिग्रेट किया जा सकता है.

सबसे पहले, एक LoggerFactory बनाएं. अगर आपके पास पहले से ही कोई फ़िल्टर है, तो 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);
});

इसके बाद, अनुरोध और जवाब की खास जानकारी और ज़्यादा जानकारी के लिए, लॉगिंग की सुविधा चालू करने के लिए 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 जैसे मौजूदा लॉगिंग फ़्रेमवर्क में इंटिग्रेट किया जा सकता है.

लॉग लेवल

लाइब्रेरी, अलग-अलग लॉग लेवल पर अलग-अलग तरह के इवेंट लॉग करती है:

  • एपीआई से मिला जवाब: खास जानकारी को INFO पर लॉग किया जाता है; पूरे अनुरोध और जवाब को DEBUG पर लॉग किया जाता है.
  • एपीआई से जुड़ी गड़बड़ी का जवाब: खास जानकारी वाला मैसेज WARN पर लॉग किया जाता है; पूरा अनुरोध और जवाब INFO पर लॉग किया जाता है.
  • कुछ फ़ाइलों का फ़ॉर्मैट नहीं बदला जा सका: DEBUG पर लॉग किया गया.

अनुरोध का आईडी

ज़्यादातर मामलों में, क्लाइंट लाइब्रेरी से जनरेट किए गए लॉग में, आपकी समस्याओं को हल करने के लिए ज़रूरी जानकारी मौजूद होती है. सहायता टीम से संपर्क करते समय, लॉग उपलब्ध कराएं. इनमें पुष्टि करने के लिए इस्तेमाल किए गए संवेदनशील फ़ील्ड की जानकारी डिफ़ॉल्ट रूप से छिपी होती है. इसके अलावा, अनुरोध आईडी भी शेयर किया जा सकता है. यह आईडी, जवाब के लॉग के तौर पर सेव होता है.

अगर आपको प्रोग्राम के हिसाब से अनुरोध आईडी कैप्चर करना है, तो इनमें से कोई एक तरीका इस्तेमाल करें.

सामान्य यूनरी एपीआई कॉल से एक्सट्रैक्ट करना

सामान्य यूनरी कॉल से अनुरोध आईडी कैप्चर करने के लिए, TrailingMetadataHandler के साथ कस्टम CallSettings का इस्तेमाल किया जा सकता है:

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

स्ट्रीमिंग एपीआई कॉल से निकालना

अनुरोध आईडी, स्ट्रीमिंग एपीआई कॉल के लिए रिस्पॉन्स ऑब्जेक्ट के हिस्से के तौर पर दिखाया जाता है. उदाहरण के लिए, SearchStream कॉल के लिए अनुरोध आईडी इस तरह से पाया जा सकता है:

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

अपवाद

जब भी कोई एपीआई कॉल पूरा नहीं होता है, तो अनुरोध आईडी को GoogleAdsException अपवाद के तौर पर दिखाया जाता है:

try
{
    // Make an API call.
}
catch (GoogleAdsException e)
{
    string requestId = e.RequestId;
    Console.WriteLine($"Failed Request ID: {requestId}");
}

ऐडवांस लॉगिंग की सुविधा कॉन्फ़िगर करना

अगर एपीआई लॉग से आपको पूरी जानकारी नहीं मिलती है, तो gRPC ट्रांसपोर्ट लेवल पर लोअर-लेवल लॉगिंग चालू करें. ध्यान रखें कि आउटपुट में काफ़ी जानकारी हो सकती है.

डिफ़ॉल्ट Grpc.Net.Client ट्रांसपोर्ट का इस्तेमाल करते समय, .NET के ILogger प्रोवाइडर के ज़रिए ट्रांसपोर्ट-लेवल के लॉग कॉन्फ़िगर करें. इसके लिए, Grpc कैटगरी (उदाहरण के लिए, builder.AddFilter("Grpc", LogLevel.Debug)) के लिए फ़िल्टर जोड़ें.

अगर लेगसी Grpc.Core ट्रांसपोर्ट (UseGrpcCore = true) का इस्तेमाल किया जा रहा है, तो gRPC लॉग डिफ़ॉल्ट रूप से stderr में लिखे जाते हैं. इसके अलावा, यहां दिए गए उदाहरण में दिखाए गए तरीके से, अपना खुद का लॉगर अटैच किया जा सकता है. ज़्यादा जानकारी के लिए, gRPC के साथ काम करने वाले एनवायरमेंट वैरिएबल देखें.

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

App.config (लेगसी) का इस्तेमाल करके TraceListener को कॉन्फ़िगर करना

अगर आपका ऐप्लिकेशन .NET फ़्रेमवर्क के लिए बनाया गया है, तो अपने ऐप्लिकेशन की App.config या Web.config फ़ाइल से लॉगिंग कॉन्फ़िगरेशन लोड किया जा सकता है. यह .NET की लेगसी सुविधा है. यह आधुनिक .NET टारगेट के लिए बनाए गए ऐप्लिकेशन के साथ काम नहीं करती.

इस सुविधा का इस्तेमाल करने के लिए, अपनी कॉन्फ़िगरेशन फ़ाइल में ये बदलाव करें:

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