Durch die Kombination von Logging und Monitoring können Sie besser nachvollziehen und optimieren, sowie zur Diagnose von Fehlern und Probleme. Sie sollten Zusammenfassungslogs für alle API-Aufrufe und detaillierte Logs für fehlgeschlagene API-Aufrufe, damit Sie die API bereitstellen können Anruflisten, wenn Sie technischen Support benötigen.
Logging der Clientbibliothek
Die Google Ads API-Clientbibliotheken bieten eine integrierte Protokollierung. Für plattformspezifische finden Sie in der Logging-Dokumentation in der Clientbibliothek eine große Auswahl.
| Sprache | Leitfaden |
|---|---|
| Java | Logging-Dokumentation für Java |
| .NET | Logging-Dokumente für .NET |
| PHP | Logging-Dokumente für PHP |
| Python | Logging-Dokumente für Python |
| Ruby | Logging-Dokumente für Ruby |
| Perl | Logging-Dokumente für Perl |
Logformat
Die Google Ads API-Clientbibliotheken generieren ein detailliertes Protokoll und eine Zusammenfassung log für jeden API-Aufruf. Das detaillierte Protokoll enthält alle Details des API-Aufrufs, während das Zusammenfassungsprotokoll nur wenige Details des API-Aufrufs enthält. Es wird ein Beispiel für jeden Protokolltyp angezeigt, wobei die Protokolle gekürzt und formatiert sind für bessere Lesbarkeit.
Zusammenfassungslog
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 Ihr eigenes Logging, um den
zu den ausgehenden und eingehenden API-Aufrufen. Sie sollten mindestens
des request-id-Antwortheaders, der dann mit dem
dem technischen Supportteam.
Logging in der Cloud
Es gibt viele Tools, mit denen Sie Logs und Leistungsmesswerte Ihre Anwendung. Mit Google Cloud Logging können Sie beispielsweise zu Ihrem Google Cloud-Projekt hinzufügen. 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-Clients. mit Ausnahme von Perl. In den meisten Fällen ist es also möglich, Cloud Logging direkt über die Einbindung Ihrer Clientbibliothek Für andere Sprachen einschließlich Perl bietet Cloud Logging auch eine REST API.
Für das Logging in Cloud Logging oder einem anderen Tool gibt es Google Ads API-Clientbibliothek. Jede Option hat ihre eigenen Zeit-Kompromisse, Implementierung, Komplexität und Leistung. Überlegen Sie sich diese Vor- und Nachteile bevor Sie sich für eine Lösung entscheiden.
Option 1: Lokale Logs aus einem Hintergrundprozess in die Cloud schreiben
Clientbibliotheksprotokolle können in eine lokale Datei auf Ihrem Computer geschrieben werden, indem Sie Ihre Logging-Konfiguration. Sobald die Logs in eine lokale Datei ausgegeben wurden, können Sie einen Daemon einrichten, der die Logs erfasst und an die Cloud sendet.
Ein Nachteil dieses Ansatzes besteht darin, dass einige Leistungsmesswerte standardmäßig erfasst. Clientbibliothekslogs enthalten Details aus der Anfrage und Antwortobjekte, sodass Latenzmesswerte nur dann enthalten sind, wenn weitere Änderungen vorgenommen werden werden ebenfalls protokolliert.
Option 2: Anwendung in Compute Engine ausführen und Ops-Agent installieren
Wenn Ihre Anwendung in Compute Engine ausgeführt wird, können Sie Ihren Logs in Google Cloud Logging übertragen, indem Sie den Ops-Agent installieren. Das Operations-Team Agent kann so konfiguriert werden, dass er Ihre Anwendungslogs an Cloud sendet Logging. Zusätzlich zu den standardmäßig gesendeten Messwerten und Logs.
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, die Sie berücksichtigen sollten.
Option 3: Logging in den Anwendungscode implementieren
Das Logging direkt aus dem Anwendungscode kann auf zwei Arten erfolgen:
Messwertberechnungen und Loganweisungen in jedes entsprechenden Standort in Ihrem Code angeben. Diese Option eignet sich besser für kleinere Codebasen, bei denen sich der Umfang und die Wartungskosten einer solchen Änderung minimal.
Logging-Schnittstelle implementieren Ob die Anwendungslogik abstrahiert werden kann sodass verschiedene Teile der Anwendung von derselben Basis kann die Logging-Logik in dieser Basisklasse implementiert werden. Diese Option ist im Allgemeinen gegenüber Protokollberichten im gesamten Anwendungscode, da er einfacher zu warten und zu skalieren ist. Für größere sind die Wartbarkeit und Skalierbarkeit dieser Lösung relevanter sind.
Eine Einschränkung dieses Ansatzes besteht darin, dass die vollständigen Anfrage- und Antwortlogs nicht im Anwendungscode verfügbar. Vollständige Anfrage- und Antwortobjekte auf gRPC-Abfangenden zugegriffen werden kann. So sieht die integrierte Clientbibliothek Logging erhält Anfrage- und Antwortlogs. Im Falle eines Fehlers werden zusätzliche Informationen sind möglicherweise im Ausnahmeobjekt verfügbar, für erfolgreiche Antworten innerhalb der Anwendungslogik verfügbar. Beispiel: In den meisten Fällen ist die Anfrage-ID für eine erfolgreiche Anfrage nicht über das Google Ads API-Antwortobjekte.
Option 4: Benutzerdefinierten gRPC-Logging-Abfangende implementieren
gRPC unterstützt unäre und Streaming-Abfangende, die auf die Anfrage- und Antwortobjekte während ihrer Übertragung zwischen Client und Server. Die Google Ads API-Clientbibliotheken nutzen gRPC-Abfangprogramme für integriertes Logging. Support. Ebenso können Sie einen benutzerdefinierten gRPC-Abfangende für den Zugriff auf den Anfrage- und Antwortobjekte; Informationen für Logging und Monitoring extrahieren und speichern diese Daten an den Speicherort Ihrer Wahl.
Im Gegensatz zu einigen anderen hier vorgestellten Lösungen ist die Implementierung eines benutzerdefinierten gRPC- Mit Interceptor können Sie Anfrage- und Antwortobjekte auf jede Anfrage ausführen und zusätzliche Logik implementieren, um die Details der Anfrage zu erfassen. Sie können beispielsweise die verstrichene Zeit einer Anfrage berechnen, indem Sie innerhalb des benutzerdefinierten Abfangfunktions selbst, und loggen Messwert an Google Cloud Logging senden, um ihn für das Latenzmonitoring zur Verfügung zu stellen in Google Cloud Monitoring.
Benutzerdefinierter Google Cloud Logging-Abfangfunktion in Python
Zur Veranschaulichung dieser Lösung haben wir ein Beispiel für ein benutzerdefiniertes Logging Interceptor in Python. Der benutzerdefinierte Interceptor wird erstellt und an den Service-Client. Sie greift dann auf die Anfrage- und Antwortobjekte zu, die bei jedem Aufruf einer Dienstmethode durchlaufen, Daten aus diesen Objekten verarbeitet und sendet die Daten an Google Cloud Logging.
Zusätzlich zu den Daten, die aus den Anfrage- und Antwortobjekten stammen, enthält eine zusätzliche Logik, um die verstrichene Zeit und einige andere Metadaten an, die für Monitoringzwecke nützlich sind. z. B. ob die Anfrage erfolgreich war oder nicht. Weitere Informationen dazu, wie Sie Informationen können sowohl für die Überwachung als auch speziell dann nützlich sein, Google Cloud Logging und Google Cloud Monitoring kombinieren, siehe 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