HeapProfilerClientStartSamplingAsync Method

public Task<DevToolsMethodResponse> StartSamplingAsync(
	double? samplingInterval = null,
	bool? includeObjectsCollectedByMajorGC = null,
	bool? includeObjectsCollectedByMinorGC = null
)

public:
Task<DevToolsMethodResponse^>^ StartSamplingAsync(
	Nullable<double> samplingInterval = nullptr, 
	Nullable<bool> includeObjectsCollectedByMajorGC = nullptr, 
	Nullable<bool> includeObjectsCollectedByMinorGC = nullptr
)

Parameters

samplingInterval (Optional)

Type: SystemNullableDouble
Average sample interval in bytes. Poisson distribution is used for the intervals. Thedefault value is 32768 bytes.

includeObjectsCollectedByMajorGC (Optional)

Type: SystemNullableBoolean
By default, the sampling heap profiler reports only objects which arestill alive when the profile is returned via getSamplingProfile orstopSampling, which is useful for determining what functions contributethe most to steady-state memory usage. This flag instructs the samplingheap profiler to also include information about objects discarded bymajor GC, which will show which functions cause large temporary memoryusage or long GC pauses.

includeObjectsCollectedByMinorGC (Optional)

Type: SystemNullableBoolean
By default, the sampling heap profiler reports only objects which arestill alive when the profile is returned via getSamplingProfile orstopSampling, which is useful for determining what functions contributethe most to steady-state memory usage. This flag instructs the samplingheap profiler to also include information about objects discarded byminor GC, which is useful when tuning a latency-sensitive applicationfor minimal GC activity.

Return Value

Reference