Logowanie i monitorowanie działają równolegle, ułatwiając analizę i optymalizację wydajności aplikacji oraz diagnozowanie błędów i problemów związanych z systemem. Włącz logi podsumowania wszystkich wywołań interfejsu API oraz szczegółowe logi w przypadku nieudanych wywołań interfejsu API, aby móc dostarczać logi wywołań interfejsu API na potrzeby pomocy technicznej.
Logowanie biblioteki klienta
Biblioteki klienta interfejsu Google Ads API mają wbudowaną funkcję rejestrowania. Szczegółowe informacje o logowaniu na poszczególnych platformach znajdziesz w dokumentacji logowania w wybranej bibliotece klienta.
| Język | Przewodnik |
|---|---|
| Java | Logowanie dokumentacji Java |
| .NET | Logowanie dokumentacji .NET |
| PHP | Logowanie dokumentacji PHP |
| Python | Dokumentacja logowania w języku Python |
| Ruby | Dokumentacja logowania w języku Ruby |
| Perl | Logowanie dokumentacji Perl |
Format dziennika
Biblioteki klienta interfejsu Google Ads API generują szczegółowy dziennik i dziennik podsumowania każdego wywołania interfejsu API. Szczegółowy dziennik zawiera wszystkie szczegóły wywołania interfejsu API, natomiast dziennik podsumowania zawiera ich minimalną ilość. Wyświetlany jest przykład każdego typu logu z skróconymi i sformatowanymi pod kątem czytelności.
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 dziennik
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 używam biblioteki klienta?
Jeśli nie korzystasz z biblioteki klienta, zaimplementuj własne logowanie, aby rejestrować szczegóły wychodzących i przychodzących wywołań interfejsu API. Zarejestruj co najmniej wartość nagłówka odpowiedzi request-id. W razie potrzeby możesz ją udostępnić zespołom pomocy technicznej.
Logowanie do chmury
Istnieje wiele narzędzi, za pomocą których możesz przechwytywać logi i wskaźniki wydajności aplikacji. Możesz na przykład używać Google Cloud Logging do logowania wskaźników wydajności w projekcie Google Cloud. Dzięki temu możesz skonfigurować panele i alerty w Google Cloud Monitoring, aby korzystać z zalogowanych wskaźników.
Usługa Cloud Logging udostępnia biblioteki klienta dla wszystkich obsługiwanych języków bibliotek klienta interfejsu Google Ads API z wyjątkiem języka Perl, więc w większości przypadków można zalogować się za pomocą Cloud Logging bezpośrednio z poziomu integracji z biblioteką klienta. Dla innych języków, w tym Perl, Cloud Logging udostępnia również interfejs API REST.
Biblioteka klienta interfejsu Google Ads API udostępnia kilka opcji logowania do Cloud Logging lub innego narzędzia. Każda opcja wiąże się z innymi kompromisami, oprócz złożoności i czasu wdrożenia oraz wydajności. Dobrze zastanów się nad tymi kompromisami przed podjęciem decyzji, które rozwiązanie zastosować.
Opcja 1. Zapisz lokalne logi w chmurze z procesu w tle
Logi biblioteki klienta można zapisywać w pliku lokalnym na komputerze przez zmianę konfiguracji logowania. Gdy logi zostaną przesłane do pliku lokalnego, możesz skonfigurować demona, który będzie je zbierał i wysyłał do chmury.
Jedną z ograniczeń tej metody jest to, że niektóre dane o skuteczności nie będą rejestrowane domyślnie. Logi biblioteki klienta zawierają szczegóły z obiektów żądania i odpowiedzi, dlatego wskaźniki czasu oczekiwania nie będą uwzględniane, chyba że wprowadzisz 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. Agent operacyjny można skonfigurować tak, aby wysyłał logi aplikacji do Cloud Logging jako dodatek do domyślnie wysyłanych danych i logów.
Jest to świetna opcja, jeśli Twoja aplikacja działa już w środowisku Google Cloud lub jeśli rozważasz jej przeniesienie do Google Cloud.
Opcja 3. Zaimplementuj logowanie w kodzie aplikacji
Logowanie bezpośrednio z kodu aplikacji można wykonać na jeden z dwóch sposobów:
stosowanie obliczeń wskaźników i instrukcji dziennika w odpowiedniej lokalizacji w kodzie. Ta opcja jest bardziej dogodna w przypadku mniejszych baz kodu, przy których zakres i koszty utrzymania są minimalne.
Wdrożenie interfejsu logowania. Jeśli logikę aplikacji można wyodrębnić w taki sposób, że różne jej elementy odziedziczą tę samą klasę bazową, to w tej klasie można wdrożyć logikę logowania. Ta opcja jest zwykle lepsza niż włączanie instrukcji logów w całym kodzie aplikacji, ponieważ jest łatwiejsza w utrzymaniu i skalowaniu. W przypadku większych baz kodu tym większe znaczenie ma 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 obiektów pełnego żądania i odpowiedzi można uzyskać z elementów przechwytujących gRPC. W ten sposób wbudowana biblioteka klienta do logowania pobiera logi żądań i odpowiedzi. W przypadku błędu w obiekcie wyjątku mogą być dostępne dodatkowe informacje, ale w logice aplikacji dostępnych jest mniej szczegółów dotyczących pomyślnych odpowiedzi. Na przykład w większości przypadków identyfikator udanego żądania nie jest dostępny z poziomu obiektów odpowiedzi interfejsu Google Ads API.
Opcja 4. Wdróż niestandardowy element przechwytujący logowanie gRPC
gRPC obsługuje elementy przechwytujące jednoargumentowe i strumieniowe, które mogą uzyskiwać dostęp do obiektów żądania i odpowiedzi, które są przesyłane między klientem a serwerem. Biblioteki klienta interfejsu Google Ads API korzystają z mechanizmów przechwytujących gRPC, aby zapewnić wbudowaną obsługę logowania. I podobnie, możesz wdrożyć niestandardowy przechwytujący gRPC, aby uzyskiwać dostęp do obiektów żądań i odpowiedzi, pobierać informacje do celów logowania i monitorowania oraz zapisywać te dane w wybranej lokalizacji.
W przeciwieństwie do niektórych innych przedstawionych tu rozwiązań implementacja niestandardowego przechwytującego gRPC daje elastyczność wychwytywania obiektów żądań i odpowiedzi w przypadku każdego żądania oraz implementowania dodatkowej logiki zbierającej szczegóły żądania. Możesz na przykład obliczyć czas, jaki upłynął dla żądania, implementując logikę czasu wydajności w samym niestandardowym przechwytku, a następnie rejestrować dane w Google Cloud Logging, aby udostępnić je do monitorowania czasu oczekiwania w Google Cloud Monitoring.
Niestandardowy przechwytujący Google Cloud Logging w Pythonie
Aby zademonstrować to rozwiązanie, napisaliśmy w Pythonie przykładowy przechwytujący logowanie. Tworzony jest niestandardowy element przechwytujący i przekazywany do klienta usługi. Następnie uzyskuje dostęp do obiektów żądań i odpowiedzi, które przekazują w każdym wywołaniu metody usługi, przetwarza dane z tych obiektów i wysyła je do Google Cloud Logging.
Oprócz danych pochodzących z obiektów żądań i odpowiedzi w przykładzie zaimplementowano dodatkową logikę do rejestrowania czasu, który upłynął od żądania, oraz inne metadane, które mogą być przydatne przy monitorowaniu, na przykład informacje o tym, czy żądanie zostało zrealizowane. Więcej informacji o tym, jak te informacje mogą być przydatne – zarówno do monitorowania, jak i w kontekście łączenia Google Cloud Logging i Google Cloud Monitoring, znajdziesz w przewodniku po monitorowaniu.
# 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