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

.NET ক্লায়েন্ট লাইব্রেরি, Google Ads API-তে করা অনুরোধ, উত্তর ও সারসংক্ষেপ মেসেজ লগ করে। কাস্টম TraceListener বা কাস্টম ILogger ইনস্ট্যান্সে লগ লেখা যেতে পারে।

সতর্কতা: ক্লায়েন্ট লাইব্রেরি ডিফল্ট হিসেবে লগে OAuth টোকেন রিড্যাক্ট করলেও, লগ ফাইলে এখনও গ্রাহক ও ক্যাম্পেন সংক্রান্ত সংবেদনশীল তথ্য থাকতে পারে। যেসব ডিরেক্টরিতে লগ ফাইল স্টোর করা হয় সেখানে ফাইল অ্যাক্সেস করার পারমিশন সবসময় সীমাবদ্ধ করুন।

TraceListener

কোনও 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);

মনে রাখবেন: অ্যাপ্লিকেশন লাইফসাইকেলে TraceUtilities.Configure একবারই কল করুন। এটি যে TraceListener তৈরি করে তা অ্যাপ্লিকেশন দ্বারা করা সমস্ত API অনুরোধ জুড়ে অটোমেটিক আবার ব্যবহার করা হয়; প্রতিটি API অনুরোধের জন্য আপনাকে একটি নতুন তৈরি করতে হবে না।

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-এর মতো বিদ্যমান লগিং ফ্রেমওয়ার্কে একীভূত করতে দেয়।

লগ লেভেল

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

• সফল API রেসপন্স: সারসংক্ষেপ INFO-এ লগ করা হয়েছে; সম্পূর্ণ অনুরোধ এবং রেসপন্স DEBUG-এ লগ করা হয়েছে।
• API সমস্যার উত্তর: সারসংক্ষেপ মেসেজ WARN-এ লগ করা হয়েছে; সম্পূর্ণ অনুরোধ ও উত্তর INFO-এ লগ করা হয়েছে।
• আংশিক ব্যর্থতা: DEBUG-এ লগ করা হয়েছে।

অনুরোধ আইডি

বেশিরভাগ ক্ষেত্রে, ক্লায়েন্ট লাইব্রেরির মাধ্যমে তৈরি করা লগ আপনার সমস্যার সমাধান করার জন্য পর্যাপ্ত বিবরণ প্রদান করে। আপনি সহায়তা টিমের সাথে যোগাযোগ করলে, হয় লগ প্রদান করুন (যা ডিফল্ট হিসেবে সংবেদনশীল যাচাইকরণ ফিল্ড রিড্যাক্ট করে) অথবা অনুরোধ আইডি শেয়ার করুন, যা রেসপন্স লগের অংশ হিসেবে লগ করা হয়।

আপনি যদি প্রোগ্রাম্যাটিকভাবে অনুরোধ আইডি ক্যাপচার করতে চান, তাহলে নিম্নলিখিত পদ্ধতিগুলির মধ্যে একটি ব্যবহার করুন।

সাধারণ ইউনিটারি API কল থেকে এক্সট্র্যাক্ট করা

সাধারণ ইউনিটারি কল থেকে অনুরোধ আইডি ক্যাপচার করতে, আপনি 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);

স্ট্রিমিং API কল থেকে এক্সট্র্যাক্ট করা

স্ট্রিমিং API কলের জন্য রেসপন্স অবজেক্টের অংশ হিসেবে অনুরোধ আইডি রিটার্ন করা হয়। যেমন, আপনি 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);
        }
    }
);

ব্যতিক্রম

API কল কাজ না করলে, GoogleAdsException ব্যতিক্রমের অংশ হিসেবে অনুরোধ আইডি ফেরত পাঠানো হয়:

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

উন্নত লগিং কনফিগার করুন

API লগ থেকে আপনি পর্যাপ্ত বিবরণ না পেলে, 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 Framework টার্গেটের জন্য তৈরি হলে, আপনি অ্যাপের 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>