Logowanie

Logowanie i monitorowanie współdziałają ze sobą, ułatwiając analizowanie i optymalizowanie wydajności aplikacji, a także diagnozować błędy i problemy związane z systemem. Włącz logi podsumowania dla wszystkich wywołań interfejsu API i szczegółowe logi w przypadku nieudanych wywołań interfejsu API, aby móc dostarczać logi wywołań interfejsu API, gdy potrzebujesz pomocy technicznej.

Logowanie biblioteki klienta

Biblioteki klienta interfejsu Google Ads API mają wbudowane logowanie. Szczegółowe informacje o logowaniu na danej platformie znajdziesz w dokumentacji logowania w wybranej bibliotece klienta.

Język Przewodnik
Java Dokumentacja rejestrowania w języku Java
.NET Dokumentacja rejestrowania w języku .NET
PHP Dokumentacja rejestrowania w języku PHP
Python Dokumentacja rejestrowania w języku Python
Ruby Dokumentacja rejestrowania w języku Ruby
Perl Dokumentacja rejestrowania w języku Perl

Format logu

Biblioteki klienta interfejsu Google Ads API generują szczegółowy dziennik i dziennik podsumowania każdego wywołania interfejsu API. Dziennik ten zawiera wszystkie szczegóły wywołania interfejsu API, natomiast dziennik podsumowujący zawiera minimalną ilość informacji na temat wywołania API. Widoczny jest przykład każdego typu logów, w którym logi są obcięte i sformatowane tak, aby były bardziej czytelne.

Dziennik podsumowania

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.")

Szczegółowy wpis

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----------------

Co zrobić, jeśli nie korzystam z biblioteki klienta?

Jeśli nie używasz biblioteki klienta, zaimplementuj własne logowanie, aby rejestrować szczegóły wychodzących i przychodzących wywołań interfejsu API. Należy zarejestrować przynajmniej wartość nagłówka odpowiedzi request-id, który w razie potrzeby można udostępnić zespołom pomocy technicznej.

Logowanie do chmury

Istnieje wiele narzędzi, których możesz używać do przechwytywania logów i wskaźników wydajności aplikacji. Możesz na przykład użyć Google Cloud Logging, aby rejestrować dane o wydajności w projekcie Google Cloud. Dzięki temu można konfigurować panele i alerty w Google Cloud Monitoring, aby korzystać z zalogowanych wskaźników.

Cloud Logging udostępnia biblioteki klienta dla wszystkich obsługiwanych języków bibliotek klienta interfejsu Google Ads API z wyjątkiem Perl, więc w większości przypadków można logować się za pomocą Cloud Logging bezpośrednio z integracji z biblioteką klienta. W przypadku innych języków, w tym Perl, Cloud Logging udostępnia też interfejs API REST.

Istnieje kilka opcji logowania się do Cloud Logging lub innego narzędzia z biblioteki klienta interfejsu Google Ads API. Każda opcja ma własny czas potrzebny na wdrożenie, złożoność i wydajność. Dobrze się zastanów nad tymi kompromisami, zanim wybierzesz rozwiązanie, które warto wdrożyć.

Opcja 1. Zapisywanie logów lokalnych w chmurze z procesu w tle

Logi biblioteki klienta można zapisywać w pliku lokalnym na komputerze, modyfikując konfigurację logowania. Gdy logi trafią do pliku lokalnego, możesz skonfigurować demona, który będzie je zbierał i wysyłał do chmury.

Ograniczeniem tej metody jest to, że niektóre wskaźniki wydajności nie będą domyślnie rejestrowane. Logi biblioteki klienta zawierają szczegóły obiektów żądań i odpowiedzi, więc wskaźniki czasu oczekiwania nie będą uwzględniane, jeśli nie zostaną wprowadzone dodatkowe zmiany w celu ich rejestrowania.

Opcja 2. Uruchom aplikację w Compute Engine i zainstaluj agenta operacyjnego

Jeśli Twoja aplikacja działa w Compute Engine, możesz wysyłać logi do Google Cloud Logging, instalując agenta operacyjnego. Agenta operacyjnego można skonfigurować tak, aby oprócz danych i logów wysyłanych domyślnie wysyłał do Cloud Logging logi aplikacji.

