Set-TraceSource
Настраивает, запускает и останавливает трассировку компонентов PowerShell.
Синтаксис
optionsSet (по умолчанию)
Set-TraceSource
[-Name] <String[]>
[[-Option] <PSTraceSourceOptions>]
[-ListenerOption <TraceOptions>]
[-FilePath <String>]
[-Force]
[-Debugger]
[-PSHost]
[-PassThru]
[<CommonParameters>]
removeAllListenersSet
Set-TraceSource
[-Name] <String[]>
[-RemoveListener <String[]>]
[<CommonParameters>]
removeFileListenersSet
Set-TraceSource
[-Name] <String[]>
[-RemoveFileListener <String[]>]
[<CommonParameters>]
Описание
Командлет Set-TraceSource настраивает, запускает и останавливает трассировку компонента PowerShell. Его можно использовать, чтобы указать, какие компоненты будут трассироваться и где отправляются выходные данные трассировки.
Примеры
Пример 1. Трассировка компонента ParameterBinding
Set-TraceSource -Name "ParameterBinding" -Option ExecutionFlow -PSHost -ListenerOption "ProcessId,TimeStamp"
Эта команда запускает трассировку компонента ParameterBinding PowerShell. Он использует параметр имени для указания источника трассировки, параметра параметра для выбора событий трассировки ExecutionFlow и параметра PSHost для выбора прослушивателя узла PowerShell, который отправляет выходные данные в консоль. Параметр listenerOption добавляет значения ProcessId и TimeStamp в префикс сообщения трассировки.
Пример 2. Остановка трассировки
Set-TraceSource -Name "ParameterBinding" -RemoveListener "Host"
Эта команда останавливает трассировку компонента ParameterBinding PowerShell. Он использует параметр имени
Параметры
-Debugger
Указывает, что командлет отправляет выходные данные трассировки отладчику. Выходные данные можно просмотреть в любом отладчике режима пользователя или в режиме ядра или в Microsoft Visual Studio. Этот параметр также выбирает прослушиватель трассировки по умолчанию.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
optionsSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-FilePath
Указывает файл, в который этот командлет отправляет выходные данные трассировки. Этот параметр также выбирает прослушиватель трассировки файлов. Если этот параметр используется для запуска трассировки, используйте параметр RemoveFileListener, чтобы остановить трассировку.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | PSPath, Путь |
Наборы параметров
optionsSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Указывает, что командлет перезаписывает файл только для чтения. Используется с параметром FilePath
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
optionsSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ListenerOption
Указывает необязательные данные префикс каждого сообщения трассировки в выходных данных. Допустимые значения для этого параметра:
NoneLogicalOperationStackDateTimeTimestampProcessIdThreadIdCallstack
None — это значение по умолчанию.
Эти значения определяются как перечисление, основанное на флагах. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать в параметр ListenerOption в виде массива значений или в виде строки с разделителями-запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым вариантом, а также позволяет использовать дополнение при нажатии Tab для значений.
Свойства параметра
| Тип: | TraceOptions |
| Default value: | None |
| Допустимые значения: | None, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
optionsSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Name
Указывает, какие компоненты трассируются. Введите имя источника трассировки каждого компонента. Подстановочные символы разрешены.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | True |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 0 |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-Option
Указывает тип отслеживаемых событий. Допустимые значения для этого параметра:
NoneConstructorDisposeFinalizerMethodPropertyDelegatesEventsExceptionLockErrorErrorsWarningVerboseWriteLineDataScopeExecutionFlowAssertAll
None — это значение по умолчанию.
Ниже приведены сочетания других значений:
-
ExecutionFlow:Constructor,DisposeFinalizerMethodDelegatesEventsScope -
Data:Constructor, ,FinalizerDisposeProperty,VerboseWriteLine -
Errors:Error,Exception
Эти значения определяются как перечисление, основанное на флагах. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать параметру Option в виде массива значений или в виде строки, разделенной запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым вариантом, а также позволяет использовать дополнение при нажатии Tab для значений.
Свойства параметра
| Тип: | PSTraceSourceOptions |
| Default value: | None |
| Допустимые значения: | None, Constructor, Dispose, Finalizer, Method, Property, Delegates, Events, Exception, Lock, Error, Errors, Warning, Verbose, WriteLine, Data, Scope, ExecutionFlow, Assert, All |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
optionsSet
| Position: | 1 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-PassThru
Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
optionsSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-PSHost
Указывает, что этот командлет отправляет выходные данные трассировки на узел PowerShell. Этот параметр также выбирает прослушиватель трассировки PSHost.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
optionsSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RemoveFileListener
Останавливает трассировку, удалив прослушиватель трассировки файлов, связанный с указанным файлом. Введите путь и имя файла выходного файла трассировки.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
removeFileListenersSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RemoveListener
Останавливает трассировку, удалив прослушиватель трассировки.
Используйте следующие значения с RemoveListener:
- Чтобы удалить PSHost (консоль), введите
Host. - Чтобы удалить отладчик, введите
Debug. - Чтобы удалить все прослушиватели трассировки, введите
*.
Чтобы удалить прослушиватель трассировки файлов, используйте параметр RemoveFileListener.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
removeAllListenersSet
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
Входные данные
String
Можно передать строку, содержащую имя этого командлета.
Выходные данные
None
По умолчанию этот командлет не возвращает выходные данные.
PSTraceSource
При использовании параметра PassThru этот командлет возвращает объект PSTraceSource, представляющий сеанс трассировки.
Примечания
Трассировка — это метод, используемый разработчиками для отладки и уточнения программ. При трассировке программа создает подробные сообщения о каждом шаге внутренней обработки.
Командлеты трассировки PowerShell предназначены для разработчиков PowerShell, но они доступны всем пользователям. Они позволяют отслеживать практически все аспекты функциональности PowerShell.
Источник трассировки является частью каждого компонента PowerShell, который управляет трассировкой и создает сообщения трассировки для компонента. Для трассировки компонента необходимо определить его источник трассировки.
Прослушиватель трассировки получает выходные данные трассировки и отображает его пользователю. Вы можете отправить данные трассировки в отладчик пользовательского режима или в режим ядра, в консоль, в файл или в пользовательский прослушиватель, производный от класса System.Diagnostics.TraceListener.
Чтобы запустить трассировку, используйте параметр имени
, чтобы указать источник трассировки и параметровFilePath ,отладчик илипараметры PSHost , чтобы указать прослушиватель (назначение для выходных данных). Используйте параметр, чтобы определить типы отслеживаемых событий и параметр ListenerOption для настройки выходных данных трассировки.Чтобы изменить конфигурацию трассировки, введите команду
Set-TraceSourceпо мере запуска трассировки. PowerShell распознает, что источник трассировки уже отслеживается. Он останавливает трассировку, добавляет новую конфигурацию и запускает или перезапускает трассировку.Чтобы остановить трассировку, используйте параметр RemoveListener. Чтобы остановить трассировку, использующую прослушиватель файлов (трассировку, запущенную с помощью параметра FilePath), используйте параметр RemoveFileListener. При удалении прослушивателя трассировка останавливается.
Чтобы определить, какие компоненты можно отслеживать, используйте Get-TraceSource. Источники трассировки для каждого модуля загружаются автоматически при использовании компонента и отображаются в выходных данных
Get-TraceSource.
