11623       <description>
11624         Start the heap sampler in the JVM. The function provides, via its argument, the sampling
11625         rate requested and will fill internal data structures with heap allocation samples. The
11626         samples are obtained via the <functionlink id="GetLiveTraces"></functionlink>,
11627         <functionlink id="GetGarbageTraces"></functionlink>, <functionlink id="GetFrequentGarbageTraces"></functionlink>,
11628         functions.
11629 
11630         Starting the heap sampler resets internal traces and counters. Therefore stopping the sampler
11631         puts internal trace samples and counters on pause for post-processing.
11632       </description>
11633       <origin>new</origin>
11634       <capabilities>
11635         <required id="can_sample_heap"></required>
11636       </capabilities>
11637       <parameters>
11638         <param id="monitoring_rate">
11639           <jint/>
11640           <description>
11641             The monitoring rate used for sampling. The sampler will use a statistical approach to
11642             provide in average sampling every <paramlink id="monitoring_rate"/> allocated bytes.



11643           </description>
11644         </param>
11645         <param id="max_storage">
11646           <jint/>
11647           <description>
11648             The maximum storage used for the sampler. By default, the value is 200.
11649           </description>
11650         </param>
11651       </parameters>
11652       <errors>
11653         <error id="JVMTI_ERROR_ILLEGAL_ARGUMENT">
11654           <paramlink id="monitoring_period"></paramlink> is less than zero.
11655         </error>
11656       </errors>
11657     </function>
11658 
11659     <function id="StopHeapSampling" phase="any" num="157">
11660       <synopsis>Stop Heap Sampling</synopsis>
11661       <description>
11662         Stop the heap sampler in the JVM.

11623       <description>
11624         Start the heap sampler in the JVM. The function provides, via its argument, the sampling
11625         rate requested and will fill internal data structures with heap allocation samples. The
11626         samples are obtained via the <functionlink id="GetLiveTraces"></functionlink>,
11627         <functionlink id="GetGarbageTraces"></functionlink>, <functionlink id="GetFrequentGarbageTraces"></functionlink>,
11628         functions.
11629 
11630         Starting the heap sampler resets internal traces and counters. Therefore stopping the sampler
11631         puts internal trace samples and counters on pause for post-processing.
11632       </description>
11633       <origin>new</origin>
11634       <capabilities>
11635         <required id="can_sample_heap"></required>
11636       </capabilities>
11637       <parameters>
11638         <param id="monitoring_rate">
11639           <jint/>
11640           <description>
11641             The monitoring rate used for sampling. The sampler will use a statistical approach to
11642             provide in average sampling every <paramlink id="monitoring_rate"/> allocated bytes.
11643 
11644             Note: a low monitoring rate will incur a higher overhead, therefore, the sampler should
11645             only be used when knowing it may impact performance.
11646           </description>
11647         </param>
11648         <param id="max_storage">
11649           <jint/>
11650           <description>
11651             The maximum storage used for the sampler. By default, the value is 200.
11652           </description>
11653         </param>
11654       </parameters>
11655       <errors>
11656         <error id="JVMTI_ERROR_ILLEGAL_ARGUMENT">
11657           <paramlink id="monitoring_period"></paramlink> is less than zero.
11658         </error>
11659       </errors>
11660     </function>
11661 
11662     <function id="StopHeapSampling" phase="any" num="157">
11663       <synopsis>Stop Heap Sampling</synopsis>
11664       <description>
11665         Stop the heap sampler in the JVM.