Jeśli Twoja aplikacja działa już w środowisku Google Cloud lub rozważasz przeniesienie aplikacji do Google Cloud, jest to doskonała opcja.

Opcja 3. Zaimplementuj logowanie w kodzie aplikacji

Logowanie bezpośrednio z kodu aplikacji można wykonać na jeden z dwóch sposobów:

  1. Uwzględnianie w kodzie obliczeń wskaźników i instrukcji logu w każdej odpowiedniej lokalizacji. Ta opcja jest bardziej realna w przypadku mniejszych baz kodu, gdzie zakres i koszty utrzymania takiej zmiany byłyby minimalne.

  2. Wdrożenie interfejsu logowania. Jeśli logikę aplikacji można wyodrębnić tak, aby różne fragmenty aplikacji odziedziczyły tę samą klasę podstawową, można zaimplementować w niej logiczną logikę. Ta opcja jest ogólnie preferowana zamiast instrukcji logu w całym kodzie aplikacji, ponieważ jest łatwiejsza w obsłudze i skalowaniu. W przypadku większych baz kodu tym bardziej istotne są możliwość konserwacji i skalowalność tego rozwiązania.

Jednym z ograniczeń tego podejścia jest to, że pełne logi żądań i odpowiedzi nie są dostępne w kodzie aplikacji. Dostęp do pełnych obiektów żądań i odpowiedzi można uzyskać z modułów przechwytujących gRPC. W ten sposób wbudowane funkcje rejestrowania biblioteki klienta otrzymują logi żądań i odpowiedzi. W przypadku błędu w obiekcie wyjątku mogą być dostępne dodatkowe informacje, ale w przypadku udanych odpowiedzi w logice aplikacji może być dostępnych mniej szczegółów. Na przykład w większości przypadków identyfikator udanego żądania jest niedostępny z obiektów odpowiedzi interfejsu Google Ads API.

Opcja 4. Zaimplementuj niestandardowy moduł przechwytywania logowania gRPC

gRPC obsługuje jednoargumentowe i strumieniowe przechwytujące, które mają dostęp do obiektów żądań i odpowiedzi w trakcie ich przesyłania między klientem a serwerem. Biblioteki klienta interfejsu Google Ads API korzystają z modułów przechwytujących gRPC, aby zapewniać wbudowaną obsługę logowania. Podobnie możesz wdrożyć niestandardowy moduł do przechwytywania gRPC, aby uzyskać dostęp do obiektów żądań i odpowiedzi, wyodrębnić informacje na potrzeby logowania i monitorowania oraz zapisać te dane w wybranej lokalizacji.

W odróżnieniu od innych przedstawionych tu rozwiązań wdrożenie niestandardowego przechwytywania gRPC daje elastyczność, która pozwala na przechwytywanie obiektów żądań i odpowiedzi w przypadku każdego żądania oraz zaimplementowanie dodatkowych funkcji logicznych, które pozwalają przechwytywać szczegóły żądania. Możesz na przykład obliczyć czas, jaki upłynął od żądania, implementując logikę czasu wydajności w samym niestandardowym module przechwytywania, a następnie rejestrować dane w Google Cloud Logging, aby udostępnić je do monitorowania czasu oczekiwania w Google Cloud Monitoring.

Niestandardowy obiekt przechwytujący Google Cloud Logging w Pythonie

Aby zademonstrować to rozwiązanie, przygotowaliśmy przykład niestandardowego modułu przechwytywania logów w Pythonie. Niestandardowy obiekt przechwytujący zostanie utworzony i przekazany do klienta usługi. Następnie uzyskuje dostęp do obiektów żądań i odpowiedzi, które przekazują przy każdym wywołaniu metody usługi, przetwarzają dane z tych obiektów i wysyłają je do Google Cloud Logging.

Oprócz danych pochodzących z obiektów żądań i odpowiedzi w tym przykładzie implementowano dodatkowe funkcje logiczne rejestrujące czas, który upłynął od żądania, oraz inne metadane, które mogą być przydatne do monitorowania, np. czy żądanie zostało zrealizowane. Więcej informacji o przydatności tych informacji (ogólnie na potrzeby monitorowania, a szczególnie podczas łączenia usług Google Cloud Logging i Google Cloud Monitoring) znajdziesz w przewodniku dotyczącym monitorowania.

# 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