heap_profiler

AddHeapSnapshotChunk dataclass

Source code in zendriver/cdp/heap_profiler.py

@event_class("HeapProfiler.addHeapSnapshotChunk")
@dataclass
class AddHeapSnapshotChunk:
    chunk: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> AddHeapSnapshotChunk:
        return cls(chunk=str(json["chunk"]))

chunk: str instance-attribute

__init__(chunk)

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> AddHeapSnapshotChunk:
    return cls(chunk=str(json["chunk"]))

HeapSnapshotObjectId

Bases: str

Heap snapshot object id.

Source code in zendriver/cdp/heap_profiler.py

class HeapSnapshotObjectId(str):
    """
    Heap snapshot object id.
    """

    def to_json(self) -> str:
        return self

    @classmethod
    def from_json(cls, json: str) -> HeapSnapshotObjectId:
        return cls(json)

    def __repr__(self):
        return "HeapSnapshotObjectId({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/heap_profiler.py

def __repr__(self):
    return "HeapSnapshotObjectId({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: str) -> HeapSnapshotObjectId:
    return cls(json)

to_json()

Source code in zendriver/cdp/heap_profiler.py

def to_json(self) -> str:
    return self

HeapStatsUpdate dataclass

If heap objects tracking has been started then backend may send update for one or more fragments

Source code in zendriver/cdp/heap_profiler.py

@event_class("HeapProfiler.heapStatsUpdate")
@dataclass
class HeapStatsUpdate:
    """
    If heap objects tracking has been started then backend may send update for one or more fragments
    """

    #: An array of triplets. Each triplet describes a fragment. The first integer is the fragment
    #: index, the second integer is a total count of objects for the fragment, the third integer is
    #: a total size of the objects for the fragment.
    stats_update: typing.List[int]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> HeapStatsUpdate:
        return cls(stats_update=[int(i) for i in json["statsUpdate"]])

stats_update: typing.List[int] instance-attribute

__init__(stats_update)

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> HeapStatsUpdate:
    return cls(stats_update=[int(i) for i in json["statsUpdate"]])

LastSeenObjectId dataclass

If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.

Source code in zendriver/cdp/heap_profiler.py

@event_class("HeapProfiler.lastSeenObjectId")
@dataclass
class LastSeenObjectId:
    """
    If heap objects tracking has been started then backend regularly sends a current value for last
    seen object id and corresponding timestamp. If the were changes in the heap since last event
    then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.
    """

    last_seen_object_id: int
    timestamp: float

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LastSeenObjectId:
        return cls(
            last_seen_object_id=int(json["lastSeenObjectId"]),
            timestamp=float(json["timestamp"]),
        )

last_seen_object_id: int instance-attribute

timestamp: float instance-attribute

__init__(last_seen_object_id, timestamp)

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> LastSeenObjectId:
    return cls(
        last_seen_object_id=int(json["lastSeenObjectId"]),
        timestamp=float(json["timestamp"]),
    )

ReportHeapSnapshotProgress dataclass

Source code in zendriver/cdp/heap_profiler.py

@event_class("HeapProfiler.reportHeapSnapshotProgress")
@dataclass
class ReportHeapSnapshotProgress:
    done: int
    total: int
    finished: typing.Optional[bool]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ReportHeapSnapshotProgress:
        return cls(
            done=int(json["done"]),
            total=int(json["total"]),
            finished=bool(json["finished"])
            if json.get("finished", None) is not None
            else None,
        )

done: int instance-attribute

finished: typing.Optional[bool] instance-attribute

total: int instance-attribute

__init__(done, total, finished)

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ReportHeapSnapshotProgress:
    return cls(
        done=int(json["done"]),
        total=int(json["total"]),
        finished=bool(json["finished"])
        if json.get("finished", None) is not None
        else None,
    )

ResetProfiles dataclass

Source code in zendriver/cdp/heap_profiler.py

@event_class("HeapProfiler.resetProfiles")
@dataclass
class ResetProfiles:
    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ResetProfiles:
        return cls()

__init__()

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> ResetProfiles:
    return cls()

SamplingHeapProfile dataclass

Sampling profile.

Source code in zendriver/cdp/heap_profiler.py

@dataclass
class SamplingHeapProfile:
    """
    Sampling profile.
    """

    head: SamplingHeapProfileNode

    samples: typing.List[SamplingHeapProfileSample]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["head"] = self.head.to_json()
        json["samples"] = [i.to_json() for i in self.samples]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SamplingHeapProfile:
        return cls(
            head=SamplingHeapProfileNode.from_json(json["head"]),
            samples=[SamplingHeapProfileSample.from_json(i) for i in json["samples"]],
        )

