Journaux d'Apigee Integration

Annonce : Application Integration est désormais disponible pour votre projet Google Cloud. Vous pouvez désormais utiliser Apigee Integration et Application Integration dans le même projet Google Cloud. En savoir plus

Apigee Integration génère des messages de journal à chaque exécution d'une intégration. Les messages de journal contiennent des informations qui peuvent être utiles pour déterminer l'état de chaque étape d'une intégration ou pour résoudre les problèmes liés à une intégration, une tâche ou un événement ayant échoué. Pour en savoir plus sur la journalisation dans Apigee Integration, consultez la section Présentation des journaux.

Remarque : Apigee Integration conserve les journaux d'exécution d'une intégration pendant une période maximale de 32 jours.

Afficher les journaux d'exécution d'intégration

Pour afficher la page Journaux d'exécution, sélectionnez l'une des options suivantes :

Console

1. Dans Application Integration, accédez à la page Journaux.

   Accéder aux journaux Application Integration

2. Dans le menu de navigation, cliquez sur Journaux. Vous pouvez également cliquer sur Intégration dans le menu de navigation, puis sélectionner l'intégration pour laquelle vous souhaitez afficher les journaux. Cliquez ensuite sur Afficher les journaux d'exécution pour cette intégration. La page Journaux d'exécution s'affiche.
   Remarque : Si la taille des journaux d'exécution est supérieure à 300 Mo, Apigee Integration génère l'erreur Response size too large et les journaux ne se chargent pas sur la page Journaux d'exécution. Dans ce cas, utilisez la méthode projects.locations.integrations.executions.list comme expliqué dans l'onglet "API".
3. Dans la liste Région, sélectionnez la région pour afficher les journaux d'exécution spécifiques à la région de l'intégration. Vous pouvez également cliquer sur Actualiser les journaux pour actualiser la liste des journaux actuels.

   L'image suivante montre un exemple de page Journaux d'exécution d'intégration d'Apigee.

   

   Les attributs suivants s'affichent pour chaque message de journal d'exécution.

   • Nom de l'intégration : nom de l'intégration.
   • ID d'exécution : identifiant unique généré à chaque exécution d'une intégration.
   • État : état de l'exécution de l'intégration.
     • En cours : indique que l'intégration est actuellement en cours d'exécution.
     • Succeeded (Réussite) : Indique que l'intégration a bien été exécutée.
     • Failed (Échec) : Indique que l'exécution de l'intégration a échoué.
     • Canceled (Annulation) : Indique que l'exécution de l'intégration a été annulée par l'utilisateur.
     • On hold (En attente) : indique que l'exécution de l'intégration est temporairement mise en pause et qu'un événement ou une action est en attente.
     • Retry on hold (Nouvelle tentative en attente) : indique que l'exécution de l'intégration a échoué et qu'une nouvelle tentative est en attente.
     • Suspended (Suspendue) : indique que l'exécution de l'intégration est temporairement mise en pause et nécessite une intervention manuelle pour reprendre.
   • Start time (Heure de début) : horodatage du début d'exécution de l'intégration.
   • Duration (Durée) : temps nécessaire à l'exécution de l'intégration.
     Remarque : N'utilisez pas la valeur Durée pour calculer la latence d'exécution de bout en bout d'une intégration. L'heure affichée dans la colonne Durée ne reflète pas le temps total d'exécution d'une intégration, car elle ne tient pas compte du temps supplémentaire nécessaire à l'intégration avant ou après son exécution. Par exemple, le temps nécessaire à l'application des quotas ou à l'authentification n'est pas reflété dans la valeur Durée.
   • Version d'intégration : version de l'intégration exécutée.
   • ID du déclencheur : valeur de l'ID du déclencheur.
   • Cloud Logging : indique si l'intégration est configurée pour se connecter à Cloud Logging. Si Cloud Logging est activé, ce champ fournit un lien pour afficher les journaux dans Cloud Logging. Si Cloud Logging n'est pas activé, ce champ est défini sur Désactivé.

4. Dans le champ Filtre, ajoutez des filtres. Vous pouvez filtrer les journaux en fonction de critères tels que le nom d'intégration, l'ID d'exécution, la date ou la période, l'état d'exécution, le type de variable et le nom ou la valeur de la variable. Pour une recherche plus personnalisée, utilisez la méthode projects.locations.integrations.executions.list comme expliqué dans l'onglet "API".

API

Si la taille des journaux d'exécution est supérieure à 300 Mo, Apigee Integration génère l'erreur Response too large error et les journaux ne se chargent pas sur la page Journaux d'exécution. Dans ce cas, vous devez utiliser la méthode projects.locations.integrations.executions.list pour obtenir les journaux. Pour afficher les journaux à l'aide de la méthode d'API, procédez comme suit :

1. Pour obtenir l'ID d'exécution pour lequel vous souhaitez afficher les journaux d'exécution, créez une requête GET à l'aide de la méthode projects.locations.integrations.executions.list, avec le paramètre snapshotMetadataWithoutParams défini sur TRUE :

   curl -v -X -G GET
       -H "Content-Type: application/json"
       -H "Authorization: Bearer $(gcloud auth print-access-token)"
       -d 'snapshotMetadataWithoutParams=true'
       'https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/INTEGRATION_NAME/executions'
   

   Les ID d'exécution sont renvoyés dans la réponse. Copiez l'ID d'exécution pour lequel vous souhaitez afficher les journaux.

