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