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

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

TraceListener

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

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

अगर अपने ऐप्लिकेशन के लॉग के लिए, पहले से ही 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.V26.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>