Logging und Monitoring ergänzen sich gegenseitig und helfen Ihnen, die Anwendungsleistung zu verstehen und zu optimieren sowie Fehler und systembezogene Probleme zu diagnostizieren. Sie sollten Zusammenfassungsprotokolle für alle API-Aufrufe und Detailprotokolle für fehlgeschlagene API-Aufrufe aktivieren, damit Sie die API-Aufrufprotokolle bei Bedarf dem technischen Support zur Verfügung stellen können.
Logging der Clientbibliothek
Die Google Ads API-Clientbibliotheken bieten integrierte Protokollierung. Plattformspezifische Informationen zum Logging finden Sie in der Logging-Dokumentation Ihrer Clientbibliothek.
| Sprache | Leitfaden |
|---|---|
| Java | Logging-Dokumente für Java |
| .NET | Logging-Dokumente für .NET |
| PHP | Dokumentation zum Logging für PHP |
| Python | Dokumentation zum Logging für Python |
| Ruby | Dokumentation zum Logging für Ruby |
| Perl | Dokumentation zum Logging für Perl |
Logformat
Die Clientbibliotheken der Google Ads API generieren für jeden API-Aufruf ein Detailprotokoll und ein Zusammenfassungsprotokoll. Das detaillierte Protokoll enthält alle Details des API-Aufrufs, während das Zusammenfassungsprotokoll nur wenige Details zum API-Aufruf enthält. Für jeden Protokolltyp wird ein Beispiel angezeigt, wobei die Protokolle zur besseren Lesbarkeit abgeschnitten und formatiert sind.
Zusammenfassungsprotokoll
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 Protokoll
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 ist, wenn ich keine Clientbibliothek verwende?
Wenn Sie keine Clientbibliothek verwenden, implementieren Sie Ihre eigene Protokollierung, um die Details der ausgehenden und eingehenden API-Aufrufe zu erfassen. Sie sollten mindestens den Wert des request-id-Antwort-Headers protokollieren, der dann bei Bedarf an die technischen Supportteams weitergegeben werden kann.
Protokollierung in der Cloud
Es gibt viele Tools, mit denen Sie Protokolle und Leistungsmesswerte für Ihre Anwendung erfassen können. Sie können beispielsweise Google Cloud Logging verwenden, um Leistungsmesswerte in Ihrem Google Cloud-Projekt zu erfassen. So können Sie in Google Cloud Monitoring Dashboards und Benachrichtigungen einrichten, um die erfassten Messwerte zu nutzen.
Cloud Logging bietet Clientbibliotheken für alle unterstützten Google Ads API-Clientbibliothekensprachen mit Ausnahme von Perl. In den meisten Fällen ist es also möglich, direkt über die Clientbibliotheksintegration Protokolle mit Cloud Logging zu erstellen. Für andere Sprachen, einschließlich Perl, bietet Cloud Logging auch eine REST API.
Es gibt mehrere Möglichkeiten, Protokolle aus einer Google Ads API-Clientbibliothek in Cloud Logging oder einem anderen Tool zu erfassen. Jede Option hat Vor- und Nachteile in Bezug auf Implementierungszeit, Komplexität und Leistung. Überlegen Sie sich diese Vor- und Nachteile gut, bevor Sie sich für eine Lösung entscheiden.
Option 1: Lokale Protokolle über einen Hintergrundprozess in die Cloud schreiben
Sie können die Protokolle der Clientbibliothek in eine lokale Datei auf Ihrem Computer schreiben, indem Sie die Protokollierungskonfiguration ändern. Sobald die Protokolle in eine lokale Datei ausgegeben wurden, können Sie einen Daemon einrichten, der die Protokolle erfasst und an die Cloud sendet.
Eine Einschränkung dieses Ansatzes besteht darin, dass einige Leistungsmesswerte standardmäßig nicht erfasst werden. Clientbibliotheksprotokolle enthalten Details aus den Anfrage- und Antwortobjekten. Latenzmesswerte werden daher nur erfasst, wenn zusätzliche Änderungen vorgenommen werden, um auch diese zu protokollieren.
Option 2: Anwendung in der Compute Engine ausführen und den Ops-Agent installieren
Wenn Ihre Anwendung in der Compute Engine ausgeführt wird, können Sie Ihre Protokolle 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 Ihre Anwendung zu Google Cloud migrieren möchten, ist dies eine gute Option.
Option 3: Logging im Anwendungscode implementieren
Es gibt zwei Möglichkeiten, Protokolle direkt aus dem Anwendungscode zu erfassen:
Messwertberechnungen und Protokollanweisungen an allen relevanten Stellen in Ihren Code einfügen Diese Option ist für kleinere Codebases geeignet, bei denen der Umfang und die Wartungskosten einer solchen Änderung minimal sind.
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 gegenüber der Einbindung von Protokollanweisungen in den gesamten Anwendungscode bevorzugt, da sie einfacher zu pflegen und zu skalieren ist. Bei größeren Codebases sind die Wartbarkeit und Skalierbarkeit dieser Lösung umso relevanter.
Eine Einschränkung dieses Ansatzes besteht darin, dass die vollständigen Anfrage- und Antwortprotokolle nicht über den Anwendungscode verfügbar sind. Über gRPC-Interceptors kann auf vollständige Anfrage- und Antwortobjekte zugegriffen werden. So werden Anfrage- und Antwortprotokolle für die integrierte Clientbibliotheksprotokollierung abgerufen. Bei einem Fehler sind möglicherweise zusätzliche Informationen im Ausnahmeobjekt verfügbar, bei erfolgreichen Antworten innerhalb der Anwendungslogik sind jedoch weniger Details verfügbar. In den meisten Fällen ist beispielsweise über die Antwortobjekte der Google Ads API nicht auf die Anfrage-ID einer erfolgreichen Anfrage zuzugreifen.
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 übergeben werden. Die Clientbibliotheken der Google Ads API verwenden gRPC-Interceptors, um integrierten Logging-Support zu bieten. Ebenso können Sie einen benutzerdefinierten gRPC-Interceptor implementieren, um auf die Anfrage- und Antwortobjekte zuzugreifen, Informationen zu Logging- und Monitoring-Zwecken zu extrahieren und diese Daten an den gewünschten Speicherort zu schreiben.
Im Gegensatz zu einigen der hier vorgestellten Lösungen können Sie mit einem benutzerdefinierten gRPC-Interceptor flexibel Anfrage- und Antwortobjekte bei jeder Anfrage erfassen und zusätzliche Logik implementieren, um Details der Anfrage zu erfassen. Sie können beispielsweise die verstrichene Zeit einer Anfrage berechnen, indem Sie die Logik für die Leistungszeit im benutzerdefinierten Interceptor selbst implementieren und den Messwert dann in Google Cloud Logging loggen, um ihn für die Latenzüberwachung in Google Cloud Monitoring verfügbar zu machen.
Benutzerdefinierter Google Cloud Logging-Abfangmechanismus in Python
Zur Veranschaulichung dieser Lösung haben wir ein Beispiel für einen benutzerdefinierten Logging-Interceptor in Python geschrieben. Der benutzerdefinierte Interceptor wird erstellt und an den Dienstclient übergeben. Es greift dann auf die Anfrage- und Antwortobjekte zu, die bei jedem Dienstmethodenaufruf übergeben werden, verarbeitet die Daten aus diesen Objekten und sendet sie an Google Cloud Logging.
Zusätzlich zu den Daten aus den Anfrage- und Antwortobjekten wird im Beispiel zusätzliche Logik implementiert, um die verstrichene Zeit der Anfrage und einige andere Metadaten zu erfassen, die für Überwachungszwecke nützlich sind, 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 Leitfaden zum 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