Options de ligne de commande WPR

Windows Performance Recorder (WPR) offre une interface de ligne de commande simple. La complexité complète de WPR est intégrée dans les profils d’enregistrement.

Options générales

WPR nécessite un système d’exploitation Windows 8.1 ou une version ultérieure.

Syntaxe

wpr FirstLevelOption [<arguments>] [Additional options [<arguments>]]

Vous pouvez obtenir de l’aide supplémentaire avec :

wpr -help [start | stop | status | profiles | providers | tracing | boottrace | heap | hardwarecounter | advanced]

Les FirstLevelOptions suivantes sont disponibles :

Profiles

L’option Profiles répertorie les profils WPR utilisés par l’enregistrement.

Syntaxe

wpr -profiles [<path>]

Le tableau suivant décrit les arguments disponibles que vous pouvez appliquer à cette option. Pour voir les profils intégrés, omettez l’argument.

Démarrer

L’option Start démarre un enregistrement en utilisant un ou plusieurs profils.

Syntaxe

wpr -start <profile> [-start <profilen>]... [-filemode] [-recordtempto <temp folder path>] [-onoffscenario <OnOff Transition Type>] [-onoffresultspath <path to which the trace files are saved>] [-onoffproblemdescription <description of the scenario>] [-numiterations <number of iterations for OnOff tracing>]

Le tableau suivant décrit les commutateurs disponibles que vous pouvez appliquer à cette option.

Exemple

wpr -start CPU (Starts verbose CPU profile in memory mode)
wpr -start CPU.light -filemode (Starts light CPU profile in file mode)
wpr -start filename.wprp!ProfileName.Verbose (Starts verbose ProfileName profile defined in filename.wprp)

Arrêter

L’option Stop arrête l’enregistrement en cours et l’enregistre dans le fichier spécifié par l’argument.

Syntaxe

wpr -stop <file> <problem description> -[skipPdbGen] [-force] [-compress]

Le tableau suivant décrit les arguments disponibles que vous pouvez appliquer à cette option.

Fusionner (Merge)

L’option Merge fusionne les fichiers etl dans le fichier donné.

Syntaxe

wpr -merge <trace files ...> <merged file> -[skipPdbGen] [-compress] [-supresspii] [-mergeonly] [-injectonly]

Le tableau suivant décrit les arguments disponibles que vous pouvez appliquer à cette option.

Annuler

L’option Cancel annule l’enregistrement en cours sans enregistrer les données enregistrées. Si aucune instance n’est actuellement active, l’option Cancel renvoie une erreur.

Syntaxe

wpr -cancel

Cette option ne prend aucun argument.

État

L’option Status affiche des informations sur l’état de l’enregistrement WPR en cours.

Syntaxe

wpr -status [profiles] [collectors [-details]]

Si aucun enregistrement n’est actuellement actif, un message indique que WPR n’enregistre pas. Si un enregistrement est actuellement actif et qu’aucun argument n’est utilisé, les informations d’état suivantes s’affichent :

WPR recording is in progress...

Time since start        : 00:04:27

Dropped event           : 0

Logging mode            : Memory

Si vous fournissez des arguments avec l’option -status, les informations listées ci-dessus s’affichent avec les données spécifiques à cette option. Le tableau suivant décrit les arguments disponibles que vous pouvez appliquer à cette option.

Enregistrement de l’activité système en utilisant le jeu de profils suivant : 
Profile                 : CPU.Verbose.Memory

Collecteurs enregistrant activement : 
Nom du collecteur : Journal des noyaux NT Taille du tampon (KB) : 1024 Événements perdus : 0 Mots-clés système CSwitch ProcessThread SampledProfile System Stacks CSwitch SampledProfile
Collector Name          : WPR_initiated_WPR Event Collector
Buffer Size (KB)        : 1024
Events Lost             : 0
Providers
Microsoft-Windows-Shell-Core: 0x1000000000000: 0x04
Microsoft-Windows-Win32k: 0x1000000402000: 0xff : Stack
CaptureState Providers on Save
Microsoft-Windows-Win32k: 0x80000: 0xff

Profiledetails

L’option Profiledetails affiche des informations détaillées sur un profil ou un ensemble de profils. Pour spécifier plusieurs profils, utilisez la syntaxe suivante où <profilen> se réfère au nom de chaque profil.

Syntaxe

wpr -profiledetails <profile1>+<profile2>+...+<profilen> [-filemode] -onoffscenario <OnOff Transition Type>

Le tableau suivant décrit les commutateurs disponibles que vous pouvez appliquer à cette option.

ExportProfile

L’option ExportProfile exporte le(s) profil(s) intégré(s) vers le fichier donné. Utilisez la commande wpr -Profiles pour énumérer les profils intégrés disponibles. Pour spécifier plusieurs profils, utilisez la syntaxe suivante où <profilen> se réfère au nom de chaque profil. La convention de nommage des profils est exactement la même que celle utilisée dans wpr -start. Un profil est spécifié comme <profile name>[.{light|verbose}].

Syntaxe