2. Pour obtenir le journal d'exécution correspondant à l'ID d'exécution, créez une requête POST à l'aide de la méthode projects.locations.integrations.executions.list, avec un filtre sur l'ID d'exécution que vous avez copié à l'étape précédente :

   curl -v -X -G GET 
       -H "Content-Type: application/json"
       -H "Authorization: Bearer $(gcloud auth print-access-token)"
       -d 'filter=execution_id="EXECUTION_ID"'
       'https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/INTEGRATION_NAME/executions'
   

   Dans la réponse, consultez le champ ExecutionDetails pour afficher les détails du journal.

   Sinon, dans la console Google Cloud, vous pouvez filtrer les journaux d'exécution par ID d'exécution.

Exemple : Filtrer les journaux

Si vous souhaitez filtrer la réponse pour lister les journaux de toutes les intégrations attendues pour une intégration, utilisez le format suivant :

curl -v -X -G GET 
    -H "Content-Type: application/json"
    -H "Authorization: Bearer $(gcloud auth print-access-token)"
    -d 'filter= workflowName!="INTEGRATION_NAME"'
    'https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-/executions'

Résoudre les problèmes à l'aide des journaux

La section suivante explique comment résoudre les échecs à l'aide du journal d'exécution d'Apigee Integration.

Résoudre les échecs d'intégration

Les messages de journal d'exécution peuvent être utiles pour résoudre les problèmes d'exécution d'une intégration ayant échoué.

Par exemple, si une intégration ne s'est pas exécutée pendant une période spécifique, procédez comme suit pour accéder aux journaux et les filtrer afin de résoudre le problème :

1. Recherchez ou sélectionnez l'intégration à diagnostiquer dans la liste Intégrations, puis cliquez pour ouvrir l'éditeur d'intégrations.
2. Cliquez sur Journaux dans la barre d'outils de l'éditeur d'intégrations pour afficher les messages de journal.
3. Cliquez sur Ajouter un filtre pour afficher la liste des filtres disponibles.
4. Sélectionnez Nom de l'intégration.
5. Saisissez le nom de l'intégration, puis cliquez sur Appliquer.
6. Cliquez sur Ajouter un filtre pour afficher la liste des filtres disponibles.
7. Sélectionnez État d'exécution pour afficher la liste des états.
8. Cochez la case ÉCHEC, puis cliquez sur Appliquer pour afficher les intégrations ayant échoué.
9. Cliquez sur Ajouter un filtre pour afficher la liste des filtres disponibles.
10. Sélectionnez Plage de dates/heures et saisissez la période souhaitée pour vérifier l'échec. Par exemple, saisissez :
    • From Date (Date de début) : sélectionnez 2020-12-16.
    • From Time (Heure de début) : sélectionnez 04:00:00 PM.
    • To Date (Date de fin) : sélectionnez 2019-12-16.
    • To Time (Heure de fin) : sélectionnez 05:00:00 PM.
    Plusieurs filtres sont combinés par défaut à l'aide de la condition AND (ET).
    • Cliquez sur Appliquer.

Si l'intégration a échoué pendant la période filtrée, la page Journaux d'exécution affiche la liste des messages du journal. Chaque message de journal correspond à une exécution d'intégration spécifique qui a échoué.

Afficher les exceptions de trace de pile

Pour afficher la liste des exceptions, cliquez sur un message de journal. Cliquez sur les liens dans chaque message d'exception pour afficher la trace de la pile complète de l'exception.

Remarque : Les paramètres d'événement du message du journal d'exécution (chaîne ou JSON) sont tronqués avec une limite de 2 000 caractères.

Suivre les échecs liés aux connecteurs

Vous pouvez utiliser les messages du journal d'exécution pour résoudre et suivre les problèmes d'exécution des tâches de connecteurs ayant échoué. Les données de journalisation d'une tâche de connecteur ayant échoué sont stockées à l'aide de Cloud Logging et peuvent être affichées dans l'explorateur de journaux.

Remarque : Les données de journal d'une tâche de connecteur ayant échoué ne sont disponibles dans l'explorateur de journaux que si Cloud Logging est activé pour la connexion correspondante dans Integration Connectors. Pour en savoir plus, consultez la section Afficher les journaux de connecteur.

Pour accéder aux données de journaux d'une tâche de connecteur ayant échoué à partir d'Apigee Integration, procédez comme suit :

1. Accédez à la page Journaux d'exécution de l'intégration souhaitée.
2. Développez le message de journal correspondant à votre exécution ayant échoué, et utilisez la trace de la pile pour accéder à la ligne contenant la tâche de connecteur ayant échoué.
3. Dans la colonne État, cliquez sur Échec.

   

Apigee Integration exécute automatiquement la requête requise pour la tâche de connecteurs ayant échoué et ouvre la page de l'explorateur de journaux pour afficher les données détaillées du journal d'exécution.

Pour récupérer manuellement les données de journal d'une tâche de connecteur ayant échoué, vous pouvez exécuter la requête suivante sur la page de requête de l'explorateur de journaux. Pour en savoir plus sur l'utilisation de l'explorateur de journaux, consultez la page Interface de l'explorateur de journaux.

Format de requête

resource.type="connectors.googleapis.com/Connection"
jsonPayload.integration_connectors_trace_id="EXECUTION_ID_EXECUTION_TASK_ID_EXECUTION_ATTEMPT_NUMBER"

Exemple

resource.type="connectors.googleapis.com/Connection"
jsonPayload.integration_connectors_trace_id="9db51e4b-7d57-473d-931f-cc27b282dfad_1_2"

Limite

• Si la journalisation locale est désactivée pour une intégration, les journaux d'exécution ne sont pas générés pour cette intégration.

Étapes suivantes

• Consultez la section Présentation des journaux pour obtenir davantage d'informations sur les journaux dans Apigee Integration.