平台記錄檔

Google Cloud 提供兩種 API Gateway 記錄:

Google Cloud 服務會自動為每個 API Gateway 要求產生平台記錄。這些記錄可讓您瞭解要求處理、驗證,以及與其他 Google Cloud 服務的互動情形。這些記錄對於偵錯閘道錯誤、分析效能及瞭解流量模式至關重要。如要進一步瞭解平台記錄類型,請參閱下列文章:

  1. 要求記錄

    每個記錄項目都代表 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。
  2. JWKS 查詢記錄

    使用 JWT 驗證時,API Gateway 會定期發出呼叫,從 API 設定中指定的 JWK 端點擷取必要的 JWK。這些記錄會顯示 JWKS 端點成功和失敗要求的實用資訊。

    記錄查詢

    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。
  3. 服務控管查詢記錄

    API Gateway 處理流量時,會對 Google Cloud Service Control 進行 check (用於驗證配額和 API 金鑰) 和 report (用於指標和記錄) 呼叫。只有在 checkreport 呼叫失敗時,系統才會填入含有更多資訊的 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。
  4. 產生的 API 記錄

    除了與 apigateway.googleapis.com 相關聯的記錄檔,API Gateway 也會填入產生的 API 記錄。這些記錄會與受管理服務建立關聯,可用於查看實作特定受管理服務的所有 API Gateway 記錄。

    記錄查詢

    resource.type="api"
    resource.labels.service="MANAGED_SERVICE"

    其中 MANAGED_SERVICE 是代管服務的名稱,您可以查詢 API Gateway - API 資源來找出這個名稱。