head: SamplingHeapProfileNode instance-attribute

samples: typing.List[SamplingHeapProfileSample] instance-attribute

__init__(head, samples)

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SamplingHeapProfile:
    return cls(
        head=SamplingHeapProfileNode.from_json(json["head"]),
        samples=[SamplingHeapProfileSample.from_json(i) for i in json["samples"]],
    )

to_json()

Source code in zendriver/cdp/heap_profiler.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["head"] = self.head.to_json()
    json["samples"] = [i.to_json() for i in self.samples]
    return json

SamplingHeapProfileNode dataclass

Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.

Source code in zendriver/cdp/heap_profiler.py

@dataclass
class SamplingHeapProfileNode:
    """
    Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.
    """

    #: Function location.
    call_frame: runtime.CallFrame

    #: Allocations size in bytes for the node excluding children.
    self_size: float

    #: Node id. Ids are unique across all profiles collected between startSampling and stopSampling.
    id_: int

    #: Child nodes.
    children: typing.List[SamplingHeapProfileNode]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["callFrame"] = self.call_frame.to_json()
        json["selfSize"] = self.self_size
        json["id"] = self.id_
        json["children"] = [i.to_json() for i in self.children]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SamplingHeapProfileNode:
        return cls(
            call_frame=runtime.CallFrame.from_json(json["callFrame"]),
            self_size=float(json["selfSize"]),
            id_=int(json["id"]),
            children=[SamplingHeapProfileNode.from_json(i) for i in json["children"]],
        )

call_frame: runtime.CallFrame instance-attribute

children: typing.List[SamplingHeapProfileNode] instance-attribute

id_: int instance-attribute

self_size: float instance-attribute

__init__(call_frame, self_size, id_, children)

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SamplingHeapProfileNode:
    return cls(
        call_frame=runtime.CallFrame.from_json(json["callFrame"]),
        self_size=float(json["selfSize"]),
        id_=int(json["id"]),
        children=[SamplingHeapProfileNode.from_json(i) for i in json["children"]],
    )

to_json()

Source code in zendriver/cdp/heap_profiler.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["callFrame"] = self.call_frame.to_json()
    json["selfSize"] = self.self_size
    json["id"] = self.id_
    json["children"] = [i.to_json() for i in self.children]
    return json

SamplingHeapProfileSample dataclass

A single sample from a sampling profile.

Source code in zendriver/cdp/heap_profiler.py

@dataclass
class SamplingHeapProfileSample:
    """
    A single sample from a sampling profile.
    """

    #: Allocation size in bytes attributed to the sample.
    size: float

    #: Id of the corresponding profile tree node.
    node_id: int

    #: Time-ordered sample ordinal number. It is unique across all profiles retrieved
    #: between startSampling and stopSampling.
    ordinal: float

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["size"] = self.size
        json["nodeId"] = self.node_id
        json["ordinal"] = self.ordinal
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> SamplingHeapProfileSample:
        return cls(
            size=float(json["size"]),
            node_id=int(json["nodeId"]),
            ordinal=float(json["ordinal"]),
        )

node_id: int instance-attribute

ordinal: float instance-attribute

size: float instance-attribute

__init__(size, node_id, ordinal)

from_json(json) classmethod

Source code in zendriver/cdp/heap_profiler.py

@classmethod
def from_json(cls, json: T_JSON_DICT) -> SamplingHeapProfileSample:
    return cls(
        size=float(json["size"]),
        node_id=int(json["nodeId"]),
        ordinal=float(json["ordinal"]),
    )

to_json()

Source code in zendriver/cdp/heap_profiler.py

def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["size"] = self.size
    json["nodeId"] = self.node_id
    json["ordinal"] = self.ordinal
    return json

add_inspected_heap_object(heap_object_id)

Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).

Parameters:

Name	Type	Description	Default
heap_object_id	HeapSnapshotObjectId	Heap snapshot object id to be accessible by means of $x command line API.	required

Source code in zendriver/cdp/heap_profiler.py

