Set-TraceSource

Windows PowerShell コンポーネントのトレースを構成、開始、および停止します。

構文

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>]

説明

Set-TraceSource コマンドレットは、Windows PowerShell コンポーネントのトレースを構成、開始、および停止します。このコマンドレットを使用すると、トレースするコンポーネントとトレースの出力先を指定できます。

パラメーター

-Debugger

トレースをデバッガーに出力します。出力は、任意のユーザー モードまたはカーネル モード デバッガー、あるいは Microsoft Visual Studio で表示できます。このパラメーターによって、既定のトレース リスナーも選択したことになります。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-FilePath <string>

指定されたファイルにトレースを出力します。このパラメーターによって、ファイル トレース リスナーも選択されます。このパラメーターを使用してトレースを開始した場合は、RemoveFileListener パラメーターを使用してトレースを停止します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Force

このコマンドレットが読み取り専用ファイルを上書きするのを許可します。FilePath パラメーターと共に使用します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ListenerOption <TraceOptions>

出力される各トレース メッセージのプレフィックスにオプション データを追加します。有効な値は、"None"、"LogicalOperationStack"、"DateTime"、"Timestamp"、"ProcessId"、"ThreadId"、および "Callstack" です。既定値は "None" です。

複数のオプションを指定するには、スペースを入れずにコンマで各オプションを区切り、"ProcessID,ThreadID" のように二重引用符で囲みます。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Name <string[]>

トレース対象のコンポーネントを決定します。各コンポーネントのトレース ソースの名前を入力します。ワイルドカードを使用できます。

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByValue, ByPropertyName)
ワイルドカード文字を許可する	false

-Option <PSTraceSourceOptions>

トレース対象のイベントの種類を決定します。

有効な値は、"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)

複数のオプションを指定するには、各オプションをスペースを入れずにコンマで区切り、"Constructor,Dispose" のように二重引用符で囲みます。

必須	false
位置	2
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-PassThru

トレース セッションを表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PSHost

トレースを Windows PowerShell ホストに出力します。このパラメーターによって、PSHost トレース リスナーも選択されます。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-RemoveFileListener <string[]>

指定されたファイルと関連付けられているファイル トレース リスナーを削除して、トレースを停止します。トレース出力ファイルのパスとファイル名を入力します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-RemoveListener <string[]>

トレース リスナーを削除してトレースを停止します。

RemoveListener では以下の値が使用できます。

-- PSHost (コンソール) を削除するには、「Host」と入力します。

-- デバッガーを削除するには、「Debug」と入力します。

-- すべてのトレース リスナーを削除するには、「*」と入力します。

ファイル トレース リスナーを削除するには、RemoveFileListener パラメーターを使用します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力	System.String パイプを使用して名前を含む文字列を Set-TraceSource に渡すことができます。
出力	なし、または System.Management.Automation.PSTraceSource PassThru パラメーターを使用すると、Set-TraceSource はトレース セッションを表す System.Management.Automation.PSTraceSource オブジェクトを生成します。それ以外の場合、このコマンドレットによる出力はありません。

注

トレースは、開発者がプログラムをデバッグおよび改良するときに使用する方法です。トレースを行うと、プログラムは内部処理の各手順について詳細なメッセージを生成します。

Windows PowerShell のトレース用コマンドレットは、Windows PowerShell 開発者向けに設計されていますが、どのユーザーでも使用できます。トレース用コマンドレットを使用すると、Windows PowerShell の機能のほぼすべての部分を監視できます。

"トレース ソース" は各 Windows PowerShell コンポーネントの一部としてトレースを管理し、コンポーネントのトレース メッセージを生成します。コンポーネントをトレースするには、そのトレース ソースを特定します。

"トレース リスナー" は、トレースの出力を受け取り、ユーザーに表示します。トレース データの送り先として、ユーザー モードまたはカーネル モードのデバッガー、コンソール、ファイルのほか、System.Diagnostics.TraceListener クラスから派生したカスタム リスナーのいずれかを選択できます。

トレースを開始するには、Name パラメーターにトレース ソース (トレース対象のコンポーネント) を指定し、FilePath、Debugger、または PSHost パラメーターを使用してリスナー (出力先) を指定します。Options パラメーターを使用してトレース対象のイベントの種類を指定し、ListenerOptions パラメーターを使用してトレース出力を構成します。

トレースの構成を変更するには、トレースを開始する場合と同じように Set-TraceSource コマンドを実行します。Windows PowerShell は、トレース ソースで既にトレースが行われていることを認識します。トレースを停止し、新しい構成を追加し、トレースを開始または再開します。

トレースを停止するには、RemoveListener パラメーターを使用します。ファイル リスナーを使用するトレース (-FilePath パラメーターを指定したときに起動されるトレース) を停止するには、RemoveFileListener パラメーターを使用します。リスナーを削除すると、トレースは停止します。

どのコンポーネントがトレース可能かを判断するには、Get-TraceSource を使用します。各モジュールのトレース ソースは、コンポーネントが使用中であると自動的に読み込まれ、Get-TraceSource の出力に含まれます。

例 1

C:\PS>Set-TraceSource -Name Parameterbinding -Option ExecutionFlow -PSHost '
-ListenerOption "ProcessID,TimeStamp"

説明
-----------
このコマンドは、Windows PowerShell の ParameterBinding コンポーネントのトレースを開始します。Name パラメーターを使用してトレース ソースを指定し、Option パラメーターを使用して ExecutionFlow トレース イベントを選択し、PSHost パラメーターを使用して出力をコンソールに送る Windows PowerShell ホスト リスナーを選択します。ListenerOption パラメーターを指定することによって、"ProcessID" および "TimeStamp" の値をトレース メッセージ プレフィックスに追加しています。

例 2

C:\PS>set-tracesource -name ParameterBinding -RemoveListener Host

説明
-----------
このコマンドは、Windows PowerShell の ParameterBinding コンポーネントのトレースを停止します。Name パラメーターを使用してトレース中のコンポーネントを指定し、RemoveListener パラメーターを使用してトレース リスナーを指定します。

関連項目

概念

Get-TraceSource
Trace-Command
Set-PSDebug