লগিং

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

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

যেকোনো API কল করার আগে আপনার Main মেথডে নিম্নলিখিত লাইনটি যোগ করে একটি TraceListener এ লগিং চালু করতে পারেন।

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

মনে রাখবেন যে, অ্যাপ্লিকেশন লাইফসাইকেলে TraceListeners.Configure শুধুমাত্র একবারই কল করা উচিত, কারণ এর দ্বারা তৈরি TraceListener অ্যাপ্লিকেশন দ্বারা করা সমস্ত API অনুরোধের জন্য স্বয়ংক্রিয়ভাবে পুনরায় ব্যবহৃত হবে; প্রতিটি API অনুরোধের জন্য আপনাকে নতুন করে একটি তৈরি করতে হবে না।

আইলগার

আপনি যদি আপনার অ্যাপ্লিকেশন লগের জন্য ইতিমধ্যেই একটি 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 এ লগ করা হয়।

অনুরোধ আইডি

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

যদি আপনি নিজে রিকোয়েস্ট আইডি সংগ্রহ করতে চান, তাহলে নিম্নলিখিত পদ্ধতিগুলোর মধ্যে একটি ব্যবহার করতে পারেন:

সাধারণ এপিআই কলের মাধ্যমে নিষ্কাশন

আপনি সাধারণ ইউনিটারি কল থেকে রিকোয়েস্ট আইডি ক্যাপচার করার জন্য TrailingMetadataHandler সহ একটি কাস্টম CallSetting ব্যবহার করতে পারেন।

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

স্ট্রিমিং এপিআই কলের মাধ্যমে নিষ্কাশন

স্ট্রিমিং এপিআই কলের ক্ষেত্রে রেসপন্স অবজেক্টের অংশ হিসেবে রিকোয়েস্ট আইডি ফেরত দেওয়া হয়। উদাহরণস্বরূপ, আপনি একটি 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,
    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 এক্সেপশনের অংশ হিসেবে রিকোয়েস্ট আইডিটি ফেরত দেওয়া হয়।

try
{
  // Make an API call.
  ...
}
catch (GoogleAdsException e)
{
    string requestId = e.RequestId;
}

উন্নত লগিং

যদি এপিআই লগ আপনাকে যথেষ্ট বিবরণ না দেয়, তাহলে gRPC স্তরে আরও নিম্ন-স্তরের লগিং সক্ষম করুন। মনে রাখবেন যে এর আউটপুট বিশাল হতে পারে। gRPC লগগুলি stderr-এ লেখা হয়, কিন্তু আপনি এই উদাহরণে দেখানো অনুযায়ী আপনার নিজস্ব লগার সংযুক্ত করতে পারেন। সমর্থিত এনভায়রনমেন্ট ভেরিয়েবল ।

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 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"></section>
   

   তখন আপনার App.config দেখতে এইরকম হবে:

   <?xml version="1.0" encoding="utf-8"?>
   <configuration>
     <configSections>
       <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"></section>
       <section name="system.diagnostics" type="System.Diagnostics.SystemDiagnosticsSection"></section>
     </configSections>
     <GoogleAdsApi>
       <!-- Google Ads API settings. -->
     </GoogleAdsApi>
     <system.diagnostics>
       <!-- Logging settings. -->
     </system.diagnostics>
   </configuration>