def add_inspected_heap_object(
    heap_object_id: HeapSnapshotObjectId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables console to refer to the node with given id via $x (see Command Line API for more details
    $x functions).

    :param heap_object_id: Heap snapshot object id to be accessible by means of $x command line API.
    """
    params: T_JSON_DICT = dict()
    params["heapObjectId"] = heap_object_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.addInspectedHeapObject",
        "params": params,
    }
    json = yield cmd_dict

collect_garbage()

Source code in zendriver/cdp/heap_profiler.py

def collect_garbage() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.collectGarbage",
    }
    json = yield cmd_dict

disable()

Source code in zendriver/cdp/heap_profiler.py

def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.disable",
    }
    json = yield cmd_dict

enable()

Source code in zendriver/cdp/heap_profiler.py

def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.enable",
    }
    json = yield cmd_dict

get_heap_object_id(object_id)

Parameters:

Name	Type	Description	Default
object_id	RemoteObjectId	Identifier of the object to get heap object id for.	required

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, HeapSnapshotObjectId]	Id of the heap snapshot object corresponding to the passed remote object id.

Source code in zendriver/cdp/heap_profiler.py

def get_heap_object_id(
    object_id: runtime.RemoteObjectId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, HeapSnapshotObjectId]:
    """
    :param object_id: Identifier of the object to get heap object id for.
    :returns: Id of the heap snapshot object corresponding to the passed remote object id.
    """
    params: T_JSON_DICT = dict()
    params["objectId"] = object_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.getHeapObjectId",
        "params": params,
    }
    json = yield cmd_dict
    return HeapSnapshotObjectId.from_json(json["heapSnapshotObjectId"])

get_object_by_heap_object_id(object_id, object_group=None)

Parameters:

Name	Type	Description	Default
object_id	HeapSnapshotObjectId		required
object_group	Optional[str]	(Optional) Symbolic group name that can be used to release multiple objects.	None

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, RemoteObject]	Evaluation result.

Source code in zendriver/cdp/heap_profiler.py

def get_object_by_heap_object_id(
    object_id: HeapSnapshotObjectId, object_group: typing.Optional[str] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, runtime.RemoteObject]:
    """
    :param object_id:
    :param object_group: *(Optional)* Symbolic group name that can be used to release multiple objects.
    :returns: Evaluation result.
    """
    params: T_JSON_DICT = dict()
    params["objectId"] = object_id.to_json()
    if object_group is not None:
        params["objectGroup"] = object_group
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.getObjectByHeapObjectId",
        "params": params,
    }
    json = yield cmd_dict
    return runtime.RemoteObject.from_json(json["result"])

get_sampling_profile()

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, SamplingHeapProfile]	Return the sampling profile being collected.

Source code in zendriver/cdp/heap_profiler.py

def get_sampling_profile() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, SamplingHeapProfile]
):
    """


    :returns: Return the sampling profile being collected.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.getSamplingProfile",
    }
    json = yield cmd_dict
    return SamplingHeapProfile.from_json(json["profile"])

start_sampling(sampling_interval=None, include_objects_collected_by_major_gc=None, include_objects_collected_by_minor_gc=None)

Parameters:

Name	Type	Description	Default
sampling_interval	Optional[float]	(Optional) Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes.	None
include_objects_collected_by_major_gc	Optional[bool]	(Optional) 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.	None
include_objects_collected_by_minor_gc	Optional[bool]	(Optional) 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.	None

Source code in zendriver/cdp/heap_profiler.py

def start_sampling(
    sampling_interval: typing.Optional[float] = None,
    include_objects_collected_by_major_gc: typing.Optional[bool] = None,
    include_objects_collected_by_minor_gc: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param sampling_interval: *(Optional)* Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes.
    :param include_objects_collected_by_major_gc: *(Optional)* 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.
    :param include_objects_collected_by_minor_gc: *(Optional)* 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.
    """
    params: T_JSON_DICT = dict()
    if sampling_interval is not None:
        params["samplingInterval"] = sampling_interval
    if include_objects_collected_by_major_gc is not None:
        params["includeObjectsCollectedByMajorGC"] = (
            include_objects_collected_by_major_gc
        )
    if include_objects_collected_by_minor_gc is not None:
        params["includeObjectsCollectedByMinorGC"] = (
            include_objects_collected_by_minor_gc
        )
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.startSampling",
        "params": params,
    }
    json = yield cmd_dict

start_tracking_heap_objects(track_allocations=None)

Parameters:

Name	Type	Description	Default
track_allocations	Optional[bool]	(Optional)	None

Source code in zendriver/cdp/heap_profiler.py

def start_tracking_heap_objects(
    track_allocations: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param track_allocations: *(Optional)*
    """
    params: T_JSON_DICT = dict()
    if track_allocations is not None:
        params["trackAllocations"] = track_allocations
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.startTrackingHeapObjects",
        "params": params,
    }
    json = yield cmd_dict

