v8  6.8.275 (node 10.15.3)
V8 is Google's open source JavaScript engine
CpuProfiler Class Reference

#include <v8-profiler.h>

Public Member Functions

void Dispose ()
void SetSamplingInterval (int us)
void StartProfiling (Local< String > title, bool record_samples=false)
CpuProfileStopProfiling (Local< String > title)
 V8_DEPRECATED ("Use static CollectSample(Isolate*) instead.", void CollectSample())
 V8_DEPRECATED ("Use Isolate::SetIdle(bool) instead.", void SetIdle(bool is_idle))

Static Public Member Functions

static CpuProfilerNew (Isolate *isolate)
static void CollectSample (Isolate *isolate)

Detailed Description

Interface for controlling CPU profiling. Instance of the profiler can be created using v8::CpuProfiler::New method.

Definition at line 284 of file v8-profiler.h.

Member Function Documentation

◆ CollectSample()

static void CollectSample ( Isolate isolate)

Synchronously collect current stack sample in all profilers attached to the |isolate|. The call does not affect number of ticks recorded for the current top node.

◆ Dispose()

void Dispose ( )

Disposes the CPU profiler object.

◆ New()

static CpuProfiler* New ( Isolate isolate)

Creates a new CPU profiler for the |isolate|. The isolate must be initialized. The profiler object must be disposed after use by calling |Dispose| method.

◆ SetSamplingInterval()

void SetSamplingInterval ( int  us)

Changes default CPU profiler sampling interval to the specified number of microseconds. Default interval is 1000us. This method must be called when there are no profiles being recorded.

◆ StartProfiling()

void StartProfiling ( Local< String title,
bool  record_samples = false 

Starts collecting CPU profile. Title may be an empty string. It is allowed to have several profiles being collected at once. Attempts to start collecting several profiles with the same title are silently ignored. While collecting a profile, functions from all security contexts are included in it. The token-based filtering is only performed when querying for a profile.

|record_samples| parameter controls whether individual samples should be recorded in addition to the aggregated tree.

◆ StopProfiling()

CpuProfile* StopProfiling ( Local< String title)

Stops collecting CPU profile with a given title and returns it. If the title given is empty, finishes the last profile started.

◆ V8_DEPRECATED() [1/2]

V8_DEPRECATED ( "Use Isolate::SetIdle(bool) instead."  ,
void   SetIdlebool is_idle 

Tells the profiler whether the embedder is idle.

◆ V8_DEPRECATED() [2/2]

V8_DEPRECATED ( "Use static CollectSample(Isolate*) instead."  ,
void   CollectSample() 

Force collection of a sample. Must be called on the VM thread. Recording the forced sample does not contribute to the aggregated profile statistics.

The documentation for this class was generated from the following file: