Skip to content

performance

Metric dataclass

Run-time execution metric.

Source code in zendriver/cdp/performance.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@dataclass
class Metric:
    """
    Run-time execution metric.
    """

    #: Metric name.
    name: str

    #: Metric value.
    value: float

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["name"] = self.name
        json["value"] = self.value
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Metric:
        return cls(
            name=str(json["name"]),
            value=float(json["value"]),
        )

name: str instance-attribute

value: float instance-attribute

__init__(name, value)

from_json(json) classmethod

Source code in zendriver/cdp/performance.py 
35
36
37
38
39
40
@classmethod
def from_json(cls, json: T_JSON_DICT) -> Metric:
    return cls(
        name=str(json["name"]),
        value=float(json["value"]),
    )

to_json()

Source code in zendriver/cdp/performance.py 
29
30
31
32
33
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["name"] = self.name
    json["value"] = self.value
    return json

Metrics dataclass

Current values of the metrics.

Source code in zendriver/cdp/performance.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
@event_class("Performance.metrics")
@dataclass
class Metrics:
    """
    Current values of the metrics.
    """

    #: Current values of the metrics.
    metrics: typing.List[Metric]
    #: Timestamp title.
    title: str

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Metrics:
        return cls(
            metrics=[Metric.from_json(i) for i in json["metrics"]],
            title=str(json["title"]),
        )

metrics: typing.List[Metric] instance-attribute

title: str instance-attribute

__init__(metrics, title)

from_json(json) classmethod

Source code in zendriver/cdp/performance.py 
120
121
122
123
124
125
@classmethod
def from_json(cls, json: T_JSON_DICT) -> Metrics:
    return cls(
        metrics=[Metric.from_json(i) for i in json["metrics"]],
        title=str(json["title"]),
    )

disable()

Disable collecting and reporting metrics.

Source code in zendriver/cdp/performance.py 
43
44
45
46
47
48
49
50
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disable collecting and reporting metrics.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Performance.disable",
    }
    json = yield cmd_dict

enable(time_domain=None)

Enable collecting and reporting metrics.

Parameters:

Name Type Description Default
time_domain Optional[str]

(Optional) Time domain to use for collecting and reporting duration metrics.

 None
Source code in zendriver/cdp/performance.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def enable(
    time_domain: typing.Optional[str] = None,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enable collecting and reporting metrics.

    :param time_domain: *(Optional)* Time domain to use for collecting and reporting duration metrics.
    """
    params: T_JSON_DICT = dict()
    if time_domain is not None:
        params["timeDomain"] = time_domain
    cmd_dict: T_JSON_DICT = {
        "method": "Performance.enable",
        "params": params,
    }
    json = yield cmd_dict

get_metrics()

Retrieve current values of run-time metrics.

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, List[Metric]]

Current values for run-time metrics.
Source code in zendriver/cdp/performance.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
def get_metrics() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[Metric]]:
    """
    Retrieve current values of run-time metrics.

    :returns: Current values for run-time metrics.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Performance.getMetrics",
    }
    json = yield cmd_dict
    return [Metric.from_json(i) for i in json["metrics"]]

set_time_domain(time_domain)

Sets time domain to use for collecting and reporting duration metrics. Note that this must be called before enabling metrics collection. Calling this method while metrics collection is enabled returns an error.

.. deprecated:: 1.3

EXPERIMENTAL

Parameters:

Name Type Description Default
time_domain str

Time domain

 required
Source code in zendriver/cdp/performance.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
@deprecated(version="1.3")
def set_time_domain(
    time_domain: str,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Sets time domain to use for collecting and reporting duration metrics.
    Note that this must be called before enabling metrics collection. Calling
    this method while metrics collection is enabled returns an error.

    .. deprecated:: 1.3

    **EXPERIMENTAL**

    :param time_domain: Time domain
    """
    params: T_JSON_DICT = dict()
    params["timeDomain"] = time_domain
    cmd_dict: T_JSON_DICT = {
        "method": "Performance.setTimeDomain",
        "params": params,
    }
    json = yield cmd_dict