wpr -exportprofile <profile1>+<profile2>+...+<profilen> <ExportedFileName.wprp> [-filemode]

Cet exemple exporte le profil GeneralProfile verbose en mode fichier vers le fichier GeneralProfileVerboseFile.wprp.

Exemple

wpr -exportprofile GeneralProfile d:\profiles\GeneralProfileVerboseFile.wprp -filemode

Fournisseurs

L’option Providers affiche des informations détaillées sur les fournisseurs. Les fournisseurs font référence aux composants Event Tracing for Windows (ETW) qui exposent des événements à Windows Performance Recorder (WPR). Pour afficher des informations sur les fournisseurs, utilisez la syntaxe suivante, où -providers fait référence à tous les fournisseurs installés/connu et enregistrés.

Syntaxe

wpr -providers

Cette option ne prend aucun argument.

Boottrace

L’option Boottrace configure les entrées de registre pour les sessions autologger/globallogger pour le profil donné.

Syntaxe

wpr -boottrace {-addboot [<filename.wprp>!]<profile> [-addboot <profile> ...] [-filemode] [-recordtempto <temp folder path>] | -stopboot <recording filename> <Problem description> | -cancelboot}

Le tableau suivant décrit les mots-clés disponibles que vous pouvez appliquer à cette option.

CaptureStateOnDemand

L’option CaptureStateOnDemand capture les états pour les fournisseurs configurés dans l’enregistrement en cours. Le fournisseur d’événements doit être configuré pour capturestateondemand dans le fichier de profil pendant que la session est en cours d’exécution.

Syntaxe

wpr-capturestateondemand

Voici un exemple de EventProvider :

<EventProvider Id="EventProvider_Microsoft-Windows-Win32k" Name="Microsoft-Windows-Win32k" NonPagedMemory="true" CaptureStateOnly="true">
      <CaptureStateOnDemand Timeout="5">
         <Keyword Value="0x0"/>
      </CaptureStateOnDemand>
    </EventProvider>

Marqueur

L’option Marker déclenche un marqueur d’événement avec le texte donné dans la session de journalisation système en cours.

Syntaxe

wpr -marker <text> [-flush]

MarkerFlush (Obsolète)

L’option MarkerFlush déclenche un marqueur d’événement avec le texte donné et vide l’ensemble de travail. Cette commande est obsolète dans le WPR actuel.

Syntaxe

wpr -markerflush <text>

Purge

L’option Flush vide les sessions de journalisation vers les fichiers initiés via WPR.

Syntaxe

wpr -flush

Cette option ne prend aucun argument.

HeapTracingConfig

L’option HeapTracingConfig active ou désactive le suivi de tas pour un processus ou une application spécifique.

Syntaxe

wpr -HeapTracingConfig <process name> [<package full name> <package relative app ID>] [{enable|disable}]

Disablepagingexecutive

L’option Disablepagingexecutive spécifie si les pilotes et le code système en mode noyau peuvent être paginés sur le disque. La définition de cette option sur on empêche la pagination. Cette option définit la valeur de DisablePagingExecutive dans le registre.

Syntaxe

wpr -disablepagingexecutive {on | off}

Journal

L’option Log ajoute et configure la journalisation de débogage dans le journal des événements.

Syntaxe

wpr -log {enabled | disabled | remove}

Le tableau suivant décrit les mots-clés disponibles que vous pouvez appliquer à cette option.

Purgecache

L’option Purgecache purge le cache des symboles gérés.

Syntaxe

wpr -purgecache

Cette option ne prend aucun argument.

Aide

Utilisez cette option pour afficher l’aide en ligne dans la fenêtre Invite de commande.

Syntaxe

wpr -help [start | stop | status | profiles | providers | tracing | boottrace | heap | hardwarecounter | advanced]

Le tableau suivant décrit les mots-clés disponibles que vous pouvez appliquer à cette option.

SnapshotConfig

L’option SnapshotConfig active ou désactive la possibilité de capturer des instantanés uniques ou périodiques de <option de snapshot>\ pour un processus ou des processus spécifiques. Actuellement, vous pouvez prendre des instantanés du tas.

Syntaxe

wpr -SnapshotConfig <snapshot option> {-name <process name> | -pid <pid 1> [pid 2] ...} [{enable|disable}]

Si le {enable|disable} paramètre est omis, la configuration actuelle de l’instantané pour le processus sera affichée (c’est-à-dire uniquement l’option -name).

Cet exemple utilise la commande snapshotconfig avec des noms d’image :

wpr -snapshotconfig heap -name Win32Project1.exe           //query snapshot config
wpr -snapshotconfig heap -name Win32Project1.exe enable    //enable snapshot config
wpr -snapshotconfig heap -name Win32Project1.exe disable   //disable snapshot config

Cet exemple utilise la commande snapshotconfig avec un PID :

wpr -snapshotconfig heap -pid 8048 enable                //enable snapshot config

Le tableau suivant décrit les commutateurs disponibles que vous pouvez appliquer à cette option.

SingleSnapshot

L’option SingleSnapshot déclenche une capture instantanée à la demande de <option de snapshot> pour l’identifiant de processus spécifié.

