רישום

רישום ביומן ומעקב אחרי העבודה ביחד כדי לעזור לכם להבין ולבצע אופטימיזציה ביצועי אפליקציות, וכן לאבחן שגיאות ושגיאות שקשורות למערכת בעיות נפוצות. מומלץ להפעיל יומני סיכום לכל הקריאות ל-API וגם יומנים מפורטים לקריאות ל-API שנכשלו, כדי שתוכלו לספק את ה-API. יומני שיחות כשיש צורך בתמיכה טכנית.

רישום ביומן של ספריית לקוח

ספריות הלקוח של Google Ads API כוללות רישום מובנה ביומן. לאפליקציות ספציפיות לפלטפורמה פרטי הרישום ביומן, כדאי לעיין במסמכי התיעוד שבספריית הלקוח של בחירה.

שפה הדרכות
Java רישום מסמכי רישום ב-Java
‎.NET מסמכי רישום ביומן של .NET
PHP רישום מסמכי רישום ל-PHP
Python מסמכי רישום ביומן ל-Python
Ruby מסמכי רישום ביומן של Ruby
Perl מסמכי רישום ביומן של Perl

פורמט היומן

ספריות הלקוח של Google Ads API יוצרות יומן מפורט וסיכום יומן לכל קריאה ל-API. היומן המפורט מכיל את כל הפרטים של הקריאה ל-API, ואילו יומן הסיכום מכיל פרטים מינימליים לגבי הקריאה ל-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----------------

מה קורה אם לא משתמשים בספריית לקוח?

אם אתם לא משתמשים בספריית לקוח, תצטרכו להטמיע רישום ביומן משלכם כדי לתעד את פרטים על קריאות ה-API היוצאות והנכנסות. עליך לרשום ביומן לפחות את של כותרת התגובה request-id, שאותו ניתן לשתף לאחר מכן עם לצוותי תמיכה טכנית לפי הצורך.

התחברות לענן

יש הרבה כלים שבהם אפשר להשתמש כדי לתעד יומנים ומדדי ביצועים את האפליקציה שלך. לדוגמה, אפשר להשתמש ב-Google Cloud Logging כדי להיכנס של מדדי הביצועים בפרויקט שלכם ב-Google Cloud. ככה שאפשר להגדיר לוחות בקרה והתראות ב-Google Cloud Monitoring כדי להשתמש במדדים הרשומים.

ב-Cloud Logging יש ספריות לקוח לכל הלקוחות הנתמכים של Google Ads API. בשפות שונות של Perl, כך שברוב המקרים אפשר להתחבר Cloud Logging ישירות מהשילוב של ספריית הלקוח. בשפות אחרות כולל Perl, ו-Cloud Logging כולל גם API ל-REST.

יש מספר אפשרויות לרישום ביומן ב-Cloud Logging, או בכלי אחר, ספריית הלקוח של Google Ads API. לכל אפשרות יש השפעה שונה של זמן להטמיע, מורכבות ולביצועים טובים. חשבו היטב על החסרונות האלה לפני שתחליטו איזה פתרון להטמיע.

אפשרות 1: כתיבת יומנים מקומיים לענן מתהליך ברקע

אפשר לכתוב יומנים של ספריית לקוח לקובץ מקומי במחשב על ידי שינוי הגדרות הרישום ביומן. אחרי שהפלט של היומנים לקובץ מקומי, אתם יכולים לבצע את הפעולות הבאות: להגדיר דימון (daemon) כדי לאסוף את היומנים ולשלוח אותם לענן.

מגבלה אחת של גישה זו היא שלא מתועדים כברירת מחדל. היומנים של ספריית הלקוח כוללים פרטים מהבקשה אובייקטים של תגובות, כך שמדדי זמן האחזור לא ייכללו אלא אם יהיו שינויים נוספים. עשויים לרשום גם אותם.

אפשרות 2: מריצים את האפליקציה ב-Compute Engine ומתקינים את סוכן התפעול

אם האפליקציה שלכם פועלת על Compute Engine, תוכלו לשלוח את יומנים ב-Google Cloud Logging על ידי התקנת סוכן התפעול. תפעול אפשר להגדיר את הסוכן כך שישלח את יומני האפליקציות לענן רישום ביומן, בנוסף למדדים וליומנים שנשלחים כברירת מחדל.

