Skip to content

Commit d468ff1

Browse files
planetchiliplanetchili
committed
fix metric descriptions in meta and update readme with csv columns
1 parent 3ce78c9 commit d468ff1

File tree

2 files changed

+69
-69
lines changed

2 files changed

+69
-69
lines changed

‎IntelPresentMon/Interprocess/source/metadata/EnumMetric.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// enum annotation (enum_name_fragment, key_name_fragment, name, short_name, description)
55
#define ENUM_KEY_LIST_METRIC(X_) \
6-
X_(METRIC, APPLICATION, "Application", "", "Name of the executable of the process being targetted") \
6+
X_(METRIC, APPLICATION, "Application", "", "Name of the executable of the process being targeted") \
77
X_(METRIC, SWAP_CHAIN_ADDRESS, "Swap Chain Address", "", "Address of the swap chain used to present, useful as a unique identifier") \
88
\
99
X_(METRIC, GPU_VENDOR, "GPU Vendor", "", "Vendor name of the GPU") \
@@ -41,7 +41,7 @@
4141
\
4242
X_(METRIC, GPU_SUSTAINED_POWER_LIMIT, "GPU Sustained Power Limit", "", "Sustained power limit of the GPU") \
4343
X_(METRIC, GPU_POWER, "GPU Power", "", "Power consumed by the graphics adapter") \
44-
X_(METRIC, GPU_VOLTAGE, "GPU Voltage", "", "Voltage consumet by the graphics adapter") \
44+
X_(METRIC, GPU_VOLTAGE, "GPU Voltage", "", "Voltage consumed by the graphics adapter") \
4545
X_(METRIC, GPU_FREQUENCY, "GPU Frequency", "", "Clock speed of the GPU cores") \
4646
X_(METRIC, GPU_TEMPERATURE, "GPU Temperature", "", "Temperature of the GPU") \
4747
X_(METRIC, GPU_FAN_SPEED, "GPU Fan Speed", "", "Rate at which a GPU cooler fan is rotating") \
@@ -56,7 +56,7 @@
5656
X_(METRIC, GPU_UTILIZATION_LIMITED, "GPU Utilization Limited", "", "GPU frequency is being limited due to low GPU utilization") \
5757
\
5858
X_(METRIC, GPU_MEM_POWER, "GPU Memory Power", "", "Power consumed by the GPU memory") \
59-
X_(METRIC, GPU_MEM_VOLTAGE, "GPU Memory Voltage", "", "Voltage consumet by the GPU memory") \
59+
X_(METRIC, GPU_MEM_VOLTAGE, "GPU Memory Voltage", "", "Voltage consumed by the GPU memory") \
6060
X_(METRIC, GPU_MEM_FREQUENCY, "GPU Memory Frequency", "", "Clock speed of the GPU memory") \
6161
X_(METRIC, GPU_MEM_EFFECTIVE_FREQUENCY, "GPU Memory Effective Frequency", "", "Effective data transfer rate GPU memory can sustain") \
6262
X_(METRIC, GPU_MEM_TEMPERATURE, "GPU Memory Temperature", "", "Temperature of the GPU memory") \

‎README-CaptureApplication.md‎

Lines changed: 66 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -34,72 +34,72 @@ In Debug configuration, the application will halt with a modal error dialog when
3434

3535
## Metric Definitions
3636

