API Reference
PerformanceProfiler class properties
Item | Type | Description |
---|---|---|
| | Indicates whether detach operation is possible. |
| | Indicates whether profiler is active (either attached or the application is executed under profiler). Check this property only ONCE. Your method must do nothing (throw exceptions, etc.) in case |
PerformanceProfiler class methods
Item | Description |
---|---|
| Creates a blank snapshot. |
| Starts collecting performance data. |
| Stops collecting performance data. Current data will persist in memory so next time you |
| Stops taking performance measurements and opens a snapshot with current data in the profiler. After opening the snapshot, measurement data is reset. |
| Stops taking performance measurements and resets current measurement data. |
| Detaches profiler from an application. |
TimelineProfiler class properties
Item | Type | Description |
---|---|---|
| | Indicates whether detach operation is possible. |
| | Indicates whether profiler is active (either attached or the application is executed under profiler). |
TimelineProfiler class methods
Item | Description |
---|---|
| Creates a blank snapshot and starts collecting timeline data. |
| Stops taking measurements and opens a snapshot with current data in the profiler. After opening the snapshot, measurement data is reset. |
| Stops taking performance measurements and resets current measurement data. |
| Detaches profiler from an application. |
SelfAttach class properties
Item | Type | Description |
---|---|---|
| | Indicates the profiler state:
|
SelfAttach class methods
Item | Description |
---|---|
| Attaches the profiler to the calling application with supplied configuration |
| Shows the profiling controller to a user. |
BaseProfilingConfig class public fields
Item | Type | Description |
---|---|---|
| | Defines the profiling control method:
|
| | Defines the profiling method:
|
| | Defines the time measurement method:
|
| | 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 |
---|---|---|
| | Defines a path and a base file name for the resulting snapshot. Required for this configuration. |
| | Defines a file format for a snapshot: compressed or uncompressed. By default, it is compressed. |
SaveSnapshotProfilingConfig class public fields
Item | Type | Description |
---|---|---|
| | Defines a file name for a file which lists snapshots collected during profiling. Required for this configuration. |
ExecutableSnapshotProfilingConfig class public fields
Item | Type | Description |
---|---|---|
| | 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. |