ロギングとモニタリングは連携して機能し、アプリケーション パフォーマンスの把握と最適化、エラーやシステム関連の問題の診断に役立ちます。テクニカル サポートが必要なときに API 呼び出しログを提供できるように、すべての API 呼び出しのサマリーログと失敗した API 呼び出しの詳細ログを有効にする必要があります。
クライアント ライブラリのロギング
Google Ads API のクライアント ライブラリにはロギング機能が組み込まれています。プラットフォーム固有のロギングの詳細については、選択したクライアント ライブラリ内のロギングのドキュメントをご覧ください。
| 言語 | ガイド |
|---|---|
| Java | Java 用の Logging ドキュメント |
| .NET | .NET のロギング ドキュメント |
| PHP | PHP 用のロギング ドキュメント |
| Python | Python 用の Logging のドキュメント |
| Ruby | Ruby のロギング ドキュメント |
| Perl | Perl のロギング ドキュメント |
ログ形式
Google Ads API クライアント ライブラリでは、API 呼び出しごとに詳細ログと概要ログが生成されます。詳細ログには API 呼び出しの詳細がすべて含まれますが、概要ログには API 呼び出しに関する最小限の詳細が含まれます。ログの種類ごとに例を示します。読みやすくするためにログを省略してフォーマットしています。
概要ログ
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.")
詳細なログ
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----------------
クライアント ライブラリを使用しない場合はどうすればよいですか？
クライアント ライブラリを使用しない場合は、独自のロギングを実装して、送信 API 呼び出しと受信 API 呼び出しの詳細をキャプチャします。少なくとも request-id レスポンス ヘッダーの値をログに記録する必要があります。この値は、必要に応じてテクニカル サポートチームと共有できます。
クラウドへのロギング
アプリケーションのログとパフォーマンス指標をキャプチャするために使用できるツールは数多くあります。たとえば、Google Cloud Logging を使用して、パフォーマンス指標を Google Cloud プロジェクトに記録できます。これにより、ログに記録された指標を利用するために、Google Cloud Monitoring でダッシュボードとアラートを設定できます。
Cloud Logging には、Perl を除くすべてのサポートされている Google Ads API クライアント ライブラリ言語のクライアント ライブラリが用意されています。そのため、ほとんどの場合、クライアント ライブラリの統合から直接 Cloud Logging でロギングできます。Perl などの他の言語には、Cloud Logging で REST API も用意されています。
Google Ads API クライアント ライブラリから Cloud Logging またはその他のツールにロギングするには、いくつかのオプションがあります。どの方法にも、実装時間、複雑さ、パフォーマンスのトレードオフがあります。どのソリューションを実装するかを決定する前に これらのトレードオフについて慎重に検討してください
オプション 1: バックグラウンド プロセスからローカルログをクラウドに書き込む
ロギング構成を変更することで、クライアント ライブラリ ログをマシンのローカル ファイルに書き込めます。ログがローカル ファイルに出力されたら、ログを収集してクラウドに送信するデーモンをセットアップできます。
このアプローチの制限の 1 つは、一部のパフォーマンス指標がデフォルトでキャプチャされないことです。クライアント ライブラリ ログにはリクエスト オブジェクトとレスポンス オブジェクトの詳細が含まれるため、これらをログに記録するための追加の変更が加えられない限り、レイテンシ指標は含まれません。
オプション 2: Compute Engine でアプリケーションを実行し、Ops エージェントをインストールする
アプリケーションが Compute Engine で実行されている場合は、Ops エージェントをインストールすることで、Google Cloud Logging にログを送信できます。デフォルトで送信される指標とログに加えて、アプリケーション ログを Cloud Logging に送信するように Ops エージェントは構成できます。
アプリケーションがすでに Google Cloud 環境で実行されている場合や、アプリケーションを Google Cloud に移行することを検討している場合は、このオプションを検討することをおすすめします。
オプション 3: アプリケーション コードにロギングを実装する
アプリケーション コードから直接ロギングするには、次の 2 つの方法があります。
コード内の該当するすべての場所に、指標計算とログ ステートメントを組み込む。このオプションは、変更の範囲とメンテナンス コストを最小限に抑える小規模なコードベースの場合に有効です。
ロギング インターフェースを実装する。アプリケーション ロジックを抽象化して、アプリケーションのさまざまな部分が同じ基本クラスから継承できるようにできる場合は、その基本クラスにロギング ロジックを実装できます。このオプションは、メンテナンスとスケーリングが容易なため、アプリケーション コード全体にログ ステートメントを組み込む場合よりも一般的に推奨されます。コードベースが大きくなると、このソリューションの保守性とスケーラビリティがより高くなります。
このアプローチの制限の 1 つは、アプリケーション コードからリクエストとレスポンスの完全なログを取得できないことです。完全なリクエスト オブジェクトとレスポンス オブジェクトには gRPC インターセプタからアクセスできます。これにより、組み込みのクライアント ライブラリ ロギングがリクエストとレスポンスのログを取得します。エラーが発生した場合は、例外オブジェクトで追加情報が提供される場合がありますが、アプリケーション ロジック内の正常なレスポンスについては、使用できる詳細情報が少なくなります。たとえば、ほとんどの場合、成功したリクエストのリクエスト ID は、Google Ads API レスポンス オブジェクトからアクセスできません。
オプション 4: カスタム gRPC ロギング インターセプタを実装する
gRPC は単項およびストリーミングのインターセプタをサポートしています。これらのインターセプタは、クライアントとサーバーの間で渡されるリクエスト オブジェクトとレスポンス オブジェクトにアクセスできます。Google Ads API クライアント ライブラリは、gRPC インターセプタを使用して組み込みロギング サポートを提供します。同様に、カスタム gRPC インターセプタを実装してリクエスト オブジェクトとレスポンス オブジェクトにアクセスし、ロギングとモニタリングのための情報を抽出し、そのデータを任意のロケーションに書き込むことができます。
ここで紹介する他のソリューションとは異なり、カスタム gRPC インターセプタを実装すると、リクエストごとにリクエスト オブジェクトとレスポンス オブジェクトを柔軟にキャプチャし、リクエストの詳細をキャプチャするための追加のロジックを実装できます。たとえば、カスタム インターセプタ自体にパフォーマンス タイミング ロジックを実装することでリクエストの経過時間を計算し、指標を Google Cloud Logging に記録して、Google Cloud Monitoring 内のレイテンシ モニタリングに使用できるようになります。
Python でのカスタム Google Cloud Logging インターセプタ
このソリューションのデモを行うために、Python でカスタム ロギング インターセプタの例を作成しました。カスタム インターセプタが作成され、サービス クライアントに渡されます。次に、すべてのサービス メソッド呼び出しでパススルーされるリクエスト オブジェクトとレスポンス オブジェクトにアクセスし、それらのオブジェクトのデータを処理して、データを Google Cloud Logging に送信します。
この例では、リクエスト オブジェクトとレスポンス オブジェクトから取得したデータに加えて、リクエストの経過時間をキャプチャする追加のロジックと、リクエストが成功したかどうかなどのモニタリングに役立つその他のメタデータを実装しています。この情報が一般的なモニタリングでどのように役立つか、特に Google Cloud Logging と Google Cloud 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