Поиск по сайту:

Set-TraceSource (Microsoft.PowerShell.Utility)

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

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-FilePath

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

Тип :

String

Псевдонимы:

PSPath, Path

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Force

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

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-ListenerOption

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

    None
    LogicalOperationStack
    DateTime
    Timestamp
    ProcessId
    ThreadId
    Callstack

Нет — значение по умолчанию.

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

Тип :

TraceOptions

Принятые значения:

Нет, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Name

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

Тип :

String[]

Позиция:

0

Значение по умолчанию:

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

Все — значение по умолчанию.

Следующие значения представляют собой комбинации других значений:

  • ExecutionFlow: Конструктор, Dispose, Финализатор, Метод, Делегаты, События, Область
  • Данные: Конструктор, Dispose, Финализатор, Свойство, Verbose, WriteLine
  • Ошибки: Ошибка, Исключение

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

Тип :

PSTraceSourceOptions

Принятые значения:

Нет, Конструктор, Удаление, Финализатор, Метод, Свойство, Делегаты, События, Исключение, Блокировка, Ошибка, Ошибки, Предупреждение, Подробный, WriteLine, Данные, Область, ExecutionFlow, Утверждать, Все

Позиция:

1

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-PassThru

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

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-PSHost

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

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-RemoveFileListener

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

Тип :

String[]

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-RemoveListener

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

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

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

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

Тип :

String[]

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

Входы

Строка

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

Выходы

Нет

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

PSTraceSource

При использовании параметра 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.