Set-TraceSource

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Konfiguriert, startet und stoppt eine Ablaufverfolgung von PowerShell-Komponenten.

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

Beschreibung

Das Set-TraceSource Cmdlet konfiguriert, startet und stoppt eine Ablaufverfolgung einer PowerShell-Komponente. Sie können mit ihm angeben, welche Komponenten verfolgt werden sollen und an welches Element die Ausgabe der Ablaufverfolgung gesendet werden soll.

Beispiele

Beispiel 1: Verfolgen der ParameterBinding-Komponente

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

Dieser Befehl startet die Ablaufverfolgung für die ParameterBinding-Komponente von PowerShell. Er verwendet den Parameter Name , um die Ablaufverfolgungsquelle, den Option-Parameter zum Auswählen der ExecutionFlow Ablaufverfolgungsereignisse und den PSHost-Parameter zum Auswählen des PowerShell-Hostlisteners anzugeben, der die Ausgabe an die Konsole sendet. Der ListenerOption-Parameter fügt dem Präfix der Ablaufverfolgungsnachricht die ProcessID Werte hinzu TimeStamp .

Beispiel 2: Beenden einer Ablaufverfolgung

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

Mit diesem Befehl wird die Ablaufverfolgung der ParameterBinding-Komponente von PowerShell beendet. Er verwendet den Parameter Name , um die Komponente zu identifizieren, die nachverfolgt wurde, und den RemoveListener-Parameter, um den Ablaufverfolgungslistener zu identifizieren.

Parameter

-Debugger

Gibt an, dass das Cmdlet die Ablaufverfolgungsausgabe an den Debugger sendet. Sie können die Ausgabe in jedem Benutzer- oder Kernelmodusdebugger oder in Microsoft Visual Studio anzeigen. Dieser Parameter wählt auch den Standard-Ablaufverfolgungslistener aus.

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

-FilePath

Gibt eine Datei an, an die dieses Cmdlet die Ablaufverfolgungsausgabe sendet. Dieser Parameter wählt auch den Ablaufverfolgungslistener der Datei aus. Wenn Sie diesen Parameter verwenden, um die Ablaufverfolgung zu starten, verwenden Sie den Parameter RemoveFileListener , um die Ablaufverfolgung zu beenden.

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

-Force

Gibt an, dass das Cmdlet eine schreibgeschützte Datei überschreibt. Wird mit dem FilePath-Parameter verwendet.

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

-ListenerOption

Gibt optionale Daten für das Präfix jeder Ablaufverfolgungsnachricht in der Ausgabe an. Zulässige Werte für diesen Parameter:

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

None ist die Standardoption.

Diese Werte werden als flagbasierte Enumeration definiert. Sie können mehrere Werte kombinieren, um mehrere Flags mithilfe dieses Parameters festzulegen. Die Werte können als Array von Werten oder als kommagetrennte Zeichenfolge dieser Werte an den ListenerOption-Parameter übergeben werden. Das Cmdlet kombiniert die Werte mithilfe eines Binary-OR-Vorgangs. Das Übergeben von Werten als Array ist die einfachste Option und ermöglicht ihnen auch die Verwendung des Tabstopps für die Werte.

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

Gibt an, welche Komponenten nachverfolgt werden. Geben Sie den Namen der Ablaufverfolgungsquelle jeder Komponente ein. Platzhalter sind zulässig.

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

-Option

Gibt den Typ der Ereignisse an, die nachverfolgt werden. Zulässige Werte für diesen Parameter:

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

All ist die Standardoption.

Die folgenden Werte sind Kombinationen von anderen Werten:

  • ExecutionFlow: Constructor, , Dispose, MethodFinalizer, Delegates, , EventsScope
  • Data: Constructor, Dispose, Finalizer, Property, VerboseWriteLine
  • Errors: Error, Exception

Diese Werte werden als flagbasierte Enumeration definiert. Sie können mehrere Werte kombinieren, um mehrere Flags mithilfe dieses Parameters festzulegen. Die Werte können als Array von Werten oder als kommagetrennte Zeichenfolge dieser Werte an den Parameter Option übergeben werden. Das Cmdlet kombiniert die Werte mithilfe eines Binary-OR-Vorgangs. Das Übergeben von Werten als Array ist die einfachste Option und ermöglicht ihnen auch die Verwendung des Tabstopps für die Werte.

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

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

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

-PSHost

