Utiliser les journaux de la plate-forme

Cette page explique comment afficher les journaux de plate-forme générés par App Lifecycle Manager. Les journaux de plate-forme dans Google Cloud sont des journaux spécifiques aux services. Vous pouvez les utiliser pour déboguer et résoudre les problèmes, et mieux comprendre les Google Cloud services que vous utilisez.

Pour en savoir plus sur les journaux de plate-forme App Lifecycle Manager compatibles, consultez la page Google Cloud Journaux de plate-forme. Pour en savoir plus sur la compréhension des données dans les tables de journaux de plate-forme, consultez la page Structure des entrées de journal.

Avant de commencer

  1. Dans la Google Cloud console, sur la page de sélection du projet, sélectionnez ou créez un Google Cloud projet.
  2. Assurez-vous que la facturation est activée pour votre Google Cloud projet.
  3. Activez l'API App Lifecycle Manager.
  4. Pour obtenir les autorisations nécessaires pour afficher les journaux et créer des alertes, demandez à votre administrateur de vous accorder les rôles Identity and Access Management (IAM) suivants dans votre projet :
    • Visionneuse de journaux (roles/logging.viewer)
    • Éditeur Monitoring (roles/monitoring.editor)

Créer des alertes basées sur les journaux

Pour créer une alerte basée sur les journaux, vous créez une requête dans l'explorateur de journaux qui renvoie les entrées de journal pour lesquelles vous souhaitez être alerté, puis vous configurez la règle d'alerte.

  1. Dans la Google Cloud console, accédez à la page Explorateur de journaux.

    Accéder à l'explorateur de journaux

  2. Dans l'éditeur de requête, saisissez une requête pour filtrer les entrées de journal choisies. Consultez les sections suivantes pour obtenir des exemples de requêtes.

  3. Cliquez sur Créer une alerte.

  4. Saisissez un nom et une description pour la règle d'alerte.

  5. Configurez les détails de l'alerte, y compris les canaux de notification.

  6. Cliquez sur Enregistrer l'alerte.

Pour obtenir des instructions détaillées, consultez la page Créer une alerte basée sur les journaux.

Exemples de requêtes pour les journaux de plate-forme

Cette section fournit des exemples de requêtes pour des scénarios d'alerte courants basés sur les journaux de plate-forme App Lifecycle Manager.

Alertes d'opérations SaaS

Pour créer une alerte lorsqu'une opération de provisionnement d'unité échoue, utilisez la requête suivante :

protoPayload.methodName="google.cloud.saasplatform.saasservicemgmt.v1beta1.SaasDeployments.CreateUnitOperation"
protoPayload.response.state="UNIT_OPERATION_STATE_FAILED"

Pour créer une alerte lorsqu'une opération de provisionnement d'unité atteint un état final (réussie, échouée ou annulée), utilisez la requête suivante :

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.UnitOperationLog"
AND (jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_SUCCEEDED" OR jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_FAILED" OR jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_CANCELLED")
AND jsonPayload.unit_operation_type="PROVISION"

Alertes de déploiement progressif

Pour créer une alerte de journal lorsqu'un déploiement progressif passe à l'état PAUSED (car App Lifecycle Manager a identifié le déploiement progressif comme étant défectueux) ou à l'état FAILED, utilisez la requête suivante :

resource.type = "saasservicemgmt.googleapis.com/Rollout"
(jsonPayload.currentState = "PAUSED" AND jsonPayload.reason = "SYSTEM_PAUSE")
  OR
jsonPayload.currentState = "FAILED"

Pour créer une alerte de métrique pour les métriques d'état de déploiement progressif lorsqu'un déploiement progressif passe à l'état PAUSED (car App Lifecycle Manager a identifié le déploiement progressif comme étant défectueux) ou à l'état FAILED, utilisez la requête suivante :

saasservicemgmt_googleapis_com:rollout_state
{state_name="PAUSED", reason="SYSTEM_PAUSE"}
OR
saasservicemgmt_googleapis_com:rollout_state{state_name="FAILED"}

Étape suivante