Поделиться через

Set-TraceSource

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Настраивает, запускает и останавливает трассировку компонентов 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"

Эта команда запускает трассировку компонента ParameterBinding PowerShell. Он использует параметр Name для указания источника трассировки, параметра Option для выбора ExecutionFlow событий трассировки и параметра PSHost для выбора прослушивателя узла PowerShell, который отправляет выходные данные в консоль. Параметр ListenerOption добавляет ProcessID значения и TimeStamp значения в префикс сообщения трассировки.

Пример 2. Остановка трассировки

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

Эта команда останавливает трассировку компонента ParameterBinding PowerShell. Он использует параметр Name для идентификации компонента, отслеживаемого и параметра RemoveListener , для идентификации прослушивателя трассировки.

Параметры

-Debugger

Указывает, что командлет отправляет выходные данные трассировки отладчику. Выходные данные можно просмотреть в любом отладчике, работающем в пользовательском режиме или в режиме ядра, либо в Microsoft Visual Studio. Данный параметр также определяет прослушиватель трассировки по умолчанию.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-FilePath

Указывает файл, в который этот командлет отправляет выходные данные трассировки. Данный параметр также определяет прослушиватель трассировки файла. Если этот параметр используется для запуска трассировки, используйте параметр RemoveFileListener для остановки трассировки.

Тип:String
Aliases:PSPath
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Force

Указывает, что командлет перезаписывает файл только для чтения. Используется с параметром FilePath .

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ListenerOption

Указывает необязательные данные префикс каждого сообщения трассировки в выходных данных. Допустимые значения для этого параметра:

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

Значение по умолчанию — None.

Эти значения определяются как перечисление на основе флага. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать в параметр ListenerOption в виде массива значений или в виде строки с разделителями-запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым параметром, а также позволяет использовать завершение табуляции для значений.

Тип:TraceOptions
Допустимые значения:None, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Name

Указывает, какие компоненты трассируются. Введите имя источника трассировки для каждого компонента. Разрешено использовать подстановочные знаки.

Тип:String[]
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки: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, DisposeFinalizerMethodDelegatesEventsScope
  • Data: Constructor, , FinalizerDisposeProperty, VerboseWriteLine
  • Errors: Error, Exception

Эти значения определяются как перечисление на основе флага. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать параметру Option в виде массива значений или в виде строки, разделенной запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым параметром, а также позволяет использовать завершение табуляции для значений.

Тип:PSTraceSourceOptions
Допустимые значения: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
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-PSHost

Указывает, что этот командлет отправляет выходные данные трассировки на узел PowerShell. Данный параметр также определяет прослушиватель трассировки PSHost.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-RemoveFileListener

Прекращает трассировку, удаляя прослушиватель трассировки, связанный с указанным файлом. Введите путь и имя выходного файла трассировки.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-RemoveListener

Прекращает трассировку, удаляя прослушиватель трассировки.

Используйте следующие значения с RemoveListener:

  • Чтобы удалить PSHost (консоль), введите Host.
  • Чтобы удалить отладчик, введите Debug.
  • Чтобы удалить все прослушиватели трассировки, введите *.

Чтобы удалить прослушиватель трассировки файла, используйте параметр RemoveFileListener .

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

String

Можно передать строку, содержащую имя этого командлета.

Выходные данные

None

По умолчанию этот командлет не возвращает выходные данные.

PSTraceSource

При использовании параметра PassThru этот командлет возвращает объект PSTraceSource , представляющий сеанс трассировки.

Примечания

  • Трассировка — это метод, применяемый разработчиками для отладки и изменения программы. Во время трассировки программа создает подробные сообщения о каждом шаге внутренней обработки.

    Командлеты трассировки PowerShell предназначены для разработчиков PowerShell, но они доступны всем пользователям. Они позволяют отслеживать практически все аспекты функциональности PowerShell.

    Источник трассировки является частью каждого компонента PowerShell, который управляет трассировкой и создает сообщения трассировки для компонента. Чтобы выполнить трассировку компонента, указать определить его источник трассировки.

    Прослушиватель трассировки получает выходные данные трассировки и отображает его пользователю. Вы можете отправить данные трассировки в отладчик пользовательского режима или в режим ядра, в консоль, в файл или в пользовательский прослушиватель, производный от класса System.Diagnostics.TraceListener .

  • Чтобы запустить трассировку, используйте параметр Name для указания источника трассировки и параметров FilePath, Отладчика или PSHost , чтобы указать прослушиватель (назначение для выходных данных). Используйте параметр Options, чтобы определить типы событий, которые трассируются, и параметр ListenerOption для настройки выходных данных трассировки.

  • Чтобы изменить конфигурацию трассировки, введите Set-TraceSource команду, как вы хотите запустить трассировку. PowerShell распознает, что источник трассировки уже отслеживается. Она остановит трассировку, добавит новую конфигурацию и запустит или перезапустит трассировку.

  • Чтобы остановить трассировку, используйте параметр RemoveListener . Чтобы остановить трассировку, использующую прослушиватель файлов (трассировку, запущенную с помощью параметра FilePath ), используйте параметр RemoveFileListener . При удалении прослушивателя трассировка останавливается.

  • Чтобы определить, какие компоненты можно трассировать, используйте командлет Get-TraceSource. Источники трассировки для каждого модуля загружаются автоматически при использовании компонента и отображаются в выходных Get-TraceSourceданных.