عمل التسجيل والمراقبة جنبًا إلى جنب لمساعدتك على فهم وتحسين أداء التطبيقات، بالإضافة إلى تشخيص الأخطاء والعمليات المشكلات. عليك تفعيل سجلّات الملخّص لجميع طلبات البيانات من واجهة برمجة التطبيقات السجلات التفصيلية لطلبات البيانات من واجهة برمجة التطبيقات التي تعذّر تنفيذها لتتمكّن من إضافة واجهة برمجة التطبيقات سجلات المكالمات عند الحاجة إلى الدعم الفني
تسجيل مكتبة العملاء
تأتي مكتبات عملاء Google Ads API مزوّدةً بتسجيل مدمج. للمحتوى الخاص بالنظام الأساسي تفاصيل التسجيل، فراجع وثائق التسجيل الموجودة في مكتبة العملاء الخاصة بك خِيَار.
| Language | الدليل |
|---|---|
| Java | مستندات التسجيل للغة Java |
| NET. | مستندات التسجيل في .NET |
| PHP | مستندات التسجيل للغة PHP |
| Python | مستندات التسجيل في Python |
| Ruby | مستندات التسجيل للغة Ruby |
| Perl | مستندات التسجيل بلغة Perl |
تنسيق السجلّ
تُنشئ مكتبات عملاء 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 مكتبات للعملاء لجميع برامج Google Ads API المتوافقة من لغات المكتبة باستثناء Perl، لذا يمكن في معظم الحالات تسجيل تسجيل الدخول في السحابة الإلكترونية مباشرةً من دمج مكتبة العملاء للّغات الأخرى بما في ذلك Perl، توفّر Cloud Logging أيضًا REST API.
هناك بعض الخيارات لتسجيل الدخول إلى Cloud Logging، أو أداة أخرى، من مكتبة برامج Google Ads API يأتي كل خيار مع مفاضلات الوقت الخاصة به والتنفيذ والتعقيد والأداء. فكّر مليًا في هذه المفاضلات قبل تحديد الحل الذي يجب تنفيذه.
الخيار 1: كتابة السجلّات المحلية على السحابة الإلكترونية من عملية في الخلفية
يمكن كتابة سجلات مكتبة البرامج إلى ملف محلي على جهازك عن طريق تعديل إعدادات التسجيل. بعد إخراج السجلات إلى ملف على الجهاز، يمكنك إعداد برنامج خفي لجمع السجلات وإرسالها إلى السحابة.
يتمثل أحد قيود هذا المنهج في أن بعض مقاييس الأداء لن تكون تسجيله بشكل افتراضي. تتضمن سجلات مكتبة العملاء تفاصيل من الطلب كائنات الاستجابة، لذا لن يتم تضمين مقاييس وقت الاستجابة ما لم يتم إجراء تغييرات إضافية لتسجيل هذه أيضًا.
الخيار 2: تشغيل تطبيقك على Compute Engine وتثبيت وكيل العمليات
إذا كان تطبيقك يعمل على Compute Engine، يمكنك إرسال ملف إلى Google Cloud Logging من خلال تثبيت وكيل العمليات العمليات يمكن إعداد الوكيل لإرسال سجلات التطبيقات إلى السحابة الإلكترونية التسجيل، بالإضافة إلى المقاييس والسجلات التي يتم إرسالها بشكل تلقائي
إذا كان تطبيقك قيد التشغيل بالفعل في بيئة Google Cloud، أو إذا كان تفكر في نقل تطبيقك إلى Google Cloud، فهذا خيار رائع التي يجب مراعاتها.
الخيار 3: تنفيذ عملية تسجيل الدخول لرمز تطبيقك
يمكن تسجيل الدخول مباشرةً من رمز التطبيق بإحدى الطريقتين التاليتين:
دمج حسابات المقاييس وعبارات السجل في كل موضع مناسب في التعليمات البرمجية. هذا الخيار أكثر ملاءمة للمنصات الأصغر وقواعد الأكواد، حيث يكون النطاق وتكاليف الصيانة لمثل هذا التغيير الحد الأدنى.
تنفيذ واجهة تسجيل. فإذا كان من الممكن استخلاص منطق التطبيق بحيث تكتسب الأجزاء المختلفة من التطبيق من القاعدة نفسها الفئة، يمكن تطبيق منطق التسجيل في تلك الفئة الأساسية. هذا الخيار يفضلون بشكل عام على دمج بيانات السجل خلال رمز التطبيق، حيث يسهل صيانته وتوسيع نطاقه. للأحجام الأكبر لقواعد التعليمات البرمجية، فإن قابلية هذا الحل وقابلية صيانته كلها أكثر صلة.
يتمثل أحد قيود هذا الأسلوب في أن سجلات الطلب والاستجابة الكاملة غير متاح من رمز التطبيق. يمكن لكائنات الطلب والاستجابة الكاملة أن يتم الوصول إليها من منصات اعتراض gRPC فهذه هي الطريقة التي تعتمد بها مكتبة العملاء ينتج عن التسجيل سجلات الطلبات والاستجابة. في حالة حدوث خطأ، يتم تضمين قد تكون المعلومات متاحة في كائن الاستثناء، ولكن يتم توفير تفاصيل أقل المتاحة للردود الناجحة ضمن منطق التطبيق. على سبيل المثال، في في معظم الحالات، لا يمكن الوصول إلى معرف الطلب لأحد الطلبات الناجح من عناصر الاستجابة في Google Ads API
الخيار 4: تنفيذ اعتراض تسجيل gRPC مخصّص
تدعم gRPC عناصر الاعتراض الأحادية والبث التي يمكنها الوصول إلى كائنات الطلب والاستجابة أثناء مرورها بين العميل والخادم. تشير رسالة الأشكال البيانية تستخدم مكتبات عملاء Google Ads API أدوات اعتراض gRPC لتوفير التسجيل المضمّن والدعم. وبالمثل، يمكنك تنفيذ اعتراض gRPC مخصص للوصول إلى عناصر الطلب والاستجابة، واستخراج المعلومات للتسجيل والمراقبة وكتابة تلك البيانات في الموقع الذي تختاره.
على عكس بعض الحلول الأخرى المقدمة هنا، فإن تنفيذ gRPC مخصص جهاز الاعتراض الذي يوفر لك المرونة اللازمة لالتقاط كائنات الطلب والاستجابة كل طلب، وتنفيذ منطق إضافي لتسجيل تفاصيل الطلب. على سبيل المثال، يمكنك حساب الوقت المنقضي لطلب ما من خلال تنفيذ ومنطق توقيت الأداء داخل المعترض المخصص نفسه، ثم تسجيل إلى "تسجيل الدخول في Google Cloud" لإتاحته لمراقبة وقت الاستجابة في مراقبة السحابة الإلكترونية من Google.
اعتراض تسجيل الدخول المخصّص في Google Cloud في Python
لتوضيح هذا الحل، كتبنا مثالاً للتسجيل المخصص عنصر اعتراض في بايثون. يتم إنشاء جهاز الاعتراض المخصص وتمريره إلى البرنامج. ثم تصل إلى كائنات الطلب والاستجابة التي تمر في كل استدعاء طريقة خدمة، ومعالجة البيانات من تلك الكائنات، إرسال البيانات إلى Google Cloud Logging.
بالإضافة إلى البيانات التي تأتي من كائنَي الطلب والاستجابة، بعض المنطق الإضافي لتسجيل الوقت المنقضي طلبك، وبعض البيانات الوصفية الأخرى التي قد تكون مفيدة لأغراض المراقبة، مثل ما إذا كان الطلب ناجحًا أم لا. لمزيد من المعلومات حول كيفية يمكن أن تكون المعلومات مفيدة، سواء بشكل عام، للمراقبة، أو عند للجمع بين تسجيل الدخول في السحابة الإلكترونية من Google ومراقبة السحابة الإلكترونية، راجع صفحة الدليل.
# 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