אם האפליקציה כבר פועלת בסביבת Google Cloud, או שוקלים להעביר את האפליקציה שלך ל-Google Cloud, זו אפשרות מצוינת שכדאי להביא בחשבון.

אפשרות 3: הטמעת רישום ביומן של קוד האפליקציה

ניתן להתחבר ישירות מקוד האפליקציה באחת משתי דרכים:

  1. לשלב חישובי מדדים והצהרות ביומן את המיקום הרלוונטי בקוד שלך. האפשרות הזו מתאימה יותר למכשירים קטנים יותר שבהם היקף ועלויות התחזוקה של שינוי כזה יהיו מינימלי.

  2. הטמעת ממשק רישום ביומן. אם אפשר להפשט את הלוגיקה של האפליקציה כך שחלקים שונים באפליקציה יורשים מאותו בסיס ניתן להטמיע לוגיקת רישום ביומן במחלקה הבסיסית. האפשרות הזאת היא עדיפות בדרך כלל על פני שילוב הצהרות יומן כי קל יותר לתחזק אותו ולהתאים אותו לעומס. גדולות יותר מאחר שהפתרון הזה מציע יכולת תחזוקה ומדרגיות, יותר רלוונטיות.

מגבלה אחת של גישה זו היא שהרישומים המלאים של הבקשות והתשובות לא זמינים מקוד האפליקציה. אובייקטים מלאים של בקשה ותשובה יכולים לגשת אליו ממיירטים של gRPC. כך ספריית הלקוח המובנית הרישום ביומן מקבל יומנים של בקשות ותגובות. במקרה של שגיאה, האפשרויות הנוספות עשוי להיות מידע זמין באובייקט החריג, אבל יש פחות פרטים יהיו זמינות לתגובות מוצלחות בלוגיקת האפליקציה. לדוגמה, ב- ברוב המקרים, מזהה הבקשה של בקשה שבוצע בהצלחה לא זמין דרך אובייקטים של תגובות ב-Google Ads API.

אפשרות 4: הטמעה של כלי ליירוט רישום ביומן של gRPC בהתאמה אישית

ב-gRPC יש תמיכה במיירטים של unary ושל סטרימינג שיכולים לגשת אובייקטים של בקשות ותגובה כשהם עוברים בין הלקוח לשרת. ספריות הלקוח של Google Ads API משתמשות במיירטים של gRPC כדי להציע רישום מובנה ביומן תמיכה. באופן דומה, אפשר להטמיע מיירט gRPC בהתאמה אישית כדי לגשת של אובייקטים של בקשות ותגובה, חילוץ מידע לרישום ביומן ומעקב ולכתוב את הנתונים האלה למיקום שבחרתם.

בניגוד לחלק מהפתרונות האחרים שמוצגים כאן, הטמעת gRPC בהתאמה אישית מכשיר המיירוט נותן לך גמישות לתעד את האובייקטים של הבקשות והתשובות כל בקשה, וליישם לוגיקה נוספת כדי לתעד את פרטי הבקשה. לדוגמה, אפשר לחשב את הזמן שחלף לבקשה באמצעות הטמעה את הלוגיקה של תזמון הביצועים בתוך המיירט המותאם אישית עצמו, ולאחר מכן רושמים את ל-Google Cloud Logging כדי להפוך אותו לזמין למעקב אחר זמן אחזור במסגרת Google Cloud Monitoring.

כלי יירוט מותאם אישית של Google Cloud Logging ב-Python

כדי להדגים את הפתרון הזה, כתבנו דוגמה לרישום מותאם אישית ביומן ב-Python. המיירט בהתאמה אישית נוצר ומועבר אל לקוח שירות. לאחר מכן הוא ניגש לאובייקטים של הבקשה והתשובה שמעבירים בכל קריאה ל-method של השירות, יעבד נתונים מהאובייקטים האלה שולח את הנתונים ל-Google Cloud Logging.

נוסף לנתונים שמגיעים מהאובייקטים של הבקשות והתשובות, מיישמת כמה לוגיקה נוספת כדי לתעד את הזמן שחלף ומטא-נתונים נוספים שיכולים להיות שימושיים למטרות מעקב, למשל אם הבקשה הצליחה או לא. לקבלת מידע נוסף על האופן שבו של מידע יכול להיות שימושי, הן בדרך כלל לצורך מעקב ובמיוחד כאשר השילוב של Google Cloud Logging ו-Google Cloud Monitoring, אפשר לעיין במאמר Monitoring guide.

# 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