Günlük kaydı ve izleme, bunları anlamanıza ve optimize etmenize yardımcı olmak için birlikte çalışır uygulamanın yanı sıra, uygulamalarınızın performansını test etmek için sorunları. Tüm API çağrıları için özet günlüklerini açmanız gerekir API'yi sağlayabilmeniz için başarısız API çağrılarına ilişkin ayrıntılı günlükler teknik desteğe ihtiyaç duyduğunuzda arama kayıtları.
İstemci kitaplığı günlük kaydı
Google Ads API istemci kitaplıkları, yerleşik günlük kaydı özelliğine sahiptir. Platforma özel daha fazla bilgi edinmek istiyorsanız, istemci kitaplığınızdaki günlük kaydı dokümanlarına seçim.
Günlük biçimi
Google Ads API istemci kitaplıkları, ayrıntılı bir günlük ve bir özet oluşturur günlük kaydı oluşturun. Ayrıntılı günlük, projenizin tüm ayrıntılarını içerir. özet günlüğü, API çağrısıyla ilgili çok az ayrıntı içerir. Günlükler kısaltılıp biçimlendirilmiş olarak, her bir günlük türüne ait bir örnek gösterilmektedir gözden geçirin.
Özet günlüğü
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.")
Ayrıntılı günlük
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----------------
İstemci kitaplığı kullanmıyorsam ne olacak?
İstemci kitaplığı kullanmıyorsanız
, giden ve gelen API çağrılarının ayrıntılarını içerir. En azından
değeri request-id daha sonra
teknik destek ekiplerine gönderin.
Buluta giriş yapma
Projeniz için günlükleri ve performans metriklerini kaydetmek amacıyla kullanabileceğiniz birçok araç vardır. en iyi yoludur. Örneğin, Google Cloud Logging'i kullanarak performans metriklerini Google Cloud projenize ekleyin. Bu da, Google Cloud Monitoring'de kontrol paneli ve uyarı oluşturma imkanı kullanabilirsiniz.
Cloud Logging, desteklenen tüm Google Ads API istemcileri için istemci kitaplıkları sunar kitaplık dillerini içerir. Bu nedenle çoğu durumda, Doğrudan istemci kitaplığı entegrasyonunuzdan Cloud Logging'i kullanın. Diğer diller için Perl dahil olmak üzere Cloud Logging, bir REST API de sunar.
Search Console'dan Cloud Logging'e veya başka bir araca Google Ads API istemci kitaplığı. Her seçeneğin belirli bir zaman diliminde karmaşıklık ve performanstır. Bu dengeleri iyice düşünün karar vermeden önce epey zaman harcadınız.
1. Seçenek: Arka plandaki bir işlemi kullanarak yerel günlükleri buluta yazma
İstemci kitaplığı günlükleri, günlük kaydı yapılandırmanıza bağlıdır. Günlükler yerel bir dosyaya dönüştürüldükten sonra şunları yapabilirsiniz: günlükleri toplamak ve buluta göndermek için bir arka plan programı oluşturun.
Bu yaklaşımın bir sınırlaması, bazı performans metriklerinin yakalamanız gerekir. İstemci kitaplığı günlükleri, istekteki ayrıntıları ve Bu nedenle, ek değişiklikler yapılmadığı sürece gecikme metrikleri dahil edilmez. bunların da günlüğe kaydedilmesi gerekir.
2. Seçenek: Uygulamanızı Compute Engine'de çalıştırın ve İşlem Aracısı'nı yükleyin
Uygulamanız Compute Engine'de çalışıyorsa İşlem Aracısı'nı yükleyerek günlükleri Google Cloud Logging'e yükleyin. İşlemler Aracı, uygulama günlüklerinizi Cloud'a gönderecek şekilde yapılandırılabilir Varsayılan olarak gönderilen metrikler ve günlüklere ek olarak günlüğe kaydetme.
Uygulamanız zaten bir Google Cloud ortamında çalışıyorsa veya uygulamanızı Google Cloud'a taşımayı düşünüyorsanız, bu en iyi göz önünde bulundurmanız gerekir.
3. seçenek: Uygulama kodunuzda günlük kaydını uygulama
Doğrudan uygulama kodundan günlük kaydı yapılabilmesi iki yöntemden biriyle yapılabilir:
Her bir günlükte metrik hesaplamalarını ve günlük ifadelerini kodunuzda da kullanabilirsiniz. Bu seçenek, daha küçük boyutlu kapsam ve bakım maliyetlerinin olacağı kod tabanları çok önemlidir.
Günlük kaydı arayüzü uygulama. Uygulama mantığı soyutlanabilirse uygulamanın farklı parçalarının aynı temel günlük kaydı mantığı, bu temel sınıfta uygulanabilir. Bu seçenek sayfa boyunca günlük ifadelerinin eklenmesi yerine genellikle bakımı ve ölçeklendirmesi daha kolay olduğu için bu kodu kullanmanızı öneririz. Daha büyük kod tabanları, bu çözümün sürdürülebilirliği ve ölçeklenebilirliği, daha alakalı hale getirebilirsiniz.
Bu yaklaşımın bir sınırlaması, tam istek ve yanıt günlüklerinin uygulama kodundan kullanılamaz. Tam istek ve yanıt nesneleri gRPC önleyicilerinden erişilebilir; yerleşik istemci kitaplığı bu şekilde Logging, istek ve yanıt günlüklerini alır. Hata durumunda istisna nesnesinde bilgi olabilir, ancak daha az ayrıntı başarılı yanıtlar için kullanılabilir. Örneğin, Çoğu durumda, başarılı bir isteğin istek kimliğine Google Ads API yanıt nesneleri.
4. Seçenek: Özel bir gRPC günlük kaydı müdahalesi uygulama
gRPC, istek ve yanıt nesnelerinin istemci ile sunucu arasında iletilmesini sağlar. İlgili içeriği oluşturmak için kullanılan Google Ads API istemci kitaplıkları, yerleşik günlük kaydı sunmak için gRPC önleyicilerini kullanır destek. Benzer şekilde, aynı veri kümesine erişmek için özel bir gRPC önleyici istek ve yanıt nesneleri, günlük kaydı ve izleme için bilgi ayıklama ve bu verileri istediğiniz konuma yazabilirsiniz.
Burada sunulan diğer çözümlerin bazılarından farklı olarak, özel bir gRPC uygulamak müdahaleci, aynı zamanda istek ve yanıt nesnelerini ve isteğin ayrıntılarını yakalamak için ek mantık uygulayın. Örneğin, performans zamanlama mantığını kendi içinde gösterir ve ardından gecikme izlemede kullanılabilir hale getirmek için metriği Google Cloud Logging'e Google Cloud Monitoring'den yararlanın.
Python'da özel Google Cloud Logging önleyicisi
Bu çözümü göstermek için özel bir günlük kaydı örneği yazdık aracından bahsetmek istiyorum. Özel müdahaleci oluşturulur ve gerekir. Daha sonra her hizmet yöntemi çağrısında bulunur, bu nesnelerden gelen verileri işler ve , verileri Google Cloud Logging'e gönderir.
İstek ve yanıt nesnelerinden gelen verilere ek olarak örnek, reklam öğesi tasarlarken geçen süreyi yakalamak için isteği ve izleme amacıyla yararlı olabilecek diğer bazı meta veriler, (ör. isteğin başarılı olup olmadığı). Bu programın hem genel anlamda izleme açısından hem de özellikle Google Cloud Logging ve Google Cloud Monitoring'i birlikte kullanmak için bkz. İzleme rehberini inceleyin.
# 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