लॉगिंग और मॉनिटरिंग एक साथ काम करती हैं. इससे आपको ऐप्लिकेशन की परफ़ॉर्मेंस को समझने और उसे ऑप्टिमाइज़ करने में मदद मिलती है. साथ ही, गड़बड़ियों और सिस्टम से जुड़ी समस्याओं का पता लगाने में भी मदद मिलती है. आपको सभी एपीआई कॉल के लिए खास जानकारी वाले लॉग और पूरे न होने वाले एपीआई कॉल के लिए ज़्यादा जानकारी वाले लॉग चालू करने चाहिए. इससे, तकनीकी सहायता की ज़रूरत पड़ने पर, एपीआई कॉल लॉग दिए जा सकते हैं.
क्लाइंट लाइब्रेरी लॉगिंग
Google Ads API क्लाइंट लाइब्रेरी में, लॉगिंग की सुविधा पहले से मौजूद होती है. प्लैटफ़ॉर्म के हिसाब से, लॉगिंग की जानकारी पाने के लिए, अपनी पसंद की क्लाइंट लाइब्रेरी में लॉगिंग दस्तावेज़ देखें.
लॉग का फ़ॉर्मैट
Google Ads API क्लाइंट लाइब्रेरी, हर एपीआई कॉल के लिए ज़्यादा जानकारी वाला लॉग और खास जानकारी वाला लॉग जनरेट करती हैं. ज़्यादा जानकारी वाले लॉग में, एपीआई कॉल की पूरी जानकारी होती है. वहीं, खास जानकारी वाले लॉग में एपीआई कॉल की कम जानकारी होती है. हर तरह के लॉग का उदाहरण दिखाया गया है. इन लॉग को पढ़ने के लिए, उन्हें छोटा किया गया है और फ़ॉर्मैट किया गया है.
खास जानकारी वाला लॉग
GoogleAds.SummaryRequestLogs Warning: 1 : [2023-09-15 19:58:39Z] -
Request made: Host: , Method: /google.ads.googleads.v14.services.GoogleAdsService/SearchStream,
ClientCustomerID: 5951878031, RequestID: hELhBPNlEDd8mWYcZu7b8g,
IsFault: True, FaultMessage: Status(StatusCode="InvalidArgument",
Detail="Request contains an invalid argument.")
ज़्यादा जानकारी वाला लॉग
GoogleAds.DetailedRequestLogs Verbose: 1 : [2023-11-02 21:09:36Z] -
---------------BEGIN API CALL---------------
Request
-------
Method Name: /google.ads.googleads.v14.services.GoogleAdsService/SearchStream
Host:
Headers: {
"x-goog-api-client": "gl-dotnet/5.0.0 gapic/17.0.1 gax/4.2.0 grpc/2.46.3 gccl/3.0.1 pb/3.21.5",
"developer-token": "REDACTED",
"login-customer-id": "1234567890",
"x-goog-request-params": "customer_id=4567890123"
}
{ "customerId": "4567890123", "query": "SELECT ad_group_criterion.type FROM
ad_group_criterion WHERE ad_group.status IN(ENABLED, PAUSED) AND
campaign.status IN(ENABLED, PAUSED) ", "summaryRowSetting": "NO_SUMMARY_ROW" }
Response
--------
Headers: {
"date": "Thu, 02 Nov 2023 21:09:35 GMT",
"alt-svc": "h3-29=\":443\"; ma=2592000"
}
{
"results": [ {
"adGroupCriterion": {
"resourceName": "customers/4567890123/adGroupCriteria/456789456789~123456123467",
"type": "KEYWORD"
} }, {
"adGroupCriterion": {
"resourceName": "customers/4567890123/adGroupCriteria/456789456789~56789056788",
"type": "KEYWORD"
} } ],
"fieldMask": "adGroupCriterion.type", "requestId": "VsJ4F00ew6s9heHvAJ-abw"
}
----------------END API CALL----------------
अगर मैं क्लाइंट लाइब्रेरी का इस्तेमाल नहीं करता, तो क्या होगा?
अगर क्लाइंट लाइब्रेरी का इस्तेमाल नहीं किया जाता है, तो आउटगोइंग और इनकमिंग एपीआई कॉल की जानकारी कैप्चर करने के लिए, अपनी लॉगिंग लागू करें. आपको कम से कम request-id रिस्पॉन्स हेडर की वैल्यू को लॉग करना चाहिए. इसके बाद, ज़रूरत के हिसाब से, इसे तकनीकी सहायता टीमों के साथ शेयर किया जा सकता है.
क्लाउड में लॉग करना
अपने ऐप्लिकेशन के लिए लॉग और परफ़ॉर्मेंस मेट्रिक कैप्चर करने के लिए, कई टूल का इस्तेमाल किया जा सकता है. उदाहरण के लिए, Google Cloud Logging का इस्तेमाल करके, अपने Google Cloud प्रोजेक्ट में परफ़ॉर्मेंस मेट्रिक को लॉग किया जा सकता है. इससे, लॉग की गई मेट्रिक का इस्तेमाल करने के लिए, Google Cloud मॉनिटरिंग में डैशबोर्ड और सूचनाएं सेट अप की जा सकती हैं.
Cloud Logging, Perl को छोड़कर Google Ads API क्लाइंट लाइब्रेरी की सभी भाषाओं के लिए क्लाइंट लाइब्रेरी उपलब्ध कराता है. इसलिए, ज़्यादातर मामलों में सीधे अपनी क्लाइंट लाइब्रेरी इंटिग्रेशन से Cloud Logging के साथ लॉग किया जा सकता है. Perl के साथ-साथ दूसरी भाषाओं के लिए भी, Cloud Logging में REST API उपलब्ध है.
Google Ads API क्लाइंट लाइब्रेरी से, Cloud Logging या किसी अन्य टूल में लॉग करने के कुछ विकल्प हैं. हर विकल्प के लागू होने में लगने वाले समय, जटिलता, और परफ़ॉर्मेंस के हिसाब से, अलग-अलग फ़ायदे और नुकसान होते हैं. कौनसा समाधान लागू करना है, यह तय करने से पहले इन फ़ायदों और नुकसानों के बारे में ध्यान से सोचें.
पहला विकल्प: बैकग्राउंड प्रोसेस से, लोकल लॉग को क्लाउड में लिखना
क्लाइंट लाइब्रेरी के लॉग को आपकी मशीन पर मौजूद किसी स्थानीय फ़ाइल में लिखा जा सकता है. इसके लिए, आपको लॉगिंग कॉन्फ़िगरेशन में बदलाव करना होगा. जब लॉग किसी लोकल फ़ाइल में आउटपुट हो जाते हैं, तो लॉग इकट्ठा करने और उन्हें क्लाउड पर भेजने के लिए, डेमन सेट अप किया जा सकता है.
इस तरीके की एक सीमा यह है कि कुछ परफ़ॉर्मेंस मेट्रिक डिफ़ॉल्ट रूप से कैप्चर नहीं होंगी. क्लाइंट लाइब्रेरी लॉग में, अनुरोध और रिस्पॉन्स ऑब्जेक्ट की जानकारी शामिल होती है. इसलिए, इंतज़ार का समय दिखाने वाली मेट्रिक तब तक शामिल नहीं की जाएंगी, जब तक इन मेट्रिक को लॉग करने के लिए अतिरिक्त बदलाव नहीं किए जाते.
दूसरा विकल्प: Compute Engine पर अपना ऐप्लिकेशन चलाना और Ops Agent इंस्टॉल करना
अगर आपका ऐप्लिकेशन Compute Engine पर चल रहा है, तो ऑपरेशंस एजेंट इंस्टॉल करके, अपने लॉग को Google Cloud Logging में भेजा जा सकता है. Ops Agent को कॉन्फ़िगर किया जा सकता है, ताकि आपके ऐप्लिकेशन के लॉग को Cloud Logging में भेजा जा सके. साथ ही, डिफ़ॉल्ट रूप से भेजी जाने वाली मेट्रिक और लॉग को भी भेजा जा सकता है.
अगर आपका ऐप्लिकेशन पहले से ही Google Cloud के एनवायरमेंट में चल रहा है या आपको अपने ऐप्लिकेशन को Google Cloud पर माइग्रेट करना है, तो यह एक बेहतरीन विकल्प है.
तीसरा विकल्प: अपने ऐप्लिकेशन कोड में लॉगिंग लागू करना
सीधे ऐप्लिकेशन कोड से लॉग इन करने के लिए, इनमें से कोई एक तरीका अपनाएं:
अपने कोड में, लागू होने वाली हर जगह पर मेट्रिक कैलकुलेशन और लॉग स्टेटमेंट शामिल करना. यह विकल्प छोटे कोडबेस के लिए ज़्यादा सही है, जहां इस तरह के बदलाव का दायरा और रखरखाव की लागत कम होगी.
लॉगिंग इंटरफ़ेस लागू करना. अगर ऐप्लिकेशन लॉजिक को अलग किया जा सकता है, ताकि ऐप्लिकेशन के अलग-अलग हिस्से एक ही बेस क्लास से इनहेरिट कर सकें, तो उस बेस क्लास में लॉगिंग लॉजिक लागू किया जा सकता है. आम तौर पर, पूरे ऐप्लिकेशन कोड में लॉग स्टेटमेंट शामिल करने के बजाय, इस विकल्प को प्राथमिकता दी जाती है. इसकी वजह यह है कि इसे मैनेज और स्केल करना आसान होता है. बड़े कोडबेस के लिए, इस समाधान को बनाए रखना और स्केल करना ज़्यादा काम का है.
इस तरीके की एक सीमा यह है कि ऐप्लिकेशन कोड से, अनुरोध और रिस्पॉन्स के पूरे लॉग उपलब्ध नहीं होते. पूरे अनुरोध और रिस्पॉन्स ऑब्जेक्ट को gRPC इंटरसेप्टर से ऐक्सेस किया जा सकता है. इसी तरह, पहले से मौजूद क्लाइंट लाइब्रेरी लॉगिंग, अनुरोध और रिस्पॉन्स लॉग हासिल करती है. गड़बड़ी होने पर, अपवाद ऑब्जेक्ट में ज़्यादा जानकारी उपलब्ध हो सकती है. हालांकि, ऐप्लिकेशन लॉजिक में सही जवाबों के लिए कम जानकारी उपलब्ध होती है. उदाहरण के लिए, ज़्यादातर मामलों में, Google Ads API के रिस्पॉन्स ऑब्जेक्ट से, पूरे हो चुके अनुरोध का अनुरोध आईडी ऐक्सेस नहीं किया जा सकता.
चौथा विकल्प: कस्टम gRPC लॉगिंग इंटरसेप्टर लागू करना
gRPC, यूनीरी और स्ट्रीमिंग इंटरसेप्टर्स के साथ काम करता है. ये क्लाइंट और सर्वर के बीच भेजे जाने वाले अनुरोध और रिस्पॉन्स ऑब्जेक्ट को ऐक्सेस कर सकते हैं. Google Ads API क्लाइंट लाइब्रेरी, पहले से मौजूद लॉगिंग की सुविधा देने के लिए gRPC इंटरसेप्टर का इस्तेमाल करती हैं. इसी तरह, अनुरोध और जवाब ऑब्जेक्ट को ऐक्सेस करने के लिए, कस्टम gRPC इंटरसेप्टर लागू किया जा सकता है. साथ ही, लॉगिंग और मॉनिटरिंग के लिए जानकारी निकाली जा सकती है और उस डेटा को अपनी पसंद की जगह पर सेव किया जा सकता है.
यहां बताए गए कुछ अन्य समाधानों के मुकाबले, कस्टम gRPC इंटरसेप्टर लागू करने से, आपको हर अनुरोध पर अनुरोध और रिस्पॉन्स ऑब्जेक्ट कैप्चर करने की सुविधा मिलती है. साथ ही, अनुरोध की जानकारी कैप्चर करने के लिए अतिरिक्त लॉजिक लागू किया जा सकता है. उदाहरण के लिए, कस्टम इंटरसेप्टर में परफ़ॉर्मेंस टाइमिंग लॉजिक लागू करके, किसी अनुरोध के बीते समय का हिसाब लगाया जा सकता है. इसके बाद, Google Cloud Logging में मेट्रिक को लॉग करके, उसे Google Cloud Monitoring में इंतज़ार का समय देखने के लिए उपलब्ध कराया जा सकता है.
Python में कस्टम Google Cloud लॉगिंग इंटरसेप्टर
इस समाधान को दिखाने के लिए, हमने Python में कस्टम लॉगिंग इंटरसेप्टर्स का उदाहरण लिखा है. कस्टम इंटरसेप्टर बनाया जाता है और उसे सेवा क्लाइंट में पास किया जाता है. इसके बाद, यह हर सेवा के तरीके के कॉल पर पास होने वाले अनुरोध और रिस्पॉन्स ऑब्जेक्ट को ऐक्सेस करता है. साथ ही, उन ऑब्जेक्ट से डेटा को प्रोसेस करता है और डेटा को Google Cloud Logging में भेजता है.
अनुरोध और जवाब ऑब्जेक्ट से मिलने वाले डेटा के अलावा, उदाहरण में कुछ और लॉजिक लागू किए गए हैं. इनसे अनुरोध में लगने वाला समय और कुछ अन्य मेटाडेटा कैप्चर किया जाता है. यह मेटाडेटा, निगरानी के लिए काम का होता है. जैसे, अनुरोध पूरा हुआ या नहीं. इस जानकारी का इस्तेमाल, मॉनिटरिंग के लिए कैसे किया जा सकता है, इस बारे में ज़्यादा जानने के लिए मॉनिटरिंग की गाइड देखें. यह जानकारी, Google Cloud लॉगिंग और Google Cloud मॉनिटरिंग को आपस में जोड़ने के लिए भी काम की है.
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""A custom gRPC Interceptor that logs requests and responses to Cloud Logging.
The custom interceptor object is passed into the get_service method of the
GoogleAdsClient. It intercepts requests and responses, parses them into a
human readable structure and logs them using the logging service instantiated
within the class (in this case, a Cloud Logging client).
"""
import logging
import time
from google.cloud import logging
from grpc import UnaryUnaryClientInterceptor, UnaryStreamClientInterceptor
from google.ads.googleads.interceptors import LoggingInterceptor, mask_message
class CloudLoggingInterceptor(LoggingInterceptor):
"""An interceptor that logs rpc request and response details to Google Cloud Logging.
This class inherits logic from the LoggingInterceptor, which simplifies the
implementation here. Some logic is required here in order to make the
underlying logic work -- comments make note of this where applicable.
NOTE: Inheriting from the LoggingInterceptor class could yield unexpected side
effects. For example, if the LoggingInterceptor class is updated, this class would
inherit the updated logic, which could affect its functionality. One option to avoid
this is to inherit from the Interceptor class instead, and selectively copy whatever
logic is needed from the LoggingInterceptor class."""
def __init__(self, api_version):
"""Initializer for the CloudLoggingInterceptor.
Args:
api_version: a str of the API version of the request.
"""
super().__init__(logger=None, api_version=api_version)
# Instantiate the Cloud Logging client.
logging_client = logging.Client()
self.logger = logging_client.logger("cloud_logging")
def log_successful_request(
self,
method,
customer_id,
metadata_json,
request_id,
request,
trailing_metadata_json,
response,
):
"""Handles logging of a successful request.
Args:
method: The method of the request.
customer_id: The customer ID associated with the request.
metadata_json: A JSON str of initial_metadata.
request_id: A unique ID for the request provided in the response.
request: An instance of a request proto message.
trailing_metadata_json: A JSON str of trailing_metadata.
response: A grpc.Call/grpc.Future instance.
"""
# Retrieve and mask the RPC result from the response future.
# This method is available from the LoggingInterceptor class.
# Ensure self._cache is set in order for this to work.
# The response result could contain up to 10,000 rows of data,
# so consider truncating this value before logging it, to save
# on data storage costs and maintain readability.
result = self.retrieve_and_mask_result(response)
# elapsed_ms is the approximate elapsed time of the RPC, in milliseconds.
# There are different ways to define and measure elapsed time, so use
# whatever approach makes sense for your monitoring purposes.
# rpc_start and rpc_end are set in the intercept_unary_* methods below.
elapsed_ms = (self.rpc_end - self.rpc_start) * 1000
debug_log = {
"method": method,
"host": metadata_json,
"request_id": request_id,
"request": str(request),
"headers": trailing_metadata_json,
"response": str(result),
"is_fault": False,
"elapsed_ms": elapsed_ms,
}
self.logger.log_struct(debug_log, severity="DEBUG")
info_log = {
"customer_id": customer_id,
"method": method,
"request_id": request_id,
"is_fault": False,
# Available from the Interceptor class.
"api_version": self._api_version,
}
self.logger.log_struct(info_log, severity="INFO")
def log_failed_request(
self,
method,
customer_id,
metadata_json,
request_id,
request,
trailing_metadata_json,
response,
):
"""Handles logging of a failed request.
Args:
method: The method of the request.
customer_id: The customer ID associated with the request.
metadata_json: A JSON str of initial_metadata.
request_id: A unique ID for the request provided in the response.
request: An instance of a request proto message.
trailing_metadata_json: A JSON str of trailing_metadata.
response: A JSON str of the response message.
"""
exception = self._get_error_from_response(response)
exception_str = self._parse_exception_to_str(exception)
fault_message = self._get_fault_message(exception)
info_log = {
"method": method,
"endpoint": self.endpoint,
"host": metadata_json,
"request_id": request_id,
"request": str(request),
"headers": trailing_metadata_json,
"exception": exception_str,
"is_fault": True,
}
self.logger.log_struct(info_log, severity="INFO")
error_log = {
"method": method,
"endpoint": self.endpoint,
"request_id": request_id,
"customer_id": customer_id,
"is_fault": True,
"fault_message": fault_message,
}
self.logger.log_struct(error_log, severity="ERROR")
def intercept_unary_unary(self, continuation, client_call_details, request):
"""Intercepts and logs API interactions.
Overrides abstract method defined in grpc.UnaryUnaryClientInterceptor.
Args:
continuation: a function to continue the request process.
client_call_details: a grpc._interceptor._ClientCallDetails
instance containing request metadata.
request: a SearchGoogleAdsRequest or SearchGoogleAdsStreamRequest
message class instance.
Returns:
A grpc.Call/grpc.Future instance representing a service response.
"""
# Set the rpc_end value to current time when RPC completes.
def update_rpc_end(response_future):
self.rpc_end = time.perf_counter()
# Capture precise clock time to later calculate approximate elapsed
# time of the RPC.
self.rpc_start = time.perf_counter()
# The below call is REQUIRED.
response = continuation(client_call_details, request)
response.add_done_callback(update_rpc_end)
self.log_request(client_call_details, request, response)
# The below return is REQUIRED.
return response
def intercept_unary_stream(
self, continuation, client_call_details, request
):
"""Intercepts and logs API interactions for Unary-Stream requests.
Overrides abstract method defined in grpc.UnaryStreamClientInterceptor.
Args:
continuation: a function to continue the request process.
client_call_details: a grpc._interceptor._ClientCallDetails
instance containing request metadata.
request: a SearchGoogleAdsRequest or SearchGoogleAdsStreamRequest
message class instance.
Returns:
A grpc.Call/grpc.Future instance representing a service response.
"""
def on_rpc_complete(response_future):
self.rpc_end = time.perf_counter()
self.log_request(client_call_details, request, response_future)
# Capture precise clock time to later calculate approximate elapsed
# time of the RPC.
self.rpc_start = time.perf_counter()
# The below call is REQUIRED.
response = continuation(client_call_details, request)
# Set self._cache to the cache on the response wrapper in order to
# access the streaming logs. This is REQUIRED in order to log streaming
# requests.
self._cache = response.get_cache()
response.add_done_callback(on_rpc_complete)
# The below return is REQUIRED.
return response