Gibt an, dass dieses Cmdlet die Ablaufverfolgungsausgabe an den PowerShell-Host sendet. Dieser Parameter wählt auch den PSHost-Ablaufverfolgungslistener aus.

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

-RemoveFileListener

Beendet die Ablaufverfolgung durch Entfernen des Datei-Ablaufverfolgungslisteners, der der angegebenen Datei zugeordnet ist. Geben Sie den Pfad und den Dateinamen der Ablaufverfolgungsausgabe-Datei an.

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

-RemoveListener

Beendet die Ablaufverfolgung durch Entfernen des Ablaufverfolgungslisteners.

Verwenden Sie die folgenden Werte mit RemoveListener:

  • Um PSHost (Konsole) zu entfernen, geben Sie Host.
  • Um Debugger zu entfernen, geben Sie Debug.
  • Um alle Ablaufverfolgungslistener zu entfernen, geben Sie *.

Verwenden Sie den Parameter RemoveFileListener, um den Dateiablaufverfolgungslistener zu entfernen.

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

Eingaben

String

Sie können eine Zeichenfolge mit einem Namen an dieses Cmdlet weiterleiten.

Ausgaben

None

Standardmäßig gibt dieses Cmdlet keine Ausgabe zurück.

PSTraceSource

Wenn Sie den PassThru-Parameter verwenden, gibt dieses Cmdlet ein PSTraceSource-Objekt zurück, das die Ablaufverfolgungssitzung darstellt.

Hinweise

  • Die Ablaufverfolgung ist eine Methode, die Entwickler zum Debuggen und Optimieren von Programmen verwenden. Bei der Ablaufverfolgung erzeugt das Programm ausführliche Meldungen zu den einzelnen Schritten in der internen Verarbeitung.

    Die PowerShell-Ablaufverfolgungs-Cmdlets sollen PowerShell-Entwickler unterstützen, aber sie sind für alle Benutzer verfügbar. Sie ermöglichen es Ihnen, nahezu jeden Aspekt der Funktionalität von PowerShell zu überwachen.

    Eine Ablaufverfolgungsquelle ist der Teil jeder PowerShell-Komponente, die die Ablaufverfolgung verwaltet und Ablaufverfolgungsmeldungen für die Komponente generiert. Um eine Komponente zu verfolgen, identifizieren Sie die Ablaufverfolgungsquelle.

    Ein Ablaufverfolgungslistener empfängt die Ausgabe der Ablaufverfolgung und zeigt sie dem Benutzer an. Sie können die Ablaufverfolgungsdaten an einen Benutzermodus- oder Kernelmodusdebugger, an die Konsole, an eine Datei oder an einen von der System.Diagnostics.TraceListener-Klasse abgeleiteten benutzerdefinierten Listener senden.

  • Verwenden Sie zum Starten einer Ablaufverfolgung den Parameter Name , um eine Ablaufverfolgungsquelle und die Parameter FilePath, Debugger oder PSHost anzugeben, um einen Listener (ein Ziel für die Ausgabe) anzugeben. Verwenden Sie den Parameter "Options ", um die Typen von Ereignissen zu bestimmen, die nachverfolgt werden, und den ListenerOption-Parameter , um die Ablaufverfolgungsausgabe zu konfigurieren.

  • Um die Konfiguration einer Ablaufverfolgung zu ändern, geben Sie einen Set-TraceSource Befehl ein, wie Sie eine Ablaufverfolgung starten möchten. PowerShell erkennt, dass die Ablaufverfolgungsquelle bereits nachverfolgt wird. Es beendet die Ablaufverfolgung, fügt die neue Konfiguration hinzu und startet die Ablaufverfolgung erneut.

  • Verwenden Sie den RemoveListener-Parameter , um eine Ablaufverfolgung zu beenden. Verwenden Sie den Parameter RemoveFileListener, um eine Ablaufverfolgung zu beenden, die den Dateilistener verwendet (eine Ablaufverfolgung, die mit dem FilePath-Parameter gestartet wurde). Wenn Sie den Listener entfernen, wird die Ablaufverfolgung beendet.

  • Um zu bestimmen, welche Komponenten verfolgt werden können, verwenden Sie Get-TraceSource. Die Ablaufverfolgungsquellen für jedes Modul werden automatisch geladen, wenn die Komponente verwendet wird, und sie werden in der Ausgabe von Get-TraceSourceangezeigt.