Endpoints のログ

ユーザーが API にリクエストを送信すると、Extensible Service Proxy(ESP)が Stackdriver Logging を使用して、リクエストとレスポンスに関する情報をログに記録します。ここでは、ログに記録される情報について説明します。

ログビューア ページで Cloud Endpoints のログを見つけるには、次の手順に従います。

  1. Google Cloud Platform Console で、[Stackdriver] > [Logging] ページに移動します。

    ログビューア ページに移動

  2. [生成された API]、SERVICE_NAME を選択します。ここで、SERVICE_NAME は Endpoints サービスの名前です。

  3. 調べるログをクリックします。ログには、以下のような構造化された JSON メッセージが含まれています。

    {
      insertId: "…"
      jsonPayload: {…}
      resource: {
        type: "api"
        labels: {…}
      }
      timestamp: "2017-05-08T15:00:02.804424422Z"
      severity: "INFO"
      logName: "…"
    }
    

jsonPayload オブジェクトには、ESP によってレポートされるすべての情報が含まれます。次の表は、各フィールドの説明です。

項目 説明
url リクエストの URL パス。
producer_project_id API を所有する Google Cloud Platform(GCP)プロジェクト ID。
api_name 呼び出された API の名前。
api_version 呼び出された名前付き API のバージョン。
api_method 呼び出された名前付き API のメソッド。
api_key 呼び出し元のコンシューマが使用している API キー(存在する場合)。
http_method リクエストの HTTP メソッド(GETPOST など)。
request_size_in_bytes リクエスト本文のサイズ(バイト単位)。
http_response_code レスポンスの HTTP ステータス コード(200404500 など)。
response_size_in_bytes レスポンス本文のサイズ(バイト単位)。
request_latency_in_ms ESP とそのバックエンドによって使用される時間を含む、リクエストへの応答に要する時間(ミリ秒単位)。ストリーミング メソッドについては存在しません。
timestamp リクエストが着信した時点のタイムスタンプ。
location リクエストを処理した GCP のゾーン。
log_message 呼び出されたメソッドとそのステータス(拒否された場合)に関する短いメッセージ。拒否された呼び出しについては、API 情報フィールドはログに記録されません。
error_cause レスポンスがエラーであった場合のエラー メッセージ。
labels labels セクションには、ログのソースを識別する情報(GCP プロジェクト ID、Endpoints サービス名、API バージョン番号、メソッド名など)が含まれます。

次のステップ

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

OpenAPI を使用した Cloud Endpoints
ご不明な点がありましたら、Google のサポートページをご覧ください。