লগিং কনফিগার করুন

.NET ক্লায়েন্ট লাইব্রেরিটি গুগল অ্যাডস এপিআই-তে করা অনুরোধ, প্রতিক্রিয়া এবং সারসংক্ষেপ বার্তাগুলো লগ করে। এই লগগুলো একটি কাস্টম TraceListener অথবা একটি কাস্টম ILogger ইনস্ট্যান্সে লেখা যেতে পারে।

ট্রেসলিসেনার

যেকোনো API কল করার আগে আপনার 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);

আইলগার

আপনি যদি আপনার অ্যাপ্লিকেশন লগের জন্য ইতিমধ্যেই একটি 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-এর মতো বিদ্যমান লগিং ফ্রেমওয়ার্কগুলিতে একীভূত করার সুযোগ দেয়।

লগ স্তর

লাইব্রেরিটি বিভিন্ন ধরণের ইভেন্টকে বিভিন্ন লগ লেভেলে লগ করে:

• সফল API প্রতিক্রিয়া : সারসংক্ষেপ 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>