1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
from __future__ import annotations
import asyncio
import json
from unittest import mock
import sys
import pytest
from tornado.httpclient import AsyncHTTPClient
from distributed import Event, Worker, wait
from distributed.sizeof import sizeof
from distributed.utils_test import (
fetch_metrics,
fetch_metrics_body,
fetch_metrics_sample_names,
gen_cluster,
)
@gen_cluster(client=True, nthreads=[("127.0.0.1", 1)])
async def test_prometheus(c, s, a):
pytest.importorskip("prometheus_client")
active_metrics = await fetch_metrics_sample_names(
a.http_server.port, prefix="dask_worker_"
)
expected_metrics = {
"dask_worker_concurrent_fetch_requests",
"dask_worker_event_loop_blocked_time_max_seconds",
"dask_worker_event_loop_blocked_time_seconds_total",
"dask_worker_latency_seconds",
"dask_worker_memory_bytes",
"dask_worker_spill_bytes_total",
"dask_worker_spill_count_total",
"dask_worker_spill_time_seconds_total",
"dask_worker_tasks",
"dask_worker_threads",
"dask_worker_tick_count_total",
"dask_worker_tick_duration_maximum_seconds",
"dask_worker_transfer_incoming_bytes",
"dask_worker_transfer_incoming_count",
"dask_worker_transfer_incoming_count_total",
"dask_worker_transfer_outgoing_bytes",
"dask_worker_transfer_outgoing_count",
"dask_worker_transfer_outgoing_count_total",
"dask_worker_transfer_outgoing_bytes_total",
}
try:
import crick # noqa: F401
except ImportError:
pass
else:
expected_metrics.update(
{
"dask_worker_tick_duration_median_seconds",
"dask_worker_task_duration_median_seconds",
"dask_worker_transfer_bandwidth_median_bytes",
}
)
assert active_metrics == expected_metrics
# request data twice since there once was a case where metrics got registered
# multiple times resulting in prometheus_client errors
await fetch_metrics(a.http_server.port, prefix="dask_worker_")
@pytest.fixture
def prometheus_not_available():
import sys
with mock.patch.dict("sys.modules", {"prometheus_client": None}):
sys.modules.pop("distributed.http.worker.prometheus", None)
yield
@gen_cluster(client=True, nthreads=[])
async def test_metrics_when_prometheus_client_not_installed(
c, s, prometheus_not_available
):
async with Worker(s.address) as w:
body = await fetch_metrics_body(w.http_server.port)
assert "Prometheus metrics are not available" in body
@gen_cluster(client=True, nthreads=[("127.0.0.1", 1)])
async def test_prometheus_collect_task_states(c, s, a):
pytest.importorskip("prometheus_client")
async def assert_metrics(**kwargs):
expect = {
"constrained": 0,
"executing": 0,
"fetch": 0,
"flight": 0,
"long-running": 0,
"memory": 0,
"disk": 0,
"missing": 0,
"other": 0,
"ready": 0,
"waiting": 0,
}
expect.update(kwargs)
families = await fetch_metrics(a.http_server.port, prefix="dask_worker_")
actual = {
sample.labels["state"]: sample.value
for sample in families["dask_worker_tasks"].samples
}
assert actual == expect
assert not a.state.tasks
await assert_metrics()
ev = Event()
# submit a task which should show up in the prometheus scraping
future = c.submit(ev.wait)
while not a.state.executing:
await asyncio.sleep(0.001)
await assert_metrics(executing=1)
await ev.set()
await c.gather(future)
await assert_metrics(memory=1)
a.data.evict()
await assert_metrics(disk=1)
future.release()
while future.key in a.state.tasks:
await asyncio.sleep(0.001)
await assert_metrics()
@gen_cluster(client=True)
async def test_health(c, s, a, b):
http_client = AsyncHTTPClient()
response = await http_client.fetch(
"http://localhost:%d/health" % a.http_server.port
)
assert response.code == 200
assert response.headers["Content-Type"] == "text/plain"
txt = response.body.decode("utf8")
assert txt == "ok"
@gen_cluster()
async def test_sitemap(s, a, b):
http_client = AsyncHTTPClient()
response = await http_client.fetch(
"http://localhost:%d/sitemap.json" % a.http_server.port
)
out = json.loads(response.body.decode())
assert "paths" in out
assert "/sitemap.json" in out["paths"]
assert "/health" in out["paths"]
assert "/statics/css/base.css" in out["paths"]
async def fetch_memory_metrics(w: Worker) -> dict[str, float]:
families = await fetch_metrics(w.http_server.port, prefix="dask_worker_")
active_metrics = {
sample.labels["type"]: sample.value
for sample in families["dask_worker_memory_bytes"].samples
}
assert active_metrics.keys() == {"managed", "unmanaged", "spilled"}
return active_metrics
@gen_cluster(client=True, nthreads=[("", 1)])
async def test_prometheus_collect_memory_metrics(c, s, a):
pytest.importorskip("prometheus_client")
metrics = await fetch_memory_metrics(a)
assert metrics["managed"] == 0
assert metrics["spilled"] == 0
assert metrics["unmanaged"] > 50 * 2**20
x = c.submit(lambda: "foo", key="x")
await wait(x)
metrics = await fetch_memory_metrics(a)
assert metrics["managed"] == sizeof("foo")
assert metrics["spilled"] == 0
a.data.evict()
metrics = await fetch_memory_metrics(a)
assert metrics["managed"] == 0
assert metrics["spilled"] > 0
assert metrics["spilled"] != sizeof("foo") # pickled bytes
@gen_cluster(
client=True,
nthreads=[("", 1)],
config={
"distributed.worker.memory.target": False,
"distributed.worker.memory.spill": False,
},
)
async def test_prometheus_collect_memory_metrics_spill_disabled(c, s, a):
pytest.importorskip("prometheus_client")
assert isinstance(a.data, dict)
metrics = await fetch_memory_metrics(a)
assert metrics["managed"] == 0
assert metrics["spilled"] == 0
assert metrics["unmanaged"] > 50 * 2**20
x = c.submit(lambda: "foo", key="x")
await wait(x)
metrics = await fetch_memory_metrics(a)
assert metrics["managed"] == sizeof("foo")
assert metrics["spilled"] == 0
@pytest.mark.skipif(
CONDITION=(sys.maxsize < 2 ** 32),
reason="Fails on 32-bit, seems to be large memory request")
@gen_cluster(
client=True,
nthreads=[("", 1)],
config={
"distributed.worker.memory.target": False,
"distributed.worker.memory.spill": False,
},
)
async def test_prometheus_collect_memory_metrics_bogus_sizeof(c, s, a):
"""Test that managed memory never goes above process memory and that unmanaged
memory never goes below 0, no matter how large the output of sizeof() is
"""
pytest.importorskip("prometheus_client")
metrics = await fetch_memory_metrics(a)
assert metrics["managed"] == 0
assert metrics["unmanaged"] > 50 * 2**20
assert metrics["spilled"] == 0
class C:
def __sizeof__(self):
return 2**40
x = c.submit(C, key="x")
await wait(x)
assert a.state.nbytes > 2**40
metrics = await fetch_memory_metrics(a)
assert 50 * 2**20 < metrics["managed"] < 100 * 2**30 # capped to process memory
assert metrics["unmanaged"] == 0 # floored to 0
assert metrics["spilled"] == 0
@gen_cluster(
client=True,
nthreads=[("127.0.0.1", 1)],
worker_kwargs={"memory_limit": "10 MiB"},
config={
"distributed.worker.memory.target": 1.0,
"distributed.worker.memory.spill": False,
"distributed.worker.memory.pause": False,
},
)
async def test_prometheus_resets_max_metrics(c, s, a):
pytest.importorskip("prometheus_client")
np = pytest.importorskip("numpy")
# The first GET to /metrics calls collect() twice
await fetch_metrics(a.http_server.port)
# We need substantial data to be sure that spilling it will take more than 5ms.
x = c.submit(lambda: "x" * 40_000_000, key="x", workers=[a.address])
await wait(x)
# Key is individually larger than target threshold, so it was spilled immediately
assert "x" in a.data.slow
nsecs = a.digests_max["disk-write-target-duration"]
assert nsecs > 0
families = await fetch_metrics(a.http_server.port)
metric = families["dask_worker_event_loop_blocked_time_max_seconds"]
samples = {sample.labels["cause"]: sample.value for sample in metric.samples}
assert samples["disk-write-target"] == nsecs
assert a.digests_max["disk-write-target-duration"] == 0
|