Logowanie i monitorowanie działają razem, aby pomóc Ci zrozumieć i zoptymalizować wydajność aplikacji oraz zdiagnozować błędy i problemy związane z systemem. Włącz logi podsumowujące dla wszystkich wywołań interfejsu API i szczegółowe logi nieudanych wywołań interfejsu API, aby w razie potrzeby móc udostępnić logi wywołań interfejsu API zespołowi pomocy technicznej.
Logowanie w bibliotece klienta
Biblioteki klienta interfejsu Google Ads API mają wbudowaną funkcję logowania. Szczegółowe informacje o logowaniu na poszczególnych platformach znajdziesz w dokumentacji logowania w wybranej bibliotece klienta.
| Język | Przewodnik |
|---|---|
| Java | Dokumentacja logowania w Javie |
| .NET | Dokumentacja logowania w .NET |
| PHP | Dokumentacja logowania w PHP |
| Python | Dokumentacja logowania w Pythonie |
| Ruby | Dokumentacja logowania w Ruby |
| Perl | Dokumentacja logowania w Perlu |
Format logu
Biblioteki klienta interfejsu Google Ads API generują szczegółowy log i log podsumowujący dla każdego wywołania interfejsu API. Szczegółowy log zawiera wszystkie szczegóły wywołania interfejsu API, a log podsumowujący – minimalne szczegóły wywołania interfejsu API. Poniżej znajdziesz przykład każdego typu logu. Logi są skrócone i sformatowane w celu zwiększenia czytelności.
Log podsumowujący
GoogleAds.SummaryRequestLogs Warning: 1 : [2023-09-15 19:58:39Z] -
Request made: Host: , Method: /google.ads.googleads.v24.services.GoogleAdsService/SearchStream,
ClientCustomerID: 5951878031, RequestID: hELhBPNlEDd8mWYcZu7b8g,
IsFault: True, FaultMessage: Status(StatusCode="InvalidArgument",
Detail="Request contains an invalid argument.")
Szczegółowy log
GoogleAds.DetailedRequestLogs Verbose: 1 : [2023-11-02 21:09:36Z] -
---------------BEGIN API CALL---------------
Request
-------
Method Name: /google.ads.googleads.v24.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 używasz biblioteki klienta, zaimplementuj własne logowanie, aby rejestrować szczegóły wychodzących i przychodzących wywołań interfejsu API. Powinieneś rejestrować co najmniej
wartość nagłówka odpowiedzi request-id, którą w razie potrzeby możesz udostępnić
zespołom pomocy technicznej.
Logowanie w chmurze
Do rejestrowania logów i danych o wydajności aplikacji możesz używać wielu narzędzi. Możesz na przykład użyć Cloud Logging, aby rejestrować dane o wydajności w projekcie Google Cloud. Umożliwia to skonfigurowanie paneli i alertów w Cloud Monitoring aby wykorzystywać zarejestrowane dane.
Cloud Logging oferuje biblioteki klienta we wszystkich obsługiwanych językach bibliotek klienta interfejsu Google Ads API z wyjątkiem Perla. W większości przypadków można więc logować się w Cloud Logging bezpośrednio z integracji biblioteki klienta. W przypadku innych języków w tym Perla, Cloud Logging oferuje też interfejs REST API.
Istnieje kilka opcji logowania w Cloud Logging lub innym narzędziu z biblioteki klienta interfejsu Google Ads API. Każda opcja ma swoje wady i zalety związane z czasem implementacji, złożonością i wydajnością. Zanim zdecydujesz się na konkretne rozwiązanie, dokładnie rozważ te kompromisy.
Opcja 1. Zapisywanie logów lokalnych w chmurze z procesu działającego w tle
Logi biblioteki klienta można zapisywać w pliku lokalnym na komputerze, modyfikując konfigurację logowania. Gdy logi zostaną zapisane w pliku lokalnym, możesz skonfigurować demona, który będzie zbierać logi i wysyłać je do chmury.
Jednym z ograniczeń tego podejścia jest to, że niektóre dane o wydajności nie będą domyślnie rejestrowane. Logi biblioteki klienta zawierają szczegóły z obiektów żądania i odpowiedzi, więc dane o opóźnieniu nie będą uwzględniane, chyba że wprowadzisz dodatkowe zmiany, aby je też rejestrować.
Opcja 2. Uruchomienie aplikacji w Compute Engine i zainstalowanie agenta operacyjnego
Jeśli aplikacja działa w Compute Engine, możesz wysyłać logi do Cloud Logging, instalując agenta operacyjnego. Agenta operacyjnego można skonfigurować tak, aby oprócz domyślnie wysyłanych danych i logów wysyłał też logi aplikacji do Cloud Logging.
Jeśli Twoja aplikacja działa już w środowisku Google Cloud lub rozważasz przeniesienie jej do Google Cloud, jest to świetna opcja.
Opcja 3. Implementacja logowania w kodzie aplikacji
Logowanie bezpośrednio z kodu aplikacji można przeprowadzić na 2 sposoby:
Włączenie obliczania danych i instrukcji logowania w każdym odpowiednim miejscu w kodzie. Ta opcja jest bardziej odpowiednia w przypadku mniejszych baz kodu, w których zakres i koszty utrzymania takiej zmiany byłyby minimalne.
Implementacja interfejsu logowania. Jeśli logikę aplikacji można wyodrębnić tak, aby różne części aplikacji dziedziczyły z tej samej klasy bazowej, logikę logowania można zaimplementować w tej klasie bazowej. Ta opcja jest na ogół preferowana w stosunku do włączania instrukcji logowania w kodzie aplikacji, ponieważ jest łatwiejsza w utrzymaniu i skalowaniu. W przypadku większych baz kodu utrzymanie i skalowalność tego rozwiązania są tym bardziej istotne.
Jednym z ograniczeń tego podejścia jest to, że pełne logi żądań i odpowiedzi nie są dostępne z kodu aplikacji. Pełne obiekty żądań i odpowiedzi są dostępne z przechwytujących gRPC. W ten sposób wbudowane logowanie biblioteki klienta uzyskuje logi żądań i odpowiedzi. W przypadku błędu dodatkowe informacje mogą być dostępne w obiekcie wyjątku, ale w logice aplikacji dostępnych jest mniej szczegółów dotyczących udanych odpowiedzi. Na przykład w większości przypadków identyfikator żądania udanego nie jest dostępny z obiektów odpowiedzi interfejsu Google Ads API.
Opcja 4. Implementacja niestandardowego przechwytującego logowania gRPC
gRPC obsługuje przechwytujące jednoargumentowe i strumieniowe interceptors, które mogą uzyskiwać dostęp do obiektów żądań i odpowiedzi podczas ich przesyłania między klientem a serwerem. Biblioteki klienta interfejsu Google Ads API używają przechwytujących gRPC, aby oferować wbudowaną obsługę logowania. Podobnie możesz zaimplementować niestandardowe przechwytujące gRPC, aby uzyskiwać dostęp do obiektów żądań i odpowiedzi, wyodrębniać informacje na potrzeby logowania i monitorowania oraz zapisywać te dane w wybranej lokalizacji.
W przeciwieństwie do niektórych innych rozwiązań przedstawionych w tym artykule implementacja niestandardowego przechwytującego gRPC daje Ci możliwość przechwytywania obiektów żądań i odpowiedzi przy każdym żądaniu oraz implementowania dodatkowej logiki przechwytywania szczegółów żądania. Możesz na przykład obliczyć czas trwania żądania, implementując logikę pomiaru wydajności w samym przechwytującym niestandardowym, a następnie zarejestrować dane w Cloud Logging, aby były dostępne do monitorowania opóźnień w Cloud Monitoring.
Niestandardowe przechwytujące Cloud Logging w Pythonie
Aby zademonstrować to rozwiązanie, napisaliśmy przykład niestandardowego przechwytującego logowania w Pythonie. Przechwytujące niestandardowe jest tworzone i przekazywane do klienta usługi. Następnie uzyskuje dostęp do obiektów żądań i odpowiedzi, które są przekazywane przy każdym wywołaniu metody usługi, przetwarza dane z tych obiektów i wysyła je do Cloud Logging.
Oprócz danych pochodzących z obiektów żądań i odpowiedzi przykład implementuje dodatkową logikę przechwytywania czasu trwania żądania oraz innych metadanych, które mogą być przydatne do monitorowania, np. czy żądanie zostało zrealizowane. Więcej informacji o tym, jak te informacje mogą być przydatne zarówno do ogólnego monitorowania, jak i w połączeniu z Cloud Logging i 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 time from typing import Any, Callable, Dict, Optional from google.cloud import logging as google_cloud_logging from grpc._interceptor import _ClientCallDetails from google.ads.googleads.interceptors import LoggingInterceptor 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