Configure, démarre et arrête une trace des composants Windows PowerShell.
Syntaxe
Set-TraceSource [[-Option] {<None> | <Constructor> | <Dispose> | <Finalizer> | <Method> | <Property> | <Delegates> | <Events> | <Exception> | <Lock> | <Error> | <Errors> | <Warning> | <Verbose> | <WriteLine> | <Data> | <Scope> | <ExecutionFlow> | <Assert> | <All>}] [-Debugger] [-FilePath <string>] [-Force] [-ListenerOption {<None> | <LogicalOperationStack> | <DateTime> | <Timestamp> | <ProcessId> | <ThreadId> | <Callstack>}] [-PassThru] [-PSHost] [-Name] <string[]> [<CommonParameters>]
Set-TraceSource [-RemoveListener <string[]>] [-Name] <string[]> [<CommonParameters>]
Set-TraceSource [-RemoveFileListener <string[]>] [-Name] <string[]> [<CommonParameters>]
Description
L'applet de commande Set-TraceSource configure, démarre et arrête une trace d'un composant Windows PowerShell. Vous pouvez l'utiliser pour spécifier quels composants seront tracés et où la sortie de traçage sera envoyée.
Paramètres
-Debugger
Envoie la sortie de la trace au débogueur. Vous pouvez consulter la sortie dans tout débogueur en mode noyau ou en mode utilisateur, ou dans Microsoft Visual Studio. Ce paramètre sélectionne également l'écouteur de la trace par défaut.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-FilePath <string>
Envoie la sortie de la trace au fichier spécifié. Ce paramètre sélectionne également l'écouteur de la trace de fichiers. Si vous utilisez ce paramètre pour démarrer la trace, utilisez le paramètre RemoveFileListener pour arrêter la trace.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Force
Permet à l'applet de commande de remplacer un fichier en lecture seule. Utilisez ce paramètre avec le paramètre FilePath.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-ListenerOption <TraceOptions>
Ajoute des données facultatives au préfixe de chaque message de trace dans la sortie. Les valeurs valides sont « None », « LogicalOperationStack », « DateTime », « Timestamp », « ProcessId », « ThreadId » et « Callstack ». « None » est la valeur par défaut.
Pour spécifier plusieurs options, séparez-les avec des virgules, mais sans espaces, et mettez-les entre guillemets, par exemple « ProcessID,ThreadID ».
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Name <string[]>
Détermine quels composants sont tracés. Entrez le nom de la source de trace de chaque composant. Les caractères génériques sont autorisés.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByValue, ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Option <PSTraceSourceOptions>
Détermine le type des événements qui sont tracés.
Les valeurs valides sont les suivantes : « None », « Constructor », « Dispose », « Finalizer », « Method », « Property », « Delegates », « Events », « Exception », « Lock », « Error », « Errors », « Warning », « Verbose », « WriteLine », « Data », « Scope », « ExecutionFlow », « Assert » et « All ». « All » est la valeur par défaut.
Les valeurs suivantes sont des combinaisons d'autres valeurs :
-- ExecutionFlow : (Constructor, Dispose, Finalizer, Method, Delegates, Events et Scope)
-- Data : (Constructor, Dispose, Finalizer, Property, Verbose et WriteLine)
-- Errors : (Error et Exception).
Pour spécifier plusieurs options, séparez-les avec des virgules, mais sans espaces, et mettez-les entre guillemets, par exemple « Constructor,Dispose ».
|
Obligatoire ? |
false |
|
Position ? |
2 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-PassThru
Retourne un objet représentant la session de trace. Par défaut, cette applet de commande ne génère aucune sortie.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-PSHost
Envoie la sortie de la trace à l'hôte Windows PowerShell. Ce paramètre sélectionne également l'écouteur de la trace par PSHost.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-RemoveFileListener <string[]>
Arrête la trace en supprimant l'écouteur de la trace de fichiers associé au fichier spécifié. Entrez le chemin d'accès et le nom de fichier du fichier de sortie de la trace.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-RemoveListener <string[]>
Arrête la trace en supprimant l'écouteur de la 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 la trace de fichiers, utilisez le paramètre RemoveFileListener.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.String Vous pouvez diriger une chaîne contenant un nom vers Set-TraceSource. |
|
Sorties |
Aucun ou System.Management.Automation.PSTraceSource Lorsque vous utilisez le paramètre PassThru, Set-TraceSource 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. |
Remarques
Le traçage est une méthode que les développeurs utilisent pour déboguer et affiner des programmes. Lors du traçage, le programme génère des messages détaillés à propos de chaque étape de son traitement interne.
Les applets de commande de traçage Windows PowerShell sont conçues pour aider les développeurs Windows PowerShell, mais sont disponible pour tous les utilisateurs. Elles vous permettent de surveiller presque chaque aspect des fonctionnalités de Windows PowerShell.
Une « source de trace » est la partie de chaque composant Windows 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 la trace » reçoit la sortie de la trace et l'affiche pour l'utilisateur. Vous pouvez choisir d'envoyer les données de trace à un débogueur en mode noyau ou en mode utilisateur, à 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 (le composant à tracer) 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 qui sont tracés et le paramètre ListenerOptions pour configurer la sortie de la trace.
Pour modifier la configuration d'une trace, entrez une commande Set-TraceSource comme pour démarrer une trace. Windows PowerShell reconnaît que la source de trace est déjà tracée. 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 fichier (une trace démarrée en utilisant le 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 tracés, 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.
Exemple 1
C:\PS>Set-TraceSource -Name Parameterbinding -Option ExecutionFlow -PSHost ' -ListenerOption "ProcessID,TimeStamp" Description ----------- Cette commande commence à tracer pour le composant ParameterBinding de Windows PowerShell. Elle utilise le paramètre Name pour spécifier la source de trace, le paramètre Option pour sélectionner les événements de la trace ExecutionFlow et le paramètre PSHost pour sélectionner l'écouteur d'hôte Windows PowerShell qui envoie la sortie à la console. Le paramètre ListenerOption ajoute les valeurs « ProcessID » et « TimeStamp » au préfixe de message de trace.
Exemple 2
C:\PS>set-tracesource -name ParameterBinding -RemoveListener Host Description ----------- Cette commande arrête la trace du composant ParameterBinding de Windows PowerShell. Elle utilise le paramètre Name pour identifier le composant qui était tracé et le paramètre RemoveListener pour identifier l'écouteur de la trace.
Voir aussi