Journaux de plate-forme

Google Cloud propose deux types de journaux API Gateway :

Les servicesGoogle Cloud génèrent automatiquement des journaux de plate-forme pour chaque requête API Gateway. Ces journaux offrent une visibilité sur le traitement des requêtes, l'authentification et les interactions avec d'autres services Google Cloud . Ces journaux sont essentiels pour déboguer les erreurs de passerelle, analyser les performances et comprendre les tendances du trafic. Pour en savoir plus sur les types de journaux de plate-forme, consultez les ressources suivantes :

  1. Journaux des requêtes

    Chaque entrée de journal représente une requête traitée par votre API Gateway. Il contient des informations utiles pour chaque requête, telles que le code d'état HTTP, la latence, le motif de la réponse, la taille de la requête/réponse, etc.

    Requête de journal

    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"
    • où GATEWAY_ID est le nom de votre instance API Gateway.
    • Où LOCATION est la région dans laquelle votre instance API Gateway est déployée.
    • où PROJECT_ID correspond à l'ID de votre projet Google Cloud .
  2. Journaux des requêtes JWKS

    Lorsque vous utilisez l'authentification JWT, votre API Gateway effectue des appels périodiques pour récupérer les JWK requis à partir du point de terminaison JWK spécifié dans votre configuration d'API. Ces journaux fournissent des informations utiles sur les requêtes envoyées à votre point de terminaison JWKS, qu'elles aient abouti ou non.

    Requête de journal

    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"
    • où GATEWAY_ID est le nom de votre instance API Gateway.
    • Où LOCATION est la région dans laquelle votre instance API Gateway est déployée.
    • où PROJECT_ID correspond à l'ID de votre projet Google Cloud .
  3. Journaux des requêtes Service Control

    Lorsque votre passerelle API diffuse du trafic, elle effectue des appels check (pour vérifier le quota et les clés API) et report (pour les métriques et les journaux) à Google Cloud Service Control. Un journal service_control_queries contenant plus d'informations n'est généré qu'en cas d'échec d'un appel check ou report.

    Requête de journal

    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"
    • où GATEWAY_ID est le nom de votre instance API Gateway.
    • Où LOCATION est la région dans laquelle votre instance API Gateway est déployée.
    • où PROJECT_ID correspond à l'ID de votre projet Google Cloud .
  4. Journaux des API produites

    En plus des journaux associés à apigateway.googleapis.com, API Gateway remplit également les journaux des API produites. Ces journaux sont associés à votre service géré et peuvent être utilisés pour afficher les journaux de toutes les passerelles API implémentant un service géré spécifique.

    Requête de journal

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

    Où MANAGED_SERVICE est le nom de votre service géré, que vous pouvez trouver en interrogeant la ressource API de votre API Gateway.