Protokollierung und Monitoring arbeiten zusammen, um Ihnen zu helfen, die Anwendungsleistung zu verstehen und zu optimieren sowie Fehler und systembezogene Probleme zu diagnostizieren. Sie sollten Zusammenfassungsprotokolle für alle API-Aufrufe und detaillierte Protokolle für fehlgeschlagene API-Aufrufe aktivieren, damit Sie die API-Aufrufprotokolle bereitstellen können, wenn Sie technischen Support benötigen.
Logging in Clientbibliotheken
Die Google Ads API-Clientbibliotheken enthalten eine integrierte Protokollierung. Plattformspezifische Protokollierungsdetails finden Sie in der Protokollierungsdokumentation Ihrer Clientbibliothek.
| Sprache | Leitfaden |
|---|---|
| Java | Logging-Dokumentation für Java |
| .NET | Logging-Dokumentation für .NET |
| PHP | Logging-Dokumentation für PHP |
| Python | Logging-Dokumentation für Python |
| Ruby | Logging-Dokumentation für Ruby |
| Perl | Dokumentation zum Logging für Perl |
Logformat
Die Google Ads API-Clientbibliotheken generieren für jeden API-Aufruf ein detailliertes Log und ein Zusammenfassungslog. Das detaillierte Log enthält alle Details des API-Aufrufs, während das Zusammenfassungslog nur die wichtigsten Details des API-Aufrufs enthält. Es wird ein Beispiel für jeden Logtyp gezeigt. Die Logs sind zur besseren Lesbarkeit gekürzt und formatiert.
Zusammenfassendes Log
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.")
Detailliertes Log
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----------------
Was passiert, wenn ich keine Clientbibliothek verwende?
Wenn Sie keine Clientbibliothek verwenden, implementieren Sie eine eigene Protokollierung, um die Details der ausgehenden und eingehenden API-Aufrufe zu erfassen. Sie sollten mindestens den Wert des request-id-Antwortheaders protokollieren, der bei Bedarf an die Teams für den technischen Support weitergegeben werden kann.
Protokollierung in der Cloud
Es gibt viele Tools, mit denen Sie Logs und Leistungsmesswerte für Ihre Anwendung erfassen können. Mit Google Cloud Logging können Sie beispielsweise Leistungsmesswerte in Ihrem Google Cloud-Projekt protokollieren. So können Sie Dashboards und Benachrichtigungen in Google Cloud Monitoring einrichten, um die protokollierten Messwerte zu nutzen.
Cloud Logging bietet Clientbibliotheken für alle unterstützten Google Ads API-Clientbibliotheken mit Ausnahme von Perl. In den meisten Fällen ist es also möglich, direkt über Ihre Clientbibliotheksintegration Logs mit Cloud Logging zu erstellen. Für andere Sprachen, einschließlich Perl, bietet Cloud Logging auch eine REST API.
Es gibt mehrere Möglichkeiten, Logeinträge aus einer Google Ads API-Clientbibliothek in Cloud Logging oder einem anderen Tool zu erfassen. Jede Option hat ihre eigenen Kompromisse in Bezug auf Implementierungszeit, Komplexität und Leistung. Überlegen Sie sich diese Kompromisse genau, bevor Sie sich für eine Lösung entscheiden.
Option 1: Lokale Logs über einen Hintergrundprozess in die Cloud schreiben
Clientbibliothekslogs können in eine lokale Datei auf Ihrem Computer geschrieben werden, indem Sie die Protokollierungskonfiguration ändern. Sobald die Logs in eine lokale Datei ausgegeben wurden, können Sie einen Daemon einrichten, um die Logs zu erfassen und an die Cloud zu senden.
Eine Einschränkung dieses Ansatzes besteht darin, dass einige Leistungsmesswerte nicht standardmäßig erfasst werden. Clientbibliothekslogs enthalten Details aus den Anfrage- und Antwortobjekten. Latenzmesswerte sind also nicht enthalten, sofern keine zusätzlichen Änderungen vorgenommen werden, um diese ebenfalls zu protokollieren.
Option 2: Anwendung in Compute Engine ausführen und Ops-Agent installieren
Wenn Ihre Anwendung in der Compute Engine ausgeführt wird, können Sie Ihre Logs an Google Cloud Logging senden, indem Sie den Ops-Agent installieren. Der Ops-Agent kann so konfiguriert werden, dass Ihre Anwendungsprotokolle zusätzlich zu den standardmäßig gesendeten Messwerten und Protokollen an Cloud Logging gesendet werden.
Wenn Ihre Anwendung bereits in einer Google Cloud-Umgebung ausgeführt wird oder Sie erwägen, Ihre Anwendung zu Google Cloud zu migrieren, ist dies eine gute Option.
Option 3: Protokollierung in Ihrem Anwendungscode implementieren
Das direkte Logging aus dem Anwendungscode kann auf zwei Arten erfolgen:
Messwertberechnungen und Log-Anweisungen an allen relevanten Stellen in Ihrem Code einfügen. Diese Option ist eher für kleinere Codebases geeignet, bei denen der Umfang und die Wartungskosten einer solchen Änderung minimal wären.
Implementieren einer Logging-Schnittstelle Wenn die Anwendungslogik so abstrahiert werden kann, dass verschiedene Teile der Anwendung von derselben Basisklasse erben, kann die Protokollierungslogik in dieser Basisklasse implementiert werden. Diese Option wird im Allgemeinen der Einbindung von Log-Anweisungen im gesamten Anwendungscode vorgezogen, da sie einfacher zu warten und zu skalieren ist. Bei größeren Codebases sind die Wartungsfreundlichkeit und Skalierbarkeit dieser Lösung umso wichtiger.
Eine Einschränkung dieses Ansatzes besteht darin, dass die vollständigen Anfrage- und Antwortprotokolle nicht über den Anwendungscode verfügbar sind. Auf vollständige Anfrage- und Antwortobjekte kann über gRPC-Interceptors zugegriffen werden. So werden Anfrage- und Antwortlogs in der integrierten Clientbibliothek protokolliert. Im Fehlerfall sind möglicherweise zusätzliche Informationen im Ausnahmeobjekt verfügbar. Bei erfolgreichen Antworten sind in der Anwendungslogik jedoch weniger Details verfügbar. In den meisten Fällen ist die Anfrage-ID für eine erfolgreiche Anfrage beispielsweise nicht über die Google Ads API-Antwortobjekte zugänglich.
Option 4: Benutzerdefinierten gRPC-Logging-Interceptor implementieren
gRPC unterstützt unäre und Streaming-Interceptors, die auf die Anfrage- und Antwortobjekte zugreifen können, wenn sie zwischen dem Client und dem Server übertragen werden. Die Google Ads API-Clientbibliotheken verwenden gRPC-Interceptors, um integrierte Unterstützung für die Protokollierung zu bieten. Ebenso können Sie einen benutzerdefinierten gRPC-Interceptor implementieren, um auf die Anfrage- und Antwortobjekte zuzugreifen, Informationen für Logging- und Monitoringzwecke zu extrahieren und diese Daten an den gewünschten Ort zu schreiben.
Im Gegensatz zu einigen der anderen hier vorgestellten Lösungen haben Sie bei der Implementierung eines benutzerdefinierten gRPC-Interceptors die Flexibilität, Anfrage- und Antwortobjekte für jede Anfrage zu erfassen und zusätzliche Logik zu implementieren, um Details der Anfrage zu erfassen. Sie können beispielsweise die verstrichene Zeit einer Anfrage berechnen, indem Sie die Logik für die Leistungsmessung im benutzerdefinierten Interceptor implementieren und den Messwert dann in Google Cloud Logging protokollieren, damit er für die Latenzüberwachung in Google Cloud Monitoring verfügbar ist.
Benutzerdefinierter Google Cloud Logging-Interceptor in Python
Um diese Lösung zu demonstrieren, haben wir ein Beispiel für einen benutzerdefinierten Logging-Interceptor in Python geschrieben. Der benutzerdefinierte Interceptor wird erstellt und an den Dienstclient übergeben. Anschließend greift es auf die Anfrage- und Antwortobjekte zu, die bei jedem Dienstmethodenaufruf durchlaufen werden, verarbeitet Daten aus diesen Objekten und sendet die Daten an Google Cloud Logging.
Zusätzlich zu den Daten, die aus den Anfrage- und Antwortobjekten stammen, wird im Beispiel eine zusätzliche Logik implementiert, um die verstrichene Zeit der Anfrage und einige andere Metadaten zu erfassen, die für Überwachungszwecke nützlich wären, z. B. ob die Anfrage erfolgreich war. Weitere Informationen dazu, wie diese Informationen sowohl allgemein für das Monitoring als auch speziell bei der Kombination von Google Cloud Logging und Google Cloud Monitoring nützlich sein können, finden Sie im Monitoring-Leitfaden.
# 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 typing import Any, Callable, Dict, Optional, Tuple from google.cloud import logging as google_cloud_logging from grpc import ( Call, Future, UnaryUnaryClientInterceptor, UnaryStreamClientInterceptor, ) from grpc._interceptor import _ClientCallDetails 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: str): """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: google_cloud_logging.Client = google_cloud_logging.Client() self.logger: google_cloud_logging.Logger = logging_client.logger("cloud_logging") self.rpc_start: float self.rpc_end: float def log_successful_request( self, method: str, customer_id: Optional[str], metadata_json: str, request_id: str, request: Any, # google.ads.googleads.vX.services.types.SearchGoogleAdsRequest or SearchGoogleAdsStreamRequest trailing_metadata_json: str, response: Any, # grpc.Call or grpc.Future ) -> None: """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: Any = 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: float = (self.rpc_end - self.rpc_start) * 1000 debug_log: Dict[str, Any] = { "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: Dict[str, Any] = { "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: str, customer_id: Optional[str], metadata_json: str, request_id: str, request: Any, # google.ads.googleads.vX.services.types.SearchGoogleAdsRequest or SearchGoogleAdsStreamRequest trailing_metadata_json: str, response: Any, # grpc.Call or grpc.Future ) -> None: """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: Any = self._get_error_from_response(response) exception_str: str = self._parse_exception_to_str(exception) fault_message: str = self._get_fault_message(exception) info_log: Dict[str, Any] = { "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: Dict[str, Any] = { "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: Callable[[_ClientCallDetails, Any], Any], # Any is request type client_call_details: _ClientCallDetails, request: Any, # google.ads.googleads.vX.services.types.SearchGoogleAdsRequest ) -> Any: # grpc.Call or grpc.Future """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: Any) -> None: # response_future is grpc.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: Any = continuation(client_call_details, request) # response is grpc.Call or grpc.Future 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: Callable[[_ClientCallDetails, Any], Any], # Any is request type client_call_details: _ClientCallDetails, request: Any, # google.ads.googleads.vX.services.types.SearchGoogleAdsStreamRequest ) -> Any: # grpc.Call or grpc.Future """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: Any) -> None: # response_future is grpc.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: Any = continuation(client_call_details, request) # response is grpc.Call or grpc.Future # 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