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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
|
import threading
import time
from collections import defaultdict
from unittest import mock
import pytest
import sentry_sdk
from sentry_sdk.consts import VERSION
from sentry_sdk.profiler.continuous_profiler import (
get_profiler_id,
setup_continuous_profiler,
start_profiler,
stop_profiler,
)
from tests.conftest import ApproxDict
try:
import gevent
except ImportError:
gevent = None
requires_gevent = pytest.mark.skipif(gevent is None, reason="gevent not enabled")
def get_client_options(use_top_level_profiler_mode):
def client_options(
mode=None, auto_start=None, profile_session_sample_rate=1.0, lifecycle="manual"
):
if use_top_level_profiler_mode:
return {
"profile_lifecycle": lifecycle,
"profiler_mode": mode,
"profile_session_sample_rate": profile_session_sample_rate,
"_experiments": {
"continuous_profiling_auto_start": auto_start,
},
}
return {
"profile_lifecycle": lifecycle,
"profile_session_sample_rate": profile_session_sample_rate,
"_experiments": {
"continuous_profiling_auto_start": auto_start,
"continuous_profiling_mode": mode,
},
}
return client_options
mock_sdk_info = {
"name": "sentry.python",
"version": VERSION,
"packages": [{"name": "pypi:sentry-sdk", "version": VERSION}],
}
@pytest.mark.parametrize("mode", [pytest.param("foo")])
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
def test_continuous_profiler_invalid_mode(mode, make_options, teardown_profiling):
with pytest.raises(ValueError):
setup_continuous_profiler(
make_options(mode=mode),
mock_sdk_info,
lambda envelope: None,
)
@pytest.mark.parametrize(
"mode",
[
pytest.param("thread"),
pytest.param("gevent", marks=requires_gevent),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
def test_continuous_profiler_valid_mode(mode, make_options, teardown_profiling):
options = make_options(mode=mode)
setup_continuous_profiler(
options,
mock_sdk_info,
lambda envelope: None,
)
@pytest.mark.parametrize(
"mode",
[
pytest.param("thread"),
pytest.param("gevent", marks=requires_gevent),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
def test_continuous_profiler_setup_twice(mode, make_options, teardown_profiling):
options = make_options(mode=mode)
# setting up the first time should return True to indicate success
assert setup_continuous_profiler(
options,
mock_sdk_info,
lambda envelope: None,
)
# setting up the second time should return False to indicate no-op
assert not setup_continuous_profiler(
options,
mock_sdk_info,
lambda envelope: None,
)
def assert_single_transaction_with_profile_chunks(
envelopes, thread, max_chunks=None, transactions=1
):
items = defaultdict(list)
for envelope in envelopes:
for item in envelope.items:
items[item.type].append(item)
assert len(items["transaction"]) == transactions
assert len(items["profile_chunk"]) > 0
if max_chunks is not None:
assert len(items["profile_chunk"]) <= max_chunks
transaction = items["transaction"][0].payload.json
trace_context = transaction["contexts"]["trace"]
assert trace_context == ApproxDict(
{
"data": ApproxDict(
{
"thread.id": str(thread.ident),
"thread.name": thread.name,
}
),
}
)
profile_context = transaction["contexts"]["profile"]
profiler_id = profile_context["profiler_id"]
assert profile_context == ApproxDict({"profiler_id": profiler_id})
spans = transaction["spans"]
assert len(spans) > 0
for span in spans:
assert span["data"] == ApproxDict(
{
"profiler_id": profiler_id,
"thread.id": str(thread.ident),
"thread.name": thread.name,
}
)
for profile_chunk_item in items["profile_chunk"]:
profile_chunk = profile_chunk_item.payload.json
del profile_chunk["profile"] # make the diff easier to read
assert profile_chunk == ApproxDict(
{
"client_sdk": {
"name": mock.ANY,
"version": VERSION,
},
"platform": "python",
"profiler_id": profiler_id,
"version": "2",
}
)
def assert_single_transaction_without_profile_chunks(envelopes):
items = defaultdict(list)
for envelope in envelopes:
for item in envelope.items:
items[item.type].append(item)
assert len(items["transaction"]) == 1
assert len(items["profile_chunk"]) == 0
transaction = items["transaction"][0].payload.json
assert "profile" not in transaction["contexts"]
@pytest.mark.forked
@pytest.mark.parametrize(
"mode",
[
pytest.param("thread"),
pytest.param("gevent", marks=requires_gevent),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
@mock.patch("sentry_sdk.profiler.continuous_profiler.PROFILE_BUFFER_SECONDS", 0.01)
def test_continuous_profiler_auto_start_and_manual_stop(
sentry_init,
capture_envelopes,
mode,
make_options,
teardown_profiling,
):
options = make_options(mode=mode, auto_start=True)
sentry_init(
traces_sample_rate=1.0,
**options,
)
envelopes = capture_envelopes()
thread = threading.current_thread()
with sentry_sdk.start_transaction(name="profiling"):
with sentry_sdk.start_span(op="op"):
time.sleep(0.05)
assert_single_transaction_with_profile_chunks(envelopes, thread)
for _ in range(3):
stop_profiler()
envelopes.clear()
with sentry_sdk.start_transaction(name="profiling"):
with sentry_sdk.start_span(op="op"):
time.sleep(0.05)
assert_single_transaction_without_profile_chunks(envelopes)
start_profiler()
envelopes.clear()
with sentry_sdk.start_transaction(name="profiling"):
with sentry_sdk.start_span(op="op"):
time.sleep(0.05)
assert_single_transaction_with_profile_chunks(envelopes, thread)
@pytest.mark.parametrize(
"mode",
[
pytest.param("thread"),
pytest.param("gevent", marks=requires_gevent),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
@mock.patch("sentry_sdk.profiler.continuous_profiler.PROFILE_BUFFER_SECONDS", 0.01)
def test_continuous_profiler_manual_start_and_stop_sampled(
sentry_init,
capture_envelopes,
mode,
make_options,
teardown_profiling,
):
options = make_options(
mode=mode, profile_session_sample_rate=1.0, lifecycle="manual"
)
sentry_init(
traces_sample_rate=1.0,
**options,
)
envelopes = capture_envelopes()
thread = threading.current_thread()
for _ in range(3):
start_profiler()
envelopes.clear()
with sentry_sdk.start_transaction(name="profiling"):
assert get_profiler_id() is not None, "profiler should be running"
with sentry_sdk.start_span(op="op"):
time.sleep(0.1)
assert get_profiler_id() is not None, "profiler should be running"
assert_single_transaction_with_profile_chunks(envelopes, thread)
assert get_profiler_id() is not None, "profiler should be running"
stop_profiler()
# the profiler stops immediately in manual mode
assert get_profiler_id() is None, "profiler should not be running"
envelopes.clear()
with sentry_sdk.start_transaction(name="profiling"):
assert get_profiler_id() is None, "profiler should not be running"
with sentry_sdk.start_span(op="op"):
time.sleep(0.1)
assert get_profiler_id() is None, "profiler should not be running"
assert_single_transaction_without_profile_chunks(envelopes)
@pytest.mark.parametrize(
"mode",
[
pytest.param("thread"),
pytest.param("gevent", marks=requires_gevent),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
def test_continuous_profiler_manual_start_and_stop_unsampled(
sentry_init,
capture_envelopes,
mode,
make_options,
teardown_profiling,
):
options = make_options(
mode=mode, profile_session_sample_rate=0.0, lifecycle="manual"
)
sentry_init(
traces_sample_rate=1.0,
**options,
)
envelopes = capture_envelopes()
start_profiler()
with sentry_sdk.start_transaction(name="profiling"):
with sentry_sdk.start_span(op="op"):
time.sleep(0.05)
assert_single_transaction_without_profile_chunks(envelopes)
stop_profiler()
@pytest.mark.parametrize(
"mode",
[
pytest.param("thread"),
pytest.param("gevent", marks=requires_gevent),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
@mock.patch("sentry_sdk.profiler.continuous_profiler.DEFAULT_SAMPLING_FREQUENCY", 21)
def test_continuous_profiler_auto_start_and_stop_sampled(
sentry_init,
capture_envelopes,
mode,
make_options,
teardown_profiling,
):
options = make_options(
mode=mode, profile_session_sample_rate=1.0, lifecycle="trace"
)
sentry_init(
traces_sample_rate=1.0,
**options,
)
envelopes = capture_envelopes()
thread = threading.current_thread()
for _ in range(3):
envelopes.clear()
with sentry_sdk.start_transaction(name="profiling 1"):
assert get_profiler_id() is not None, "profiler should be running"
with sentry_sdk.start_span(op="op"):
time.sleep(0.1)
assert get_profiler_id() is not None, "profiler should be running"
# the profiler takes a while to stop in auto mode so if we start
# a transaction immediately, it'll be part of the same chunk
assert get_profiler_id() is not None, "profiler should be running"
with sentry_sdk.start_transaction(name="profiling 2"):
assert get_profiler_id() is not None, "profiler should be running"
with sentry_sdk.start_span(op="op"):
time.sleep(0.1)
assert get_profiler_id() is not None, "profiler should be running"
# wait at least 1 cycle for the profiler to stop
time.sleep(0.2)
assert get_profiler_id() is None, "profiler should not be running"
assert_single_transaction_with_profile_chunks(
envelopes, thread, max_chunks=1, transactions=2
)
@pytest.mark.parametrize(
"mode",
[
pytest.param("thread"),
pytest.param("gevent", marks=requires_gevent),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
@mock.patch("sentry_sdk.profiler.continuous_profiler.PROFILE_BUFFER_SECONDS", 0.01)
def test_continuous_profiler_auto_start_and_stop_unsampled(
sentry_init,
capture_envelopes,
mode,
make_options,
teardown_profiling,
):
options = make_options(
mode=mode, profile_session_sample_rate=0.0, lifecycle="trace"
)
sentry_init(
traces_sample_rate=1.0,
**options,
)
envelopes = capture_envelopes()
for _ in range(3):
envelopes.clear()
with sentry_sdk.start_transaction(name="profiling"):
assert get_profiler_id() is None, "profiler should not be running"
with sentry_sdk.start_span(op="op"):
time.sleep(0.05)
assert get_profiler_id() is None, "profiler should not be running"
assert get_profiler_id() is None, "profiler should not be running"
assert_single_transaction_without_profile_chunks(envelopes)
@pytest.mark.parametrize(
["mode", "class_name"],
[
pytest.param("thread", "ThreadContinuousScheduler"),
pytest.param(
"gevent",
"GeventContinuousScheduler",
marks=requires_gevent,
),
],
)
@pytest.mark.parametrize(
"make_options",
[
pytest.param(get_client_options(True), id="non-experiment"),
pytest.param(get_client_options(False), id="experiment"),
],
)
def test_continuous_profiler_manual_start_and_stop_noop_when_using_trace_lifecyle(
sentry_init,
mode,
class_name,
make_options,
teardown_profiling,
):
options = make_options(
mode=mode, profile_session_sample_rate=0.0, lifecycle="trace"
)
sentry_init(
traces_sample_rate=1.0,
**options,
)
with mock.patch(
f"sentry_sdk.profiler.continuous_profiler.{class_name}.ensure_running"
) as mock_ensure_running:
start_profiler()
mock_ensure_running.assert_not_called()
with mock.patch(
f"sentry_sdk.profiler.continuous_profiler.{class_name}.teardown"
) as mock_teardown:
stop_profiler()
mock_teardown.assert_not_called()
|