Syntaxe

wpr -SnapshotConfig <snapshot option> <pid 1> [pid 2] ... [up to pid 8]

Le tableau suivant décrit les commutateurs disponibles que vous pouvez appliquer à cette option.

EnablePeriodicSnapshot

L’option EnablePeriodicSnapshot déclenche des captures instantanées périodiques à des intervalles spécifiés et aux identifiants de processus donnés.

Syntaxe

wpr -enableperiodicsnapshot <snapshot option> <interval (in seconds)> <pid 1> [pid 2] ... [up to pid 8]

Le tableau suivant décrit les commutateurs disponibles que vous pouvez appliquer à cette option.

DisablePeriodicSnapshot

L’option DisablePeriodicSnapshot désactive les captures instantanées périodiques pour tous les processus spécifiés par l’option enableperiodicsnapshot.

Syntaxe

wpr -disableperiodicsnapshot <snapshot option>

Exemple

wpr -disableperiodicsnapshot heap

Le tableau suivant décrit les commutateurs disponibles que vous pouvez appliquer à cette option.

PMCSources

L’option PMCSources interroge la liste des événements PMU (Performance Monitoring Unit) sur le système et leur valeur d’intervalle par défaut pour le dépassement du compteur. L’intervalle est le nombre d’événements.

Syntaxe

wpr -pmcsources

C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit>wpr -pmcsources
Id  Name                        Interval  Min      Max
--------------------------------------------------------------
  0 Timer                          10000  1221    1000000
  2 TotalIssues                   698400  4096 2147483647
  6 BranchInstructions             65536  4096 2147483647
 10 CacheMisses                    65536  4096 2147483647
 11 BranchMispredictions           65536  4096 2147483647
 19 TotalCycles                    65536  4096 2147483647
 25 UnhaltedCoreCycles             65536  4096 2147483647
 26 InstructionRetired             65536  4096 2147483647
 27 UnhaltedReferenceCycles        65536  4096 2147483647
 28 LLCReference                   65536  4096 2147483647
 29 LLCMisses                      65536  4096 2147483647
 30 BranchInstructionRetired       65536  4096 2147483647
 31 BranchMispredictsRetired       65536  4096 2147483647
 32 LbrInserts                     65536  4096 2147483647

PMCSessions

L’option PMCSessions interroge la liste des sessions utilisant des compteurs matériels. Cette option n’est disponible que sur Windows 11 ou les versions ultérieures.

Syntaxe

wpr -pmcsessions

ProfInt

L’option ProfInt interroge l’intervalle de « profilage ».

Syntaxe

wpr -profint

Exemple

C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit>wpr -profint
Current Profile Interval = 10000 [1.0000ms]

SetProfInt

L’option SetProfInt définit l’intervalle de profil d’échantillonnage pour les événements PMU. Si le nom de l’événement PMU est omis, le défaut est Timer.

Syntaxe

wpr -setprofint [PMU event name] 1221...10000000

Exemple

C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit>wpr -setprofint 100000
New Profile Interval = 100000 [10.0000ms]

C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit>wpr -setprofint TotalIssues 1000000
New Profile Interval = 100000 [Counter: TotalIssues]

ResetProfInt

L’option ResetProfInt réinitialise l’intervalle de profil à la valeur par défaut.

Syntaxe

wpr -resetprofint [Profile Source Name]

Notez que si [Nom de la source de profil] n’est pas fourni, toutes les sources de profil seront réinitialisées à la valeur par défaut.

Instancename

L’option Instancename spécifie un nom pour identifier de manière unique l’instance de traçage.

Cette option peut être appliquée à toutes les commandes qui manipulent la session de journalisation et attribue un nom de session de journalisation fourni par l’utilisateur. WPR définit le nom de session par défaut si cette option est omise.

Syntaxe

wpr –{option <arguments>} -instancename <text>

C:\wpt>wpr -start cpu -instancename CpuSession
C:\wpt>wpr -status -instancename CpuSession
WPR recording is in progress...
...
Time since start        : 00:00:05
Dropped event           : 0
Logging mode            : Memory
C:\wpt>wpr -stop cpu.etl  -> omitting instancename option would not find CpuSession
        There are no trace profiles running.
        Error code: 0xc5583000
C:\wpt>wpr -stop cpu.etl -instancename CpuSession  -> trace will be saved

Notes

Chaque fois que WPR enregistre une trace capturée lorsque des applications gérées étaient en cours d’exécution sur le système, WPR enregistre des symboles gérés à côté du fichier de trace. Cette fonctionnalité permet l’analyse des performances des applications gérées.

La génération de symboles gérés est une opération gourmande en ressources et en temps. WPR crée automatiquement un cache de symboles gérés pour accélérer la génération de symboles gérés. Lorsque WPR a besoin de symboles gérés, il vérifie d’abord ce cache et utilise tous les symboles disponibles et appropriés au lieu de les régénérer.

L’emplacement par défaut du cache de symboles gérés est C:\ProgramData\WindowsPerformanceRecorder\NGenPdbs_Cache.

Rubriques connexes

Référence WPR