stop_sampling()

Returns:

Type	Description
Generator[T_JSON_DICT, T_JSON_DICT, SamplingHeapProfile]	Recorded sampling heap profile.

Source code in zendriver/cdp/heap_profiler.py

def stop_sampling() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, SamplingHeapProfile]:
    """


    :returns: Recorded sampling heap profile.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.stopSampling",
    }
    json = yield cmd_dict
    return SamplingHeapProfile.from_json(json["profile"])

stop_tracking_heap_objects(report_progress=None, treat_global_objects_as_roots=None, capture_numeric_value=None, expose_internals=None)

Parameters:

Name	Type	Description	Default
report_progress	Optional[bool]	(Optional) If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped.	None
treat_global_objects_as_roots	Optional[bool]	(DEPRECATED) (Optional) Deprecated in favor of exposeInternals.	None
capture_numeric_value	Optional[bool]	(Optional) If true, numerical values are included in the snapshot	None
expose_internals	Optional[bool]	(EXPERIMENTAL) (Optional) If true, exposes internals of the snapshot.	None

Source code in zendriver/cdp/heap_profiler.py

def stop_tracking_heap_objects(
    report_progress: typing.Optional[bool] = None,
    treat_global_objects_as_roots: typing.Optional[bool] = None,
    capture_numeric_value: typing.Optional[bool] = None,
    expose_internals: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param report_progress: *(Optional)* If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped.
    :param treat_global_objects_as_roots: **(DEPRECATED)** *(Optional)* Deprecated in favor of ```exposeInternals```.
    :param capture_numeric_value: *(Optional)* If true, numerical values are included in the snapshot
    :param expose_internals: **(EXPERIMENTAL)** *(Optional)* If true, exposes internals of the snapshot.
    """
    params: T_JSON_DICT = dict()
    if report_progress is not None:
        params["reportProgress"] = report_progress
    if treat_global_objects_as_roots is not None:
        params["treatGlobalObjectsAsRoots"] = treat_global_objects_as_roots
    if capture_numeric_value is not None:
        params["captureNumericValue"] = capture_numeric_value
    if expose_internals is not None:
        params["exposeInternals"] = expose_internals
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.stopTrackingHeapObjects",
        "params": params,
    }
    json = yield cmd_dict

take_heap_snapshot(report_progress=None, treat_global_objects_as_roots=None, capture_numeric_value=None, expose_internals=None)

Parameters:

Name	Type	Description	Default
report_progress	Optional[bool]	(Optional) If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.	None
treat_global_objects_as_roots	Optional[bool]	(DEPRECATED) (Optional) If true, a raw snapshot without artificial roots will be generated. Deprecated in favor of exposeInternals.	None
capture_numeric_value	Optional[bool]	(Optional) If true, numerical values are included in the snapshot	None
expose_internals	Optional[bool]	(EXPERIMENTAL) (Optional) If true, exposes internals of the snapshot.	None

Source code in zendriver/cdp/heap_profiler.py

def take_heap_snapshot(
    report_progress: typing.Optional[bool] = None,
    treat_global_objects_as_roots: typing.Optional[bool] = None,
    capture_numeric_value: typing.Optional[bool] = None,
    expose_internals: typing.Optional[bool] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    :param report_progress: *(Optional)* If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.
    :param treat_global_objects_as_roots: **(DEPRECATED)** *(Optional)* If true, a raw snapshot without artificial roots will be generated. Deprecated in favor of ```exposeInternals```.
    :param capture_numeric_value: *(Optional)* If true, numerical values are included in the snapshot
    :param expose_internals: **(EXPERIMENTAL)** *(Optional)* If true, exposes internals of the snapshot.
    """
    params: T_JSON_DICT = dict()
    if report_progress is not None:
        params["reportProgress"] = report_progress
    if treat_global_objects_as_roots is not None:
        params["treatGlobalObjectsAsRoots"] = treat_global_objects_as_roots
    if capture_numeric_value is not None:
        params["captureNumericValue"] = capture_numeric_value
    if expose_internals is not None:
        params["exposeInternals"] = expose_internals
    cmd_dict: T_JSON_DICT = {
        "method": "HeapProfiler.takeHeapSnapshot",
        "params": params,
    }
    json = yield cmd_dict