Utiliser le simulateur de playbook
Le simulateur de playbook permet de développer des playbooks de manière simplifiée, en réduisant le temps et les efforts nécessaires.
Le simulateur de playbook offre plusieurs fonctionnalités clés qui vous permettent de :
- Travaillez dans un environnement de préproduction, ce qui vous permet de tester des actions et d'observer les résultats sans affecter les données de production en direct (en particulier lorsque le playbook est désactivé).
- Facilitez le test de chaque étape ou bloc de playbook individuel pour vérifier que le workflow fonctionne comme prévu.
- Testez toutes les branches de conditions possibles dans votre playbook pour vous assurer d'une couverture complète et d'un comportement prévisible.
Utiliser le simulateur de playbook avec votre playbook
Lorsque vous travaillez avec des playbooks (que vous en utilisiez un existant ou que vous en créiez un), commencez toujours par activer le simulateur de playbook. Un indicateur vert s'affiche en haut de l'écran pour confirmer que la fonctionnalité est active.
Si vous utilisez le simulateur de playbook sur un playbook actif, cela affecte toutes les alertes entrantes qui déclenchent ce playbook. En effet, l'enregistrement d'un playbook avec des données simulées applique ces données aux cas réels en production, ce qui peut potentiellement affecter les résultats réels.
- Pointez sur une alerte de cas, cliquez sur more_vert Options d'alerte, puis sélectionnez Ingérer l'alerte en tant que scénario de test. Cette action crée un scénario de test pour exécuter votre playbook simulé. Les entités modifiées dans les scénarios de test n'ont aucune influence sur les entités dans les cas standards.
- Pointez en bas de la page Playbooks et sélectionnez un cas de test. Assurez-vous que le scénario de test sélectionné correspond au playbook que vous souhaitez exécuter. Pour confirmer, cliquez sur Entités et vérifiez que le playbook est capable de traiter les entités présentes dans ce cas de test.
- Cliquez sur Exécuter. Le simulateur traite les étapes, exécute les actions définies et fournit les résultats.
Interpréter les résultats du simulateur pour chaque étape
Après avoir cliqué sur Exécuter, la première ligne de la console s'affiche comme s'il s'agissait d'un playbook en direct. Chaque étape simulée présente des options, y compris généralement Données du cas, Afficher les résultats et Épingler les résultats (ou Insérer les résultats). Les étapes manuelles affichent un bouton permettant de saisir des paramètres, de fournir des réponses et d'exécuter l'étape.
Données des cas
L'icône Données du dossier ouvre une boîte de dialogue affichant les informations du dossier à cette étape spécifique, une fois l'action en cours terminée. Cette boîte de dialogue est mise à jour de manière dynamique avec les résultats de l'étape en cours. Si une action a enrichi la demande, cela se reflétera ici. Comme il indique l'état de la demande après l'exécution d'une étape, les données varient pour chaque étape de la console de simulation. L'inspection des données d'étude à différentes étapes vous aide à comprendre les modifications appliquées à l'étude lors de l'exécution du playbook. Plusieurs onglets de la boîte de dialogue fournissent des informations supplémentaires.
View Results
L'option Afficher les résultats affiche les résultats d'action spécifiques de l'étape en cours. Les informations présentées sont semblables à une vue d'ensemble ou à un mur de cas. Elles incluent également des détails sur les enrichissements.
Vous pouvez accéder aux types d'informations suivants :
- L'onglet principal affiche le message de sortie, les tableaux, les liens et les pièces jointes.
- L'onglet "Détails techniques" fournit le résultat de l'action et le résultat JSON (le cas échéant).
Comme pour les autres options, vous pouvez cliquer sur les données pour les examiner plus en détail. Sur la page Afficher les résultats, vous pouvez également cliquer sur Définir le résultat JSON. Cette fonctionnalité vous permet de remplacer l'exemple JSON de l'action en cours. Vous pouvez modifier cet exemple JSON directement depuis l'environnement de développement intégré (IDE, Integrated Developer Environment), puis le développer dans le générateur d'expressions pour extraire des données spécifiques du résultat JSON.
Épingler les résultats
L'option Épingler les résultats est disponible lorsqu'une étape s'exécute correctement. Il s'agit d'une fonctionnalité très utile qui vous permet de considérer le résultat d'une action comme fixe.
Épingler des résultats peut vous faire gagner du temps en :
- Vous n'avez plus besoin d'attendre les résultats des services tiers.
- Réduire le nombre de requêtes envoyées à ces services, ce qui permet de préserver les identifiants.
En d'autres termes, lorsque vous réexécutez le playbook, toute étape avec des résultats épinglés est "ignorée" : son code n'est pas exécuté à nouveau et les résultats épinglés sont utilisés tels quels. Vous pouvez également modifier ce résultat en insérant vos propres données fictives. Lorsque vous activez Épingler les résultats, l'action passe en mode simulation et la représentation visuelle de l'étape passe généralement d'un arrière-plan bleu à un arrière-plan gris, ce qui indique clairement que le mode Simuler est actif pour cette étape.
Insérer les résultats
L'option Insérer les résultats devient disponible si une étape a échoué. Cette fonctionnalité vous permet d'insérer manuellement des données de simulation. La prochaine fois que vous exécuterez cette étape spécifique, elle renverra les données que vous avez fournies manuellement comme résultat.
Une fois que vous avez cliqué sur cette option, le mode Simuler est automatiquement activé pour l'action. La représentation visuelle de l'étape passe d'un fond bleu à un fond gris, ce qui indique clairement que le mode Simuler est actif. Le champ Script Result (Résultat du script) est obligatoire pour toutes les étapes en mode Simulate (Simuler).
Insérer des données fictives
Pour insérer des données fictives, vous devez tenir compte de plusieurs cas d'utilisation :
- Créer et tester votre playbook en déplacement : vous pouvez exécuter une étape, afficher les résultats et comprendre immédiatement comment utiliser ces données plus loin dans votre playbook.
- Gagner du temps après une exécution réussie : vous pouvez épingler les résultats de l'étape. Cela vous fait gagner du temps en empêchant l'étape de s'exécuter à plusieurs reprises sur des API tierces lors des tests ultérieurs.
- Tester différents scénarios : vous pouvez modifier les résultats de vos étapes pour tester votre playbook dans différentes conditions. En définissant différentes données de simulation, vous pouvez influencer les conditions et actions ultérieures qui dépendent des résultats précédents. Par exemple, si votre playbook comporte une condition qui se divise en deux chemins ou plus, vous pouvez tester les données de simulation pour "forcer" le playbook à emprunter un chemin spécifique.
Insérer des données de simulation
Vous pouvez insérer des données de simulation (fictives) dans votre playbook de deux manières principales : dans la boîte de dialogue de configuration de l'étape du playbook ou à l'aide de Épingler les résultats (ou Insérer les résultats) après l'exécution d'un simulateur.
Utiliser la boîte de dialogue de configuration des étapes du playbook
- Cliquez sur la boîte de dialogue de configuration de l'étape dans votre playbook.
- Activez le mode Simulation. La représentation visuelle de l'action devient grise, ce qui indique qu'elle est en mode Simulation.
- Dans la section Résultats de l'action, vous pouvez insérer vos données de simulation (fictives). Par exemple :
- Résultat du script : fournissez un résultat fictif pour les actions basées sur un script.
- Résultat JSON : saisissez des données JSON, éventuellement en extrayant des données spécifiques du code JSON. Vous pouvez également charger un exemple de résultat en cliquant sur Charger l'échantillon. Cela charge le résultat JSON attendu de l'action, ce qui est particulièrement utile dans les cas suivants :
- La simulation n'a pas encore été exécutée et la sortie est vide.
- La simulation a échoué et aucun résultat n'est affiché.
- Vous souhaitez remplacer les résultats existants (issus d'un ancrage ou d'une insertion précédente) par l'échantillon.
- Enrichissements : vous pouvez utiliser les enrichissements des simulations précédentes ou créer vos propres clés d'enrichissement personnalisées.
Utiliser les résultats après l'exécution d'un simulateur
Épingler les résultats
Si une étape s'exécute correctement, vous pouvez cliquer sur Épingler les résultats à côté de cette action. Voici ce qui se passe ensuite :
- L'étape s'ouvre automatiquement en mode Simuler. .
- Les résultats de la dernière simulation réussie sont épinglés à l'étape. Vous pouvez utiliser ces résultats ou les modifier.
- Vous pouvez modifier le résultat JSON à l'aide de l'éditeur JSON ou cliquer sur Charger un exemple pour le remplacer.
- Vous pouvez utiliser des enrichissements provenant d'exécutions de simulation précédentes ou créer des clés d'enrichissement personnalisées.
Insérer les résultats
Si une étape a échoué, vous pouvez cliquer sur Insérer les résultats à côté de cette action. Voici ce qui se passe ensuite :
- Ces données seront désormais renvoyées chaque fois que l'étape sera exécutée.
Désactiver le simulateur de playbook
Lorsque vous désactivez le simulateur de playbook, la console en bas de l'écran est masquée et toute étape en mode Simulation repasse en mode "en direct" normal. La seule exception concerne les blocs de playbook. Vous devez désactiver le simulateur de bloc pour fermer son mode simulation. Toutes les données de simulation (fictives) insérées sont enregistrées pour être utilisées la prochaine fois que vous activerez le simulateur.
Utiliser les blocs de playbook
Vous pouvez également utiliser le simulateur de playbook pour créer et tester un bloc de playbook. Lorsqu'un bloc est en mode simulation, tous les playbooks parents qui l'utilisent utilisent également les données fictives du bloc.
Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.