プラットフォームのログ
Google Cloud には、次の 2 種類の API Gateway ログがあります。
Google Cloud サービスは、API Gateway リクエストごとにプラットフォーム ログを自動的に生成します。これらのログにより、リクエスト処理、認証、他の Google Cloud サービスとのやり取りを把握できます。これらのログは、ゲートウェイ エラーのデバッグ、パフォーマンスの分析、トラフィック パターンの把握に不可欠です。プラットフォーム ログの種類の詳細については、以下をご覧ください。
- リクエスト ログ
各ログエントリは、API Gateway によって処理されたクエリを表します。各リクエストの HTTP ステータス コード、レイテンシ、レスポンスの理由、リクエストとレスポンスのサイズなどの有用な情報が含まれています。
ログクエリ
resource.type="apigateway.googleapis.com/Gateway" resource.labels.gateway_id="GATEWAY_ID" resource.labels.location="LOCATION" log_name="projects/PROJECT_ID/logs/apigateway.googleapis.com%2Frequests"
- ここで、GATEWAY_ID は API Gateway インスタンスの名前です。
- ここで、LOCATION は API Gateway インスタンスがデプロイされているリージョンです。
- ここで、PROJECT_ID は Google Cloud プロジェクト ID です。
- JWKS クエリログ
JWT 認証を使用する場合、API Gateway は定期的にコールアウトを行い、API 構成で指定された JWKs エンドポイントから必要な JWKs を取得します。これらのログには、JWK エンドポイントに対するリクエストの成功と失敗に関する有用な情報が表示されます。
ログクエリ
resource.type="apigateway.googleapis.com/Gateway" resource.labels.gateway_id="GATEWAY_ID" resource.labels.location="LOCATION" log_name="projects/PROJECT_ID/logs/apigateway.googleapis.com%2Fjwks_queries"
- ここで、GATEWAY_ID は API Gateway インスタンスの名前です。
- ここで、LOCATION は API Gateway インスタンスがデプロイされているリージョンです。
- ここで、PROJECT_ID は Google Cloud プロジェクト ID です。
- Service Control のクエリログ
API Gateway がトラフィックを処理するときに、Google Cloud Service Control に対して
check(割り当てと API キーの検証用)とreport(指標とログ用)の呼び出しを行います。checkまたはreport呼び出しが失敗した場合にのみ、詳細情報を含むservice_control_queriesログが入力されます。ログクエリ
resource.type="apigateway.googleapis.com/Gateway" resource.labels.gateway_id="GATEWAY_ID" resource.labels.location="LOCATION" log_name="projects/PROJECT_ID/logs/apigateway.googleapis.com%2Fservice_control_queries"
- ここで、GATEWAY_ID は API Gateway インスタンスの名前です。
- ここで、LOCATION は API Gateway インスタンスがデプロイされているリージョンです。
- ここで、PROJECT_ID は Google Cloud プロジェクト ID です。
- 生成された API ログ
apigateway.googleapis.comに関連付けられたログに加えて、API Gateway は生成された API ログも入力します。これらのログはマネージド サービスに関連付けられており、特定のマネージド サービスを実装するすべての API Gateway のログを表示するために使用できます。ログクエリ
resource.type="api" resource.labels.service="MANAGED_SERVICE"
ここで、MANAGED_SERVICE はマネージド サービスの名前です。これは、API Gateway - API リソースをクエリすることで確認できます。