37-
| Metric | Description | Compatible Query Types |
38-
| - | - |:-:|
39-
|Application|Name of the executable of the process being targetted|DS|
40-
|Swap Chain Address|Address of the swap chain used to present, useful as a unique identifier|F|
41-
|GPU Vendor|Vendor name of the GPU|DS|
42-
|GPU Name|Device name of the GPU|DS|
43-
|CPU Vendor|Vendor name of the CPU|DS|
44-
|CPU Name|Device name of the CPU|DS|
45-
|Time|Time elapsed since the start of ETW event tracing|F|
46-
|CPU Frame QPC|The QueryPerformanceCounter timestamp when the CPU started working on the frame|F|
47-
|Frame Time|The total amount of time in between frames on the CPU|DF|
48-
|CPU Busy|How long the CPU was generating the frame in milliseconds|DF|
49-
|CPU Wait|How long the CPU spent waiting before it could start generating the frame in milliseconds|DF|
50-
|Displayed FPS|Rate of frame change measurable at display|D|
51-
|Presented FPS|Rate of application calls to a Present() function|D|
52-
|GPU Time|Total amount of time between when GPU started frame and when it finished in milliseconds. The GPU may not have been fully busy during this time|DF|
53-
|GPU Busy|How long the GPU spent working on this frame|DF|
54-
|GPU Wait|How long the GPU spent waiting while working on this frame|DF|
55-
|Dropped Frames|Indicates if the frame was not displayed|DF|
56-
|Displayed Time|How long this frame was displayed on screen|DF|
57-
|Sync Interval|The application's requested interval between presents measured in vertical sync/vblank events|DF|
58-
|Present Flags|Flags used to configure the present operation|DF|
59-
|Present Mode|Method used to present the frame|DF|
60-
|Present Runtime|The graphics runtime used for the present operation (DXGI, D3D9, etc.)|DF|
61-
|Allows Tearing|Indicates if the frame allows tearing|DF|
62-
|GPU Latency|How long it took until GPU work for this frame started|DF|
63-
|Display Latency|Time between frame submission and scan out to display|DF|
64-
|Input To Frame Start Latency|Time between input and display|DF|
65-
|Click To Photon Latency|Time between input and display|DF|
66-
|GPU Sustained Power Limit|Sustained power limit of the GPU|DS|
67-
|GPU Power|Power consumed by the graphics adapter|DF|
68-
|GPU Voltage|Voltage consumet by the graphics adapter|DF|
69-
|GPU Frequency|Clock speed of the GPU cores|DF|
70-
|GPU Temperature|Temperature of the GPU|DF|
71-
|GPU Fan Speed|Rate at which a GPU cooler fan is rotating|DF|
72-
|GPU Utilization|Amount of GPU processing capacity being used|DF|
73-
|3D/Compute Utilization|Amount of 3D/Compute processing capacity being used|DF|
74-
|Media Utilization|Amount of media processing capacity being used|DF|
75-
|GPU Power Limited|GPU frequency is being limited because GPU is exceeding maximum power limits|DF|
76-
|GPU Temperature Limited|GPU frequency is being limited because GPU is exceeding maximum temperature limits|DF|
77-
|GPU Current Limited|GPU frequency is being limited because GPU is exceeding maximum current limits|DF|
78-
|GPU Voltage Limited|GPU frequency is being limited because GPU is exceeding maximum voltage limits|DF|
79-
|GPU Utilization Limited|GPU frequency is being limited due to low GPU utilization|DF|
80-
|GPU Memory Power|Power consumed by the GPU memory|DF|
81-
|GPU Memory Voltage|Voltage consumet by the GPU memory|DF|
82-
|GPU Memory Frequency|Clock speed of the GPU memory|DF|
83-
|GPU Memory Effective Frequency|Effective data transfer rate GPU memory can sustain|DF|
84-
|GPU Memory Temperature|Temperature of the GPU memory|DF|
85-
|GPU Memory Size|Size of the GPU memory|DS|
86-
|GPU Memory Size Used|Amount of used GPU memory|DF|
87-
|GPU Memory Utilization|Percent of GPU memory used|D|
88-
|GPU Memory Max Bandwidth|Maximum total GPU memory bandwidth|DS|
89-
|GPU Memory Write Bandwidth|Maximum GPU memory bandwidth for writing|DF|
90-
|GPU Memory Read Bandwidth|Maximum GPU memory bandwidth for reading|DF|
91-
|GPU Memory Power Limited|Memory frequency is being limited because the memory modules are exceeding the maximum power limits|DF|
92-
|GPU Memory Temperature Limited|Memory frequency is being limited because the memory modules are exceeding the maximum temperature limits|DF|
93-
|GPU Memory Current Limited|Memory frequency is being limited because the memory modules are exceeding the maximum current limits|DF|
94-
|GPU Memory Voltage Limited|Memory frequency is being limited because the memory modules are exceeding the maximum voltage limits|DF|
95-
|GPU Memory Utilization Limited|Memory frequency is being limited due to low memory traffic|DF|
96-
|CPU Utilization|Amount of CPU processing capacity being used|DF|
97-
|CPU Power Limit|Power limit of the CPU|DS|
98-
|CPU Power|Power consumed by the CPU|DF|
99-
|CPU Temperature|Temperature of the CPU|DF|
100-
|CPU Frequency|Clock speed of the CPU|DF|
101-
|CPU Core Utility|Amount of CPU processing utility being used per core|D|
102-
37+
| Metric | CSV Column | Description | Compatible Query Types |
38+
| - | - | - |:-:|
39+
|Application|Application|Name of the executable of the process being targeted|DS|
40+
||ProcessID|ID of the process being targeted||
41+
|Swap Chain Address|SwapChainAddress|Address of the swap chain used to present, useful as a unique identifier|F|
42+
|GPU Vendor||Vendor name of the GPU|DS|
43+
|GPU Name||Device name of the GPU|DS|
44+
|CPU Vendor||Vendor name of the CPU|DS|
45+
|CPU Name||Device name of the CPU|DS|
46+
|Time|Time|Time elapsed since the start of ETW event tracing|F|
47+
|CPU Frame QPC|CPUFrameQPC|The QueryPerformanceCounter timestamp when the CPU started working on the frame|F|
48+
|Frame Time|FrameTime|The total amount of time in between frames on the CPU|DF|
49+
|CPU Busy|CPUBusy|How long the CPU was generating the frame in milliseconds|DF|
50+
|CPU Wait|CPUWait|How long the CPU spent waiting before it could start generating the frame in milliseconds|DF|
51+
|Displayed FPS||Rate of frame change measurable at display|D|
52+
|Presented FPS||Rate of application calls to a Present() function|D|
53+
|GPU Time|GPUTime|Total amount of time between when GPU started frame and when it finished in milliseconds. The GPU may not have been fully busy during this time|DF|
54+
|GPU Busy|GPUBusy|How long the GPU spent working on this frame|DF|
55+
|GPU Wait|GPUWait|How long the GPU spent waiting while working on this frame|DF|
56+
|Dropped Frames||Indicates if the frame was not displayed|DF|
57+
|Displayed Time|DisplayedTime|How long this frame was displayed on screen|DF|
58+
|Sync Interval|SyncInterval|The application's requested interval between presents measured in vertical sync/vblank events|DF|
59+
|Present Flags|PresentFlags|Flags used to configure the present operation|DF|
60+
|Present Mode|PresentMode|Method used to present the frame|DF|
61+
|Present Runtime|PresentRuntime|The graphics runtime used for the present operation (DXGI, D3D9, etc.)|DF|
62+
|Allows Tearing|AllowsTearing|Indicates if the frame allows tearing|DF|
63+
|GPU Latency|GPULatency|How long it took until GPU work for this frame started|DF|
64+
|Display Latency|DisplayLatency|Time between frame submission and scan out to display|DF|
65+
|Input To Frame Start Latency||Time between input and display|DF|
66+
|Click To Photon Latency|ClickToPhotonLatency|Time between input and display|DF|
67+
|GPU Sustained Power Limit||Sustained power limit of the GPU|DS|
68+
|GPU Power|GPUPower|Power consumed by the graphics adapter|DF|
69+
|GPU Voltage|GPUVoltage|Voltage consumed by the graphics adapter|DF|
70+
|GPU Frequency|GPUFrequency|Clock speed of the GPU cores|DF|
71+
|GPU Temperature|GPUTemperature|Temperature of the GPU|DF|
72+
|GPU Fan Speed|GPUFanSpeed|Rate at which a GPU cooler fan is rotating|DF|
73+
|GPU Utilization|GPUUtilization|Amount of GPU processing capacity being used|DF|
74+
|3D/Compute Utilization|3D/ComputeUtilization|Amount of 3D/Compute processing capacity being used|DF|
75+
|Media Utilization|MediaUtilization|Amount of media processing capacity being used|DF|
76+
|GPU Power Limited|GPUPowerLimited|GPU frequency is being limited because GPU is exceeding maximum power limits|DF|
77+
|GPU Temperature Limited|GPUTemperatureLimited|GPU frequency is being limited because GPU is exceeding maximum temperature limits|DF|
78+
|GPU Current Limited|GPUCurrentLimited|GPU frequency is being limited because GPU is exceeding maximum current limits|DF|
79+
|GPU Voltage Limited|GPUVoltageLimited|GPU frequency is being limited because GPU is exceeding maximum voltage limits|DF|
80+
|GPU Utilization Limited|GPUUtilizationLimited|GPU frequency is being limited due to low GPU utilization|DF|
81+
|GPU Memory Power|GPUMemoryPower|Power consumed by the GPU memory|DF|
82+
|GPU Memory Voltage|GPUMemoryVoltage|Voltage consumed by the GPU memory|DF|
83+
|GPU Memory Frequency|GPUMemoryFrequency|Clock speed of the GPU memory|DF|
84+
|GPU Memory Effective Frequency|GPUMemoryEffectiveFrequency|Effective data transfer rate GPU memory can sustain|DF|
85+
|GPU Memory Temperature|GPUMemoryTemperature|Temperature of the GPU memory|DF|
86+
|GPU Memory Size|GPUMemorySize|Size of the GPU memory|DS|
87+
|GPU Memory Size Used|GPUMemorySizeUsed|Amount of used GPU memory|DF|
88+
|GPU Memory Utilization||Percent of GPU memory used|D|
89+
|GPU Memory Max Bandwidth|GPUMemoryMaxBandwidth|Maximum total GPU memory bandwidth|DS|
90+
|GPU Memory Write Bandwidth|GPUMemoryWriteBandwidth|Maximum GPU memory bandwidth for writing|DF|
91+
|GPU Memory Read Bandwidth|GPUMemoryReadBandwidth|Maximum GPU memory bandwidth for reading|DF|
92+
|GPU Memory Power Limited|GPUMemoryPowerLimited|Memory frequency is being limited because the memory modules are exceeding the maximum power limits|DF|
93+
|GPU Memory Temperature Limited|GPUMemoryTemperatureLimited|Memory frequency is being limited because the memory modules are exceeding the maximum temperature limits|DF|
94+
|GPU Memory Current Limited|GPUMemoryCurrentLimited|Memory frequency is being limited because the memory modules are exceeding the maximum current limits|DF|
95+
|GPU Memory Voltage Limited|GPUMemoryVoltageLimited|Memory frequency is being limited because the memory modules are exceeding the maximum voltage limits|DF|
96+
|GPU Memory Utilization Limited|GPUMemoryUtilizationLimited|Memory frequency is being limited due to low memory traffic|DF|
97+
|CPU Utilization|CPUUtilization|Amount of CPU processing capacity being used|DF|
98+
|CPU Power Limit||Power limit of the CPU|DS|
99+
|CPU Power|CPUPower|Power consumed by the CPU|DF|
100+
|CPU Temperature|CPUTemperature|Temperature of the CPU|DF|
101+
|CPU Frequency|CPUFrequency|Clock speed of the CPU|DF|
102+
|CPU Core Utility||Amount of CPU processing utility being used per core|D|
103103
*Query Type Codes: **D** = Dynamic Query, **F** = Frame Event Query, **S** = Static Query
104104

105105
## Comma-separated value (CSV) file output

0 commit comments

Comments
 (0)