एक साथ कई कामों को लॉग और मॉनिटर करना, ताकि आपको अपने काम को समझने और उसे ऑप्टिमाइज़ करने में मदद मिल सके और साथ ही गड़बड़ियों और सिस्टम से जुड़ी समस्याओं के बारे में पता लगाने के लिए, समस्याएं. आपको सभी एपीआई कॉल के लिए खास जानकारी लॉग चालू करना चाहिए और एपीआई कॉल पूरे न हो पाने की ज़्यादा जानकारी वाले लॉग, ताकि आप एपीआई उपलब्ध करा सकें कॉल लॉग की ज़रूरत होती है. इसके लिए, तकनीकी सहायता की ज़रूरत होती है.
क्लाइंट लाइब्रेरी में लॉग इकट्ठा करने की सुविधा
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 क्लाउड लॉगिंग का इस्तेमाल कर सकते हैं आपके Google Cloud प्रोजेक्ट की परफ़ॉर्मेंस मेट्रिक. इससे यह Google Cloud मॉनिटरिंग में, डैशबोर्ड और अलर्ट सेट अप किए जा सकते हैं लॉग की गई मेट्रिक का इस्तेमाल करने के लिए.
Cloud Loging, इस्तेमाल किए जा सकने वाले सभी Google Ads API क्लाइंट के लिए क्लाइंट लाइब्रेरी की सुविधा देता है पर्ल को छोड़कर लाइब्रेरी भाषाओं का उपयोग नहीं किया है, इसलिए ज़्यादातर मामलों में सीधे अपनी क्लाइंट लाइब्रेरी इंटिग्रेशन से क्लाउड लॉगिंग. अन्य भाषाओं के लिए Perl के साथ-साथ, क्लाउड लॉगिंग भी REST API ऑफ़र करती है.
आपके पास क्लाउड लॉगिंग या किसी अन्य टूल में लॉग इन करने के लिए कुछ विकल्प हैं. Google Ads API क्लाइंट लाइब्रेरी. हर विकल्प के साथ आपको कुछ समय का अंतर भी मिलेगा लागू करना, जटिलता, और प्रदर्शन पर ध्यान देना. इन बातों को ध्यान में रखें देखें कि कौनसा समाधान लागू करना है.
पहला विकल्प: बैकग्राउंड में चल रही प्रोसेस के ज़रिए, क्लाउड पर लोकल लॉग लिखना
क्लाइंट लाइब्रेरी लॉग को आपकी मशीन पर, किसी लोकल फ़ाइल में आपका लॉगिंग कॉन्फ़िगरेशन. जब लॉग किसी लोकल फ़ाइल में आउटपुट आ जाते हैं, तो ये काम किए जा सकते हैं लॉग इकट्ठा करने और उन्हें क्लाउड पर भेजने के लिए, डीमन सेट अप करें.
इसकी एक सीमा यह भी है कि कुछ परफ़ॉर्मेंस मेट्रिक डिफ़ॉल्ट रूप से कैप्चर होता है. क्लाइंट लाइब्रेरी लॉग में, अनुरोध की जानकारी और रिस्पॉन्स ऑब्जेक्ट दिखाते हैं, इसलिए इंतज़ार के समय वाली मेट्रिक को तब तक शामिल नहीं किया जाएगा, जब तक दूसरे बदलाव न किए जाएं इन्हें भी लॉग करने के लिए बनाया गया है.
विकल्प 2: Compute Engine पर अपना ऐप्लिकेशन चलाएं और ऑपरेशन एजेंट इंस्टॉल करें
अगर आपका ऐप्लिकेशन Compute Engine पर चल रहा है, तो आप Google Cloud Logging में लॉग इन करता है. इसके लिए, Ops Agent इंस्टॉल करें. द ऑपरेशंस एजेंट को ऐप्लिकेशन के लॉग, क्लाउड पर भेजने के लिए कॉन्फ़िगर किया जा सकता है डिफ़ॉल्ट रूप से भेजे जाने वाले मेट्रिक और लॉग के अलावा, लॉग करने की सुविधा.
अगर आपका ऐप्लिकेशन पहले से ही Google Cloud के एनवायरमेंट में चल रहा है या आपके ऐप्लिकेशन को Google Cloud पर ले जाने के बारे में सोचा जा रहा है. ऐसे में, इन बातों पर ध्यान दें.
तीसरा विकल्प: अपने ऐप्लिकेशन कोड में लॉग इन करना लागू करें
ऐप्लिकेशन कोड से सीधे लॉग इन करने के लिए, इनमें से किसी एक तरीके का इस्तेमाल किया जा सकता है:
मेट्रिक गणना और लॉग स्टेटमेंट को हर अपने कोड में लागू स्थान. छोटे कारोबारों के लिए यह विकल्प ज़्यादा काम का है जहां इस तरह के बदलाव का दायरा और रखरखाव की लागतें होंगी मिनिमल.
लॉगिंग इंटरफ़ेस को लागू करना. अगर ऐप्लिकेशन लॉजिक को ऐब्स्ट्रैक्ट किया जा सकता है ताकि ऐप्लिकेशन के अलग-अलग हिस्से एक ही बेस से इनहेरिट करें क्लास के लिए, लॉगिंग लॉजिक को उस बेस क्लास में लागू किया जा सकता है. यह विकल्प है हमारा सुझाव है कि आप पूरे वीडियो में भी शामिल कर सकते हैं, क्योंकि इसका इस्तेमाल करना और बड़े पैमाने पर आकलन करना आसान होता है. बड़े साइज़ के लिए कोड बेस के साथ-साथ, इस सलूशन में रखरखाव और बड़े स्तर पर इस्तेमाल करने की क्षमता वे आपके लिए ज़्यादा काम के होंगे.
इसकी एक सीमा यह है कि अनुरोध और रिस्पॉन्स लॉग का पूरा डेटा, ऐप्लिकेशन कोड से उपलब्ध नहीं है. पूरा अनुरोध और रिस्पॉन्स ऑब्जेक्ट ये कर सकते हैं इसे gRPC इंटरसेप्टर से ऐक्सेस किया जाना चाहिए; बिल्ट-इन क्लाइंट लाइब्रेरी लॉगिंग अनुरोध और प्रतिक्रिया लॉग को प्राप्त करता है. कोई गड़बड़ी होने पर, अतिरिक्त अपवाद वाले ऑब्जेक्ट में जानकारी उपलब्ध हो सकती है, लेकिन कम जानकारी का इस्तेमाल, ऐप्लिकेशन लॉजिक के तहत किया जा सकता है. उदाहरण के लिए, ज़्यादातर मामलों में, सफल अनुरोध के लिए अनुरोध आईडी को Google Ads API रिस्पॉन्स ऑब्जेक्ट.
चौथा विकल्प: कस्टम gRPC लॉगिंग इंटरसेप्टर को लागू करना
gRPC, सिंगल और स्ट्रीमिंग इंटरसेप्टर के साथ काम करता है, जो अनुरोध और रिस्पॉन्स ऑब्जेक्ट, जो क्लाइंट और सर्वर के बीच से गुज़रते हैं. कॉन्टेंट बनाने Google Ads API की क्लाइंट लाइब्रेरी, बिल्ट-इन लॉगिंग की सुविधा देने के लिए gRPC इंटरसेप्टर का इस्तेमाल करती हैं सहायता. इसी तरह, Google Ads API (इंटरसेप्टर) की मदद से, अनुरोध और रिस्पॉन्स ऑब्जेक्ट, लॉगिंग और मॉनिटरिंग के लिए जानकारी निकालें और उस डेटा को अपनी पसंद की जगह पर लिखें.
यहां दिए गए कुछ अन्य समाधानों के उलट, कस्टम जीआरपीसी लागू करना इंटरसेप्टर की मदद से, आपको साथ ही, हर अनुरोध को शामिल करने की सुविधा मिलती है. साथ ही, अनुरोध की जानकारी को कैप्चर करने के लिए, अतिरिक्त लॉजिक लागू किया जाता है. उदाहरण के लिए, आप लागू करके किसी अनुरोध के बीते हुए समय की गणना कर सकते हैं कस्टम इंटरसेप्टर के अंदर ही परफ़ॉर्मेंस टाइमिंग लॉजिक, फिर मेट्रिक को Google Cloud Logging के लिए उपलब्ध कराया जाता है, ताकि इंतज़ार के समय की निगरानी करने के लिए इसे उपलब्ध कराया जा सके की समीक्षा की जा सकती है.
Python में, कस्टम Google क्लाउड लॉगिंग इंटरसेप्टर
यह समाधान दिखाने के लिए, हमने कस्टम लॉगिंग का एक उदाहरण लिखा है Python में इंटरसेप्टर. कस्टम इंटरसेप्टर बनाया जाता है और सेवा क्लाइंट. इसके बाद, यह अनुरोध और रिस्पॉन्स में पास होने वाले ऑब्जेक्ट को ऐक्सेस करता है हर सेवा के तरीके की मदद से कॉल करता है, उन ऑब्जेक्ट से डेटा प्रोसेस करता है, और Google Cloud Logging को डेटा भेजता है.
अनुरोध और रिस्पॉन्स ऑब्जेक्ट से मिलने वाले डेटा के अलावा, उदाहरण के लिए, बीते समय को कैप्चर करने के लिए, कुछ अतिरिक्त लॉजिक लागू किया गया है और कुछ अन्य मेटाडेटा जो निगरानी के कामों में मददगार हों, जैसे कि अनुरोध पूरा हुआ या नहीं. इस बारे में ज़्यादा जानकारी पाने के लिए कि जानकारी, आम तौर पर निगरानी के लिए और ख़ास तौर पर, Google Cloud Logging और Google Cloud Monitoring को मिलाकर, निगरानी करना गाइड देखें.
# 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