Set-TraceSource
PowerShell コンポーネントのトレースを構成、開始、停止します。
構文
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>]
説明
コマンドレットは Set-TraceSource
、PowerShell コンポーネントのトレースを構成、開始、停止します。 これを使用して、トレースするコンポーネントと、トレース出力の送信先を指定できます。
例
例 1: ParameterBinding コンポーネントをトレースする
Set-TraceSource -Name "ParameterBinding" -Option ExecutionFlow -PSHost -ListenerOption "ProcessId,TimeStamp"
このコマンドは、PowerShell の ParameterBinding コンポーネントのトレースを開始します。 Name パラメーターを使用してトレース ソースを指定し、Option パラメーターを使用してトレース イベントを選択ExecutionFlow
し、PSHost パラメーターを使用して PowerShell ホスト リスナーを選択し、コンソールに出力を送信します。 ListenerOption パラメーターは、 と TimeStamp
のProcessID
値をトレース メッセージ プレフィックスに追加します。
例 2: トレースを停止する
Set-TraceSource -Name "ParameterBinding" -RemoveListener "Host"
このコマンドは、PowerShell の ParameterBinding コンポーネントのトレースを停止します。 Name パラメーターを使用して、トレース対象のコンポーネントを識別し、RemoveListener パラメーターを使用してトレース リスナーを識別します。
パラメーター
-Debugger
コマンドレットがデバッガーにトレース出力を送信することを示します。 ユーザー モードまたはカーネル モードのデバッガー、あるいは Microsoft Visual Studio で出力を表示することができます。 このパラメーターは、既定のトレース リスナーも選択します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilePath
このコマンドレットがトレース出力を送信するファイルを指定します。 このパラメーターは、ファイル トレース リスナーも選択します。 このパラメーターを使用してトレースを開始する場合は、 RemoveFileListener パラメーターを使用してトレースを停止します。
Type: | String |
Aliases: | PSPath, Path |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
コマンドレットが読み取り専用ファイルを上書きすることを示します。 FilePath パラメーターと共に を使用します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ListenerOption
出力内の各トレース メッセージのプレフィックスに省略可能なデータを指定します。 このパラメーターの有効値は、次のとおりです。
None
LogicalOperationStack
DateTime
Timestamp
ProcessId
ThreadId
Callstack
None
は既定値です。
これらの値は、フラグ ベースの列挙体として定義されます。 複数の値を組み合わせて、このパラメーターを使用して複数のフラグを設定できます。 値は、値の配列として、またはそれらの値のコンマ区切りの文字列として ListenerOption パラメーターに渡すことができます。 コマンドレットは、binary-OR 操作を使用して値を結合します。 配列として値を渡すことは最も簡単なオプションであり、値にタブ補完を使用することもできます。
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
トレースするコンポーネントを指定します。 各コンポーネントのトレース ソースの名前を入力します。 ワイルドカードを使用できます。
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-Option
トレースされるイベントの種類を指定します。 このパラメーターの有効値は、次のとおりです。
None
Constructor
Dispose
Finalizer
Method
Property
Delegates
Events
Exception
Lock
Error
Errors
Warning
Verbose
WriteLine
Data
Scope
ExecutionFlow
Assert
All
All
は既定値です。
次の値はその他の値の組み合わせです。
ExecutionFlow
:Constructor
,Dispose
,Finalizer
,Method
,Delegates
,Events
,Scope
Data
:Constructor
,Dispose
,Finalizer
,Property
,Verbose
,WriteLine
Errors
:Error
,Exception
これらの値は、フラグ ベースの列挙体として定義されます。 複数の値を組み合わせて、このパラメーターを使用して複数のフラグを設定できます。 値は、値の配列として、またはそれらの値のコンマ区切りの文字列として Option パラメーターに渡すことができます。 コマンドレットは、binary-OR 操作を使用して値を結合します。 配列として値を渡すことは最も簡単なオプションであり、値にタブ補完を使用することもできます。
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
作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PSHost
このコマンドレットが PowerShell ホストにトレース出力を送信することを示します。 このパラメーターは、PSHost トレース リスナーも選択します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveFileListener
指定したファイルに関連付けられているファイル トレース リスナーを削除することで、トレースを停止します。 トレース出力ファイルのパスとファイル名を入力します。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveListener
トレース リスナーを削除することで、トレースを停止します。
RemoveListener では、次の値を使用します。
- PSHost (コンソール) を削除するには、「」と入力します
Host
。 - デバッガーを削除するには、「」と入力します
Debug
。 - すべてのトレース リスナーを削除するには、「」と入力します
*
。
ファイル トレース リスナーを削除するには、 RemoveFileListener パラメーターを使用します。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
名前を含む文字列をこのコマンドレットにパイプできます。
出力
None
既定では、このコマンドレットは出力を返しません。
PassThru パラメーターを使用すると、このコマンドレットはトレース セッションを表す PSTraceSource オブジェクトを返します。
メモ
トレースは、開発者がプログラムをデバッグし、調整するために使用するメソッドです。 トレース時に、プログラムは、内部処理の各手順について詳細なメッセージを生成します。
PowerShell トレース コマンドレットは、PowerShell 開発者を支援するように設計されていますが、すべてのユーザーが使用できます。 PowerShell の機能のほぼすべての側面を監視できます。
トレース ソースは、トレースを管理し、コンポーネントのトレース メッセージを生成する各 PowerShell コンポーネントの一部です。 コンポーネントをトレースするには、トレース ソースを特定します。
トレース リスナーは、トレースの出力を受け取り、ユーザーに表示します。 トレース データは、ユーザー モードまたはカーネル モード デバッガー、コンソール、ファイル、または System.Diagnostics.TraceListener クラスから派生したカスタム リスナーに送信できます。
トレースを開始するには、 Name パラメーターを使用してトレース ソースを指定し、 FilePath、 Debugger、または PSHost パラメーターを使用してリスナー (出力の宛先) を指定します。 Options パラメーターを使用して、トレースされるイベントの種類を確認し、ListenerOption パラメーターを使用してトレース出力を構成します。
トレースの構成を変更するには、トレースを
Set-TraceSource
開始する場合と同様にコマンドを入力します。 PowerShell は、トレース ソースが既にトレースされていることを認識します。 トレースを停止し、新しい構成を追加して、トレースを開始または再開します。トレースを停止するには、 RemoveListener パラメーターを使用します。 ファイル リスナーを使用するトレース ( FilePath パラメーターを使用して開始されたトレース) を停止するには、 RemoveFileListener パラメーターを使用します。 リスナーを削除すると、トレースは停止します。
トレース可能なコンポーネントを判別するには、Get TraceSource を使用します。 各モジュールのトレース ソースは、コンポーネントが使用中のときに自動的に読み込まれ、 の
Get-TraceSource
出力に表示されます。