API Reference
MeasureProfiler class methods
Item | Returns | Description |
---|---|---|
GetFeatures() | enum MeasureFeatures: uint | Returns a set of features currently active in the profiler: Bit flags in the
|
StartCollectingData() | Start collecting profiling data. | |
StartCollectingData(string groupName) | [Internal use only] | |
StopCollectingData() | Stop collecting profiling data. Current data will persist in memory so next time you start taking measurements with | |
SaveData() | Stop collecting data if needed and save all collected data blocks to the disk. | |
SaveData(string name) | [Internal use only] | |
Detach() | Detach the profiler from the profiled process. Does nothing if detaching is disabled in the profiler. To check whether the detaching is enabled, use | |
DropData() | Stop collecting data if needed and drop all collected data blocks. |
The profiling API
The self-profiling API
SelfAttach class properties
Item | Type | Description |
---|---|---|
State | enum SelfApiState {None, Inactive, Active} | Indicates the profiler state.
|
SelfAttach class methods
Item | Description |
---|---|
Attach(BaseProfilingConfig baseConfig) | Attaches the profiler to the calling application with supplied configuration |
Show() | Shows the profiling controller to a user. |
BaseProfilingConfig class public fields
Item | Type | Description |
---|---|---|
ProfilingControlKind | enum ProfilingControlKind {None, Manual, Api} | Defines the profiling control method.
|
ProfilingType | enum ProfilingType {Performance, Memory, Timeline} | Defines the profiling method.
|
PerformaceMeterKind | enum PerformaceMeterKind {Rdtsc, PerformanceCounter, ThreadTime, ThreadCycleTime} | Defines the time measurement method.
|
RedistDir | string | Defines location of dotTrace SDK redistributables. By default, they are searched in the same folder where JetBrains.Profiler.Windows.Api.dll is located. |
BaseSnapshotProfilingConfig class public fields
Item | Type | Description |
---|---|---|
SaveDir | string | Defines a path and a base filename for the resulting snapshot. Required for this configuration. |
SnapshotFormat | enum {Compressed, Uncompressed} | Defines a file format for a snapshot: compressed or uncompressed. By default, it is compressed. |
SaveSnapshotProfilingConfig class public fields
Item | Type | Description |
---|---|---|
ListFile | string | Defines a filename for a file which lists snapshots collected during profiling. Required for this configuration. |
ExecutableSnapshotProfilingConfig class public fields
Item | Type | Description |
---|---|---|
Executable | string | Defines the path to the executable file to run after profiling is completed. The snapshot path will be passed as a parameter to this executable file. Required for this configuration. |