Journaux Endpoints

Lorsque des utilisateurs adressent des requêtes à votre API, Extensible Service Proxy (ESP) utilise Cloud Logging pour enregistrer des informations sur ces requêtes et sur les réponses renvoyées. Cette page décrit les informations ainsi consignées.

Pour localiser les journaux Cloud Endpoints sur la page de la visionneuse de journaux :

  1. Dans Google Cloud Console, accédez à la page Stackdriver > Logging :

    Accéder à la page Visionneuse de journaux

  2. Sélectionnez API produite, SERVICE_NAME, où SERVICE_NAME est le nom du service Endpoints.

  3. Cliquez sur le journal que vous souhaitez examiner. Ce journal contient un message JSON structuré comme suit :

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

L'objet jsonPayload contient toutes les informations transmises par ESP. Le tableau suivant décrit les champs de cet objet :

Champ Description
url Chemin de l'URL de la requête.
producer_project_id ID du projet Google Cloud propriétaire de l'API.
api_name Nom de l'API appelée.
api_version Version de l'API appelée.
api_method Méthode de l'API appelée.
api_key Clé API utilisée par le client appelant, le cas échéant.
http_method Méthode HTTP de la requête, telle que GET et POST.
request_size_in_bytes Taille du corps de la requête en octets.
http_response_code Code d'état HTTP de la réponse, tel que 200, 404 et 500.
response_size_in_bytes Taille du corps de la réponse en octets.
request_latency_in_ms Délai de réponse à la requête en millisecondes, y compris le temps pris par ESP et son backend. Champ non fourni pour les méthodes de traitement par flux.
timestamp Horodatage de l'arrivée de la requête.
location Zone Google Cloud dans laquelle la requête a été traitée.
log_message Message court sur la méthode appelée et sur son état en cas de rejet. Aucun des champs d'information relatifs à l'API n'est enregistré pour les appels rejetés.
error_cause Message d'erreur si la réponse était une erreur.
labels La section labels contient des informations qui identifient cette source du journal, telles que l'ID de projet Google Cloud, le nom du service Endpoints, le numéro de version de l'API et le nom de la méthode.

Étapes suivantes