Surveiller les workflows

Google Cloud Observability fournit des outils de surveillance, de journalisation et de diagnostic. Ces outils peuvent vous aider à surveiller et à analyser les déploiements et les exécutions de workflows, et à comprendre le comportement, l'état et les performances de vos applications.

Par défaut, Workflows est configuré pour effectuer les opérations suivantes :

  • Envoyez les journaux d'audit des données et du système à Cloud Logging. Vous pouvez utiliser les journaux collectés pour déboguer vos applications, résoudre les problèmes et obtenir des insights à leur sujet.
  • Envoyez des métriques système et de ressources à Cloud Monitoring. Vous pouvez utiliser les métriques collectées pour surveiller l'état et les performances, identifier les tendances et les problèmes, et signaler les changements de comportement.

Envoyer des journaux d'audit à Cloud Logging

Workflows envoie les types de données de journaux d'audit suivants à Cloud Logging :

Les journaux d'audit pour l'accès aux données sont désactivés par défaut, car ils peuvent être volumineux. Pour en savoir plus, consultez Activer les journaux d'audit des accès aux données.

Pour en savoir plus sur les journaux d'audit dans Workflows, consultez les ressources suivantes :

Vous pouvez également envoyer les journaux d'exécution à Cloud Logging.

Envoyer des métriques à Cloud Monitoring

Workflows envoie les données de métriques des ressources surveillées à Google Cloud Observability. Dans Monitoring, une ressource surveillée représente une entité logique ou physique, telle qu'une machine virtuelle, une base de données ou une application. Les ressources surveillées contiennent un ensemble unique de métriques qui peuvent être explorées, présentées dans un tableau de bord ou utilisées pour créer des alertes. Chaque ressource dispose également d'un ensemble de libellés de ressources, qui sont des paires clé/valeur contenant des informations supplémentaires sur la ressource. Les libellés de ressources sont disponibles pour toutes les métriques associées à la ressource.

Pour afficher tous les types de ressources, consultez Types de ressources surveillées. Pour afficher tous les types de métriques, consultez MétriquesGoogle Cloud . Développez les éléments suivants pour afficher la liste des types de métriques envoyés par Workflows à Google Cloud Observability :

Types de métriques de workflows

Lire les données de métrique

Vous pouvez lire les données de métriques, également appelées données de séries temporelles, à l'aide de la méthode timeSeries.list dans l'API Cloud Monitoring. Il existe plusieurs façons d'appeler la méthode, y compris en utilisant une bibliothèque cliente spécifique à un langage ou en créant un graphique avec l'Explorateur de métriques.Vous pouvez également essayer la méthode timeSeries.list à l'aide de l'APIs Explorer basé sur des formulaires. Pour obtenir une présentation des métriques et des séries temporelles, consultez Métriques, séries temporelles et ressources. Pour savoir comment lire vos données de métriques, consultez Récupérer des données de séries temporelles.

Surveiller les métriques de quota

L'exemple suivant montre comment utiliser l'APIs Explorer pour interroger le quota d'allocation total consommé pour les workflows. Plus précisément, il utilise la métrique serviceruntime.googleapis.com/quota/allocation/usage sur le type de ressource Consumer Quota. Vous pouvez définir des filtres de libellés supplémentaires (service, quota_metric) pour spécifier le type de quota. Pour savoir comment surveiller les métriques de quota, y compris pour obtenir d'autres exemples et découvrir comment créer des règles d'alerte, consultez Représenter graphiquement et surveiller les métriques de quota.

  1. Ouvrez la page de référence de timeSeries.list.

  2. Si le volet Essayer cette méthode n'est pas visible, cliquez sur Essayer.

  3. Dans le champ name (nom), saisissez l'ID de votre projet Google Cloud au format suivant :

    projects/PROJECT_ID

  4. Dans le champ filter, spécifiez un seul type de métrique et, éventuellement, des libellés de métrique et d'autres informations. Exemple :

    metric.type = "serviceruntime.googleapis.com/quota/allocation/usage" AND resource.labels.service = "workflowexecutions.googleapis.com"

  5. Dans le champ interval.endTime, saisissez une heure de fin pour limiter la quantité de données renvoyées et applicables à votre utilisation. Elle doit être au format RFC 3339, par exemple 2024-11-07T03:01:02Z.

  6. Dans le champ interval.startTime, saisissez une heure de début pour limiter la quantité de données renvoyées et applicables à votre utilisation. Elle doit être au format RFC 3339, par exemple 2024-11-07T03:01:00Z.

  7. Cliquez sur Exécuter.

    Le résultat doit ressembler à ce qui suit, avec 350 indiquant la métrique de quota exécutions simultanées.

    {
"timeSeries": [
   {
      "metric": {
      "labels": {
         "quota_metric": "workflowexecutions.googleapis.com/concurrency"
      },
      "type": "serviceruntime.googleapis.com/quota/allocation/usage"
      },
      "resource": {
      "type": "consumer_quota",
      "labels": {
         "service": "workflowexecutions.googleapis.com",
         "project_id": "PROJECT_ID",
         "location": "europe-west1"
      }
      },
      "metricKind": "GAUGE",
      "valueType": "INT64",
      "points": [
      {
         "interval": {
            "startTime": "2024-11-07T03:01:02Z",
            "endTime": "2024-11-07T03:01:02Z"
         },
         "value": {
            "int64Value": "350"
         }
      }
      ]
   }

  8. Dans le panneau latéral réduit d'APIs Explorer, vous pouvez cliquer sur Plein écran  pour développer APIs Explorer. Le panneau en plein écran affiche un volet supplémentaire contenant des exemples de code, des réponses application/json et des réponses HTTP brutes. Par exemple, dans ce cas, vous pouvez afficher la commande curl comparable :

    curl \
'https://monitoring.googleapis.com/v3/projects/PROJECT_ID/timeSeries?filter=metric.type%20%3D%20%22serviceruntime.googleapis.com%2Fquota%2Fallocation%2Fusage%22%20AND%20resource.labels.service%20%3D%20%22workflowexecutions.googleapis.com%22&interval.endTime=2024-11-07T03%3A01%3A02Z&interval.startTime=2024-11-07T03%3A01%3A00Z&key=YOUR_API_KEY' \
   --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
   --header 'Accept: application/json' \
   --compressed

Utiliser les tableaux de bord et les alertes Monitoring

Les tableaux de bord Monitoring et les graphiques associés vous permettent de visualiser les données des métriques Workflows.

Pour surveiller ces métriques dans Monitoring, vous pouvez créer des tableaux de bord personnalisés. Vous pouvez également ajouter des alertes en fonction de ces métriques.

Étapes suivantes