Configurer la journalisation pour l’étape PowerShell

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture
  • Ajouter des messages de journal aux scripts dans votre étape PowerShell. Utilisez les niveaux de journal pour améliorer la journalisation et le débogage.

    Avant de commencer

    Pour ajouter des messages de journal à votre script, vous devez utiliser la fonction Write-SNCLog . Cette fonction est définie dans le module IH\Logging.psm1. Utilisez PSScript.ps1 pour importer ce module afin que les scripts intégrés aient accès à Write-SNCLog. Pour plus d’informations, consultez Fichiers PowerShell de Serveur MID.

    Rôle requis : administrateur

    Procédure

    1. Accédez à la Tout > Serveur MID > Propriétés.
    2. Définissez la valeur mid.property.powershell.log_infosur vrai.
      Cette propriété active ou désactive la journalisation. Pour plus d’informations, consultez Propriété de journal PowerShell.
    3. Définir mid.property.powershell.ih.log_level sur le niveau de journal souhaité.
      Le niveau de journal spécifie le seuil requis pour consigner un message. Les messages sont consignés au niveau spécifié ou supérieur. Par exemple, si cette propriété est définie sur WARN, les messages avec un niveau WARN ou ERROR sont consignés. Les messages avec un niveau INFO, DEBUG ou TRACE ne sont pas consignés. Les niveaux, classés de faible à élevé, sont les suivants :
      • RETROUVER
      • DÉBOGUER
      • INFOS
      • AVERTIR
      • ERREUR
      La valeur par défaut est INFO.
    4. Facultatif : Configurez une propriété système afin de pouvoir afficher les journaux dans l’instance.
      1. Accédez à la Tout > Automatisation des processus > Concepteur de flux > Propriétés.
      2. Rechercher Spécifiez le niveau de journalisation des entrées du journal système à répliquer dans le journal du flux. Le système réplique uniquement les entrées de journal du niveau spécifié ou supérieur et les définit sur INFO ou DEBUG.

      Une fois que vous avez créé et exécuté le script PowerShell, les journaux sont disponibles dans le journal de l’agent MID. La configuration de cette propriété vous permet également de les afficher directement dans l’instance.

      Cette étape définit la com.glide.hub.flow_engine.listener_trace.threshold propriété. Il réplique les journaux dans la table des entrées de journal du moteur de flux [sys_flow_log].

    5. Dans votre script PowerShell, ajoutez des messages de journal et des niveaux à l’aide de la fonction Write-SNCLog .
      Tableau 1. Fonction et paramètres write-SNCLog
      Nom Description
      Fonction Write-SNCLog Consignez un message pour l’étape PowerShell. Write-SNCLog a deux paramètres, -Level et -Message. Les deux paramètres sont obligatoires, mais pas les noms de paramètres. Si les noms sont omis, la position est utilisée pour déterminer le niveau et le message. Exemples :
      • Write-SNCLog -Level WARN -Message « log warning »
      • Write-SNCLog WARN « Avertissement de journal »
      Ces deux exemples consignent WARN : consignent l’avertissement.
      -Level paramètre Spécifiez le niveau du message du journal. Les valeurs valides sont :
      • ERREUR
      • AVERTIR
      • INFOS
      • DÉBOGUER
      • RETROUVER
      Ce paramètre est obligatoire.
      -Message paramètre Spécifiez le message à journaliser. Saisi sous forme de chaîne. Ce paramètre est obligatoire.
    6. Continuez à créer votre action ou votre flux, puis testez-le et exécutez-le.

    Que faire ensuite

    Les nouveaux journaux sont disponibles dans le journal de l’agent MID et peuvent être téléchargés à partir du serveur MID. Pour plus d’informations, consultez Télécharger les fichiers du Serveur MID.

    Si vous définissez la propriété système pour afficher les journaux dans l’instance, vous pouvez les voir dans l’onglet Entrées de journal du moteur de flux de l’enregistrement contextuel du moteur de flux. Pour plus d’informations, consultez Détails d’exécution du flux.