Set-TraceSource

Module:

Microsoft.PowerShell.Utility

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

Syntaxe

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 de commande Set-TraceSource configure, démarre et arrête une trace d’un composant PowerShell. Vous pouvez l’utiliser pour spécifier les composants qui seront suivis et où la sortie de suivi est envoyée.

Exemples

Exemple 1 : Tracer 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 é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 valeurs et au préfixe du 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 utilisateur ou en mode noyau ou dans Microsoft Visual Studio. Ce paramètre sélectionne également l’écouteur de trace par défaut.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	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 trace 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
Alias:	PSPath, Path
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Force

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

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ListenerOption

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

• 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 des indicateurs. Vous pouvez combiner plusieurs valeurs pour définir plusieurs indicateurs à l’aide de ce paramètre. Les valeurs peuvent être transmises au paramètre ListenerOption en tant que tableau de valeurs ou sous forme de 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 sous forme de tabulation sur les valeurs.

Type:	TraceOptions
Valeurs acceptées:	None, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Name

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

Type:	String[]
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	True

-Option

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

• 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 des indicateurs. Vous pouvez combiner plusieurs valeurs pour définir plusieurs indicateurs à l’aide de ce paramètre. Les valeurs peuvent être transmises au paramètre Option en tant que tableau de valeurs ou sous forme de 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 sous forme de tabulation sur les valeurs.

Type:	PSTraceSourceOptions
Valeurs acceptées:	None, Constructor, Dispose, Finalizer, Method, Property, Delegates, Events, Exception, Lock, Error, Errors, Warning, Verbose, WriteLine, Data, Scope, ExecutionFlow, Assert, All
Position:	1
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucune sortie.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	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 trace PSHost.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-RemoveFileListener

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

Type:	String[]
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-RemoveListener

Arrête la trace en supprimant l’écouteur de trace.

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 fichiers, utilisez le paramètre RemoveFileListener.

Type:	String[]
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

String

Vous pouvez diriger une chaîne qui contient un nom pour Set-TraceSource.

Sorties

None or System.Management.Automation.PSTraceSource

Lorsque vous utilisez le paramètre PassThru , génère un objet System.Management.Automation.PSTraceSource représentant la session de trace. Sinon, cette applet de commande ne génère aucune sortie.

Notes

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

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

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

  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 leFilePath, débogueurou paramètres PSHost pour spécifier un écouteur (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 commande Set-TraceSource comme vous le feriez pour démarrer une trace. PowerShell reconnaît que la source de trace est déjà en cours de suivi. Il arrête la trace, ajoute la nouvelle configuration et démarre ou redémarre la trace.

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

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

Liens associés

• Get-TraceSource
• Trace-Command