Platform logs

Google Cloud offers two types of API Gateway logs:

Google Cloud services automatically generate platform logs for each API Gateway request. These logs provide visibility into request handling, authentication, and interactions with other Google Cloud services. These logs are crucial for debugging gateway errors, analyzing performance, and understanding traffic patterns. For more information about types of platform logs, see the following:

  1. Request logs

    Each log entry represents a query served by your API Gateway. It contains useful information such as the HTTP status code, latency, response reason, request/response sizes, and more for each request.

    Log query

    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"
    • Where GATEWAY_ID is the name of your API Gateway instance.
    • Where LOCATION is the region where your API Gateway instance is deployed.
    • Where PROJECT_ID is your Google Cloud project ID.
  2. JWKS queries logs

    When using JWT Authentication, your API Gateway will make periodic callouts to fetch the required JWKs from the specified JWKs endpoint in your API Config. These logs show useful information about successful and unsuccessful requests to your JWKs endpoint.

    Log query