লগিং

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

TraceListener

আপনি যেকোন 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);

আইলগার

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

এই সমাধানটি আপনাকে Log4Net, NLog এবং Serilog-এর মতো বিদ্যমান লগিং ফ্রেমওয়ার্কগুলিতে Google Ads API অনুরোধ এবং প্রতিক্রিয়া লগগুলিকে একীভূত করতে দেয়।

লগ লেভেল

লাইব্রেরি বিভিন্ন ধরনের ইভেন্ট বিভিন্ন লগ লেভেলে লগ করে। একটি সফল API প্রতিক্রিয়ার জন্য, সারাংশটি INFO এ লগ করা হয়েছে, এবং সম্পূর্ণ অনুরোধ এবং প্রতিক্রিয়াগুলি DEBUG এ লগ করা হয়েছে৷

একটি অনুরোধের ফলে একটি API ত্রুটি দেখা দেয়, সংক্ষিপ্ত বার্তাটি WARN এ লগ করা হয় এবং সম্পূর্ণ অনুরোধ এবং প্রতিক্রিয়া INFO এ লগ করা হয়।

আংশিক ব্যর্থতা DEBUG এ লগ করা হয়েছে।

আইডি অনুরোধ করুন

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

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

সাধারণ API কল মাধ্যমে নিষ্কাশন

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

স্ট্রিমিং API কলের মাধ্যমে নিষ্কাশন

এপিআই কল স্ট্রিমিং এর জন্য রেসপন্স অবজেক্টের অংশ হিসেবে রিকোয়েস্ট আইডি ফেরত দেওয়া হয়। উদাহরণস্বরূপ, আপনি নিম্নরূপ একটি SearchStream কলের জন্য অনুরোধ আইডি পেতে পারেন:

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V17.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);
        }
    }
);

ব্যতিক্রম

যখনই একটি API কল ব্যর্থ হয় তখন GoogleAdsException ব্যতিক্রমের অংশ হিসাবে অনুরোধ আইডিটি ফেরত দেওয়া হয়।

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

উন্নত লগিং

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

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

    আপনার 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>