Utiliser les journaux de la plate-forme

Cette page explique comment afficher les journaux de plate-forme générés par SaaS Runtime. 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 services Google Cloudque vous utilisez.

Pour en savoir plus sur les journaux de plate-forme de l'environnement d'exécution SaaS compatibles, consultez Google Cloud  Journaux de plate-forme. Pour en savoir plus sur les données des tables de journaux de plate-forme, consultez Structure des entrées de journal.

Avant de commencer

  1. Dans la console Google Cloud , sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud .
  2. Assurez-vous que la facturation est activée pour votre projet Google Cloud .
  3. Activez l'API SaaS Runtime.
  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 IAM (Identity and Access Management) suivants sur 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 devez créer une requête dans l'explorateur de journaux qui renvoie les entrées de journal pour lesquelles vous souhaitez recevoir une alerte, puis configurer la règle d'alerte.

  1. Dans la console Google Cloud , 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 sélectionnées. Pour obtenir des exemples de requêtes, consultez les sections suivantes.

  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 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 les scénarios d'alerte courants basés sur les journaux de la plate-forme SaaS Runtime.

Alertes sur les opérations SaaS

Pour créer une alerte en cas d'échec d'une opération de provisionnement d'unité, 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

Pour créer une alerte si un déploiement régional passe à l'état PAUSED ou FAILED pour une raison autre qu'une action de l'utilisateur, utilisez la requête suivante :

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.RolloutLog"
AND (jsonPayload.current_state="PAUSED" OR jsonPayload.current_state="FAILED")
AND jsonPayload.reason!="USER_PAUSE"
AND jsonPayload.root_rollout_id != resource.labels.rollout_id

Pour créer une alerte si un déploiement mondial passe à l'état PAUSED ou FAILED, utilisez la requête suivante :

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.RolloutLog"
AND (jsonPayload.current_state="PAUSED" OR jsonPayload.current_state="FAILED")
AND jsonPayload.root_rollout_id == resource.labels.rollout_id

Pour créer une alerte de journal lorsqu'un déploiement passe à l'état PAUSED (car SaaS Runtime a identifié le déploiement comme non opérationnel) ou à l'état FAILED, utilisez la requête suivante :

logName:"rollout_events" 
(jsonPayload.currentState="PAUSED" jsonPayload.reason="SYSTEM_PAUSE")
OR 
jsonPayload.currentState="FAILED

Pour créer une alerte de journal pour les métriques d'état de déploiement lorsqu'un déploiement passe à l'état PAUSED (car SaaS Runtime a identifié le déploiement 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"}

Étapes suivantes