startSampling method

Future<void> startSampling({
  1. num? samplingInterval,
  2. bool? includeObjectsCollectedByMajorGC,
  3. bool? includeObjectsCollectedByMinorGC,
})

samplingInterval Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes. includeObjectsCollectedByMajorGC By default, the sampling heap profiler reports only objects which are still alive when the profile is returned via getSamplingProfile or stopSampling, which is useful for determining what functions contribute the most to steady-state memory usage. This flag instructs the sampling heap profiler to also include information about objects discarded by major GC, which will show which functions cause large temporary memory usage or long GC pauses. includeObjectsCollectedByMinorGC By default, the sampling heap profiler reports only objects which are still alive when the profile is returned via getSamplingProfile or stopSampling, which is useful for determining what functions contribute the most to steady-state memory usage. This flag instructs the sampling heap profiler to also include information about objects discarded by minor GC, which is useful when tuning a latency-sensitive application for minimal GC activity.

Implementation

Future<void> startSampling(
    {num? samplingInterval,
    bool? includeObjectsCollectedByMajorGC,
    bool? includeObjectsCollectedByMinorGC}) async {
  await _client.send('HeapProfiler.startSampling', {
    if (samplingInterval != null) 'samplingInterval': samplingInterval,
    if (includeObjectsCollectedByMajorGC != null)
      'includeObjectsCollectedByMajorGC': includeObjectsCollectedByMajorGC,
    if (includeObjectsCollectedByMinorGC != null)
      'includeObjectsCollectedByMinorGC': includeObjectsCollectedByMinorGC,
  });
}