API Reference

MeasureProfiler class methods

Item	Returns	Description
`GetFeatures()`	`enum MeasureFeatures: uint`	[Internal use only] Returns a set of features currently active in the profiler: Bit flags in the `MeasureFeatures` value fully describe the current profiler state. Each bit indicates whether a corresponding feature is currently available: `Ready = 0x1`: Not used `Detach = 0x2`: Not used
`StartCollectingData()`		Starts collecting profiling data. Doesn't throw any errors even if the application is run with profiling disabled.
`StartCollectingData(string groupName)`		[Internal use only] Starts collecting profiling data. Doesn't throw any errors even if the application is run with profiling disabled. `groupName` is the name of the collected data block.
`StopCollectingData()`		Stops collecting profiling data. Current data will persist in memory so next time you start taking measurements with `StartCollectingData()`, the new data will be added to the current data. This method doesn't save the collected data block to the disk. Doesn't throw any errors even if the application is run with profiling disabled. Important! This method is not applicable to the Timeline profiling type and will be ignored by the profiler.
`SaveData()`		Stop collecting data if needed and save all collected data blocks to the disk. After saving a snapshot, the collected data is reset. Doesn't throw any errors even if the application is run with profiling disabled.
`SaveData(string name)`		[Internal use only] Stop collecting data if needed and save all collected data blocks to the disk. After saving a snapshot, the collected data is reset. Doesn't throw any errors even if the application is run with profiling disabled. `name` is the name of the collected data blocks. This is not a file name.
`DropData()`		Stop collecting data if needed and drop all collected data blocks. Doesn't throw any errors even if the application is run with profiling disabled.

SelfAttach class properties

Item

Type

Description

State

enum SelfApiState {None, Inactive, Active}

Indicates the profiler state.

None: the profiler is not available.
Inactive: the profiler is available. Profiling control is not available.
Active: the profiler is available. Profiling can be controlled via API or the controller window.

SelfAttach class methods

Item	Description
`Attach(BaseProfilingConfig baseConfig)`	Attaches the profiler to the calling application with supplied configuration `baseConfig`.
`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. `None`: no control. `Manual`: control through the Controller window. `Api`: control through API.
`ProfilingType`	`enum ProfilingType {Performance, Memory, Timeline}`	Defines the profiling method. `Performance`: performance profiling. `Memory`: memory profiling (used by the dotMemory profiler). `Timeline`: timeline profiling.
`PerformaceMeterKind`	`enum PerformaceMeterKind {Rdtsc, PerformanceCounter, ThreadTime, ThreadCycleTime}`	Defines the time measurement method. `Rdtsc`: real time (CPU instruction). `PerformanceCounter`: real time (performance counter). `ThreadTime`: thread time. `ThreadCycleTime`: thread cycle time.
`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 file name 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 file name for a file which lists snapshots collected during profiling. Required for this configuration. Do NOT create this file manually, it will be created automatically during profiling! Do NOT open this file until the `SelfAttach.State` is in the `None` state!

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.

Last modified: 30 April 2019

Concepts:

Controlling Profiling Session Through API