Partager via

Set-TraceSource

  • Référence
Module:
Microsoft.PowerShell.Utility

Configure, démarre et arrête une trace des composants PowerShell.

Syntax

Set-TraceSource
   [-Name] <String[]>
   [[-Option] <PSTraceSourceOptions>]
   [-ListenerOption <TraceOptions>]
   [-FilePath <String>]
   [-Force]
   [-Debugger]
   [-PSHost]
   [-PassThru]
   [<CommonParameters>]
Set-TraceSource
   [-Name] <String[]>
   [-RemoveListener <String[]>]
   [<CommonParameters>]
Set-TraceSource
   [-Name] <String[]>
   [-RemoveFileListener <String[]>]
   [<CommonParameters>]

Description

L’applet Set-TraceSource de commande configure, démarre et arrête une trace d’un composant PowerShell. Vous pouvez l'utiliser pour spécifier quels composants seront tracés et où la sortie du suivi est envoyée.

Exemples

Exemple 1 : Suivre le composant ParameterBinding

Set-TraceSource -Name "ParameterBinding" -Option ExecutionFlow -PSHost -ListenerOption "ProcessId,TimeStamp"

Cette commande démarre le suivi pour le composant ParameterBinding de PowerShell. Il utilise le paramètre Name pour spécifier la source de trace, le paramètre Option pour sélectionner les ExecutionFlow événements de trace et le paramètre PSHost pour sélectionner l’écouteur hôte PowerShell, qui envoie la sortie à la console. Le paramètre ListenerOption ajoute les ProcessID valeurs et TimeStamp au préfixe de message de trace.

Exemple 2 : Arrêter une trace

Set-TraceSource -Name "ParameterBinding" -RemoveListener "Host"

Cette commande arrête la trace du composant ParameterBinding de PowerShell. Il utilise le paramètre Name pour identifier le composant qui a été suivi et le paramètre RemoveListener pour identifier l’écouteur de trace.

Paramètres

-Debugger

Indique que l’applet de commande envoie la sortie de trace au débogueur. Vous pouvez afficher la sortie dans n'importe quel débogueur en mode noyau ou en mode utilisateur, ou bien dans Microsoft Visual Studio. Ce paramètre sélectionne également l'écouteur de suivi par défaut.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FilePath

Spécifie un fichier auquel cette applet de commande envoie la sortie de trace. Ce paramètre sélectionne également l'écouteur de suivi de fichier. Si vous utilisez ce paramètre pour démarrer la trace, utilisez le paramètre RemoveFileListener pour arrêter la trace.

Type:String
Aliases:PSPath, Path
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indique que l’applet de commande remplace un fichier en lecture seule. Utilisez avec le paramètre FilePath .

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ListenerOption

Spécifie les données facultatives dans le préfixe de chaque message de trace dans la sortie. Les valeurs valides pour ce paramètre sont :

  • None
  • LogicalOperationStack
  • DateTime
  • Timestamp
  • ProcessId
  • ThreadId
  • Callstack

None est la valeur par défaut.

Ces valeurs sont définies comme une énumération basée sur un indicateur. Vous pouvez combiner plusieurs valeurs pour définir plusieurs indicateurs à l’aide de ce paramètre. Les valeurs peuvent être passées au paramètre ListenerOption sous la forme d’un tableau de valeurs ou d’une chaîne séparée par des virgules de ces valeurs. L’applet de commande combine les valeurs à l’aide d’une opération binary-OR. La transmission de valeurs en tant que tableau est l’option la plus simple et vous permet également d’utiliser la saisie semi-automatique par tabulation sur les valeurs.

Type:TraceOptions
Accepted values:None, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Spécifie les composants qui sont suivis. Entrez le nom de la source de suivi de chaque composant. Les caractères génériques sont autorisés.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Option

Spécifie le type d’événements suivis. Les valeurs valides pour ce paramètre sont :

  • None
  • Constructor
  • Dispose
  • Finalizer
  • Method
  • Property
  • Delegates
  • Events
  • Exception
  • Lock
  • Error
  • Errors
  • Warning
  • Verbose
  • WriteLine
  • Data
  • Scope
  • ExecutionFlow
  • Assert
  • All

All est la valeur par défaut.

Les valeurs suivantes sont des combinaisons d'autres valeurs :

  • ExecutionFlow: Constructor, Dispose, Finalizer, Method, Delegates, Events, Scope
  • Data: Constructor, Dispose, Finalizer, Property, Verbose, WriteLine
  • Errors: Error, Exception

Ces valeurs sont définies comme une énumération basée sur un indicateur. Vous pouvez combiner plusieurs valeurs pour définir plusieurs indicateurs à l’aide de ce paramètre. Les valeurs peuvent être passées au paramètre Option sous la forme d’un tableau de valeurs ou d’une chaîne séparée par des virgules de ces valeurs. L’applet de commande combine les valeurs à l’aide d’une opération binary-OR. La transmission de valeurs en tant que tableau est l’option la plus simple et vous permet également d’utiliser la saisie semi-automatique par tabulation sur les valeurs.

Type:PSTraceSourceOptions
Accepted values:None, Constructor, Dispose, Finalizer, Method, Property, Delegates, Events, Exception, Lock, Error, Errors, Warning, Verbose, WriteLine, Data, Scope, ExecutionFlow, Assert, All
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Retourne un objet représentant l’élément que vous utilisez. Par défaut, cette applet de commande ne génère aucun résultat.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PSHost

Indique que cette applet de commande envoie la sortie de trace à l’hôte PowerShell. Ce paramètre sélectionne également l'écouteur de suivi de PSHost.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveFileListener

Arrête le suivi en supprimant l'écouteur de suivi de fichier associé au fichier spécifié. Entrez le chemin d'accès et le nom du fichier de sortie du suivi.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveListener

Arrête le suivi en supprimant l'écouteur de suivi.

Utilisez les valeurs suivantes avec RemoveListener :

  • Pour supprimer PSHost (console), tapez Host.
  • Pour supprimer le débogueur, tapez Debug.
  • Pour supprimer tous les écouteurs de trace, tapez *.

Pour supprimer l’écouteur de trace de fichier, utilisez le paramètre RemoveFileListener .

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

String

Vous pouvez diriger une chaîne qui contient un nom vers cette applet de commande.

Sorties

None

Par défaut, cette applet de commande ne retourne aucune sortie.

PSTraceSource

Lorsque vous utilisez le paramètre PassThru , cette applet de commande renvoie un objet PSTraceSource représentant la session de trace.

Notes

  • Le suivi est une méthode que les développeurs utilisent pour déboguer et affiner les programmes. Pendant le suivi, le programme génère des messages détaillés sur chaque étape du traitement interne.

    Les applets de commande de suivi PowerShell sont conçues pour aider les développeurs PowerShell, mais elles sont disponibles pour tous les utilisateurs. Ils vous permettent de surveiller presque tous les aspects des fonctionnalités de PowerShell.

    Une source de trace est la partie de chaque composant PowerShell qui gère le suivi et génère des messages de trace pour le composant. Pour suivre un composant, vous identifiez sa source de suivi.

    Un écouteur de trace reçoit la sortie de la trace et l’affiche à l’utilisateur. Vous pouvez choisir d’envoyer les données de trace à un débogueur en mode utilisateur ou en mode noyau, à la console, à un fichier ou à un écouteur personnalisé dérivé de la classe System.Diagnostics.TraceListener .

  • Pour démarrer une trace, utilisez le paramètre Name pour spécifier une source de trace et les paramètres FilePath, Debugger ou PSHost pour spécifier un écouteur (une destination pour la sortie). Utilisez le paramètre Options pour déterminer les types d’événements suivis et le paramètre ListenerOption pour configurer la sortie de trace.

  • Pour modifier la configuration d’une trace, entrez une Set-TraceSource commande comme vous le feriez pour démarrer une trace. PowerShell reconnaît que la source de trace est déjà en cours de traçage. Elle arrête le suivi, ajoute la nouvelle configuration, puis démarre ou redémarre le suivi.

  • Pour arrêter une trace, utilisez le paramètre RemoveListener . Pour arrêter une trace qui utilise l’écouteur de fichier (trace démarrée à l’aide du paramètre FilePath ), utilisez le paramètre RemoveFileListener . Quand vous supprimez l'écouteur, le suivi s'arrête.

  • Pour déterminer les composants qui peuvent être suivis, utilisez Get-TraceSource. Les sources de trace pour chaque module sont chargées automatiquement lorsque le composant est en cours d’utilisation et apparaissent dans la sortie de Get-TraceSource.