Function get_metric_float

python/ray/serve/_private/test_utils.py:1551–1573

Gets the float value of metric. If tags is specified, searched for metric with matching tags. Returns -1 if the metric isn't available.

(
    metric: str,
    expected_tags: Optional[Dict[str, str]],
    timeseries: Optional[PrometheusTimeseries] = None,
    timeout: float = 20,
)

def get_metric_float(
    metric: str,
    expected_tags: Optional[Dict[str, str]],
    timeseries: Optional[PrometheusTimeseries] = None,
    timeout: float = 20,
) -> float:
    """Gets the float value of metric.

    If tags is specified, searched for metric with matching tags.

    Returns -1 if the metric isn't available.
    """
    if timeseries is None:
        timeseries = PrometheusTimeseries()
    samples = fetch_prometheus_metric_timeseries(
        [f"localhost:{TEST_METRICS_EXPORT_PORT}"],
        timeseries,
        timeout=timeout,
    ).get(metric, [])
    for sample in samples:
        if expected_tags.items() <= sample.labels.items():
            return sample.value
    return -1


def check_metric_float_eq(