|
45 | 45 |
|
46 | 46 | from airflow import settings |
47 | 47 | from airflow._shared.observability.metrics.base_stats_logger import StatsLogger |
48 | | -from airflow._shared.observability.traces import OverrideableRandomIdGenerator |
| 48 | +from airflow._shared.observability.traces import ( |
| 49 | + PARENT_TRACE_CONTEXT_KEY, |
| 50 | + OverrideableRandomIdGenerator, |
| 51 | +) |
49 | 52 | from airflow._shared.timezones import timezone |
50 | 53 | from airflow.callbacks.callback_requests import DagCallbackRequest, DagRunContext |
51 | 54 | from airflow.models.dag import DagModel, infer_automated_data_interval |
@@ -4441,6 +4444,128 @@ def test_context_carrier_honors_trace_sampled_conf(self, dag_maker, flag): |
4441 | 4444 | span_ctx = trace.get_current_span(ctx).get_span_context() |
4442 | 4445 | assert span_ctx.trace_flags.sampled is flag |
4443 | 4446 |
|
| 4447 | + _EXTERNAL_TRACE_ID = "11111111111111111111111111111111" |
| 4448 | + _EXTERNAL_SPAN_ID = "2222222222222222" |
| 4449 | + |
| 4450 | + @pytest.mark.parametrize( |
| 4451 | + ("conf", "expected_trace_id"), |
| 4452 | + [ |
| 4453 | + pytest.param( |
| 4454 | + {PARENT_TRACE_CONTEXT_KEY: f"00-{_EXTERNAL_TRACE_ID}-{_EXTERNAL_SPAN_ID}-01"}, |
| 4455 | + _EXTERNAL_TRACE_ID, |
| 4456 | + id="traceparent-string", |
| 4457 | + ), |
| 4458 | + pytest.param( |
| 4459 | + { |
| 4460 | + PARENT_TRACE_CONTEXT_KEY: { |
| 4461 | + "traceparent": f"00-{_EXTERNAL_TRACE_ID}-{_EXTERNAL_SPAN_ID}-01" |
| 4462 | + } |
| 4463 | + }, |
| 4464 | + _EXTERNAL_TRACE_ID, |
| 4465 | + id="carrier-dict", |
| 4466 | + ), |
| 4467 | + pytest.param({PARENT_TRACE_CONTEXT_KEY: "not-a-traceparent"}, None, id="malformed"), |
| 4468 | + pytest.param({PARENT_TRACE_CONTEXT_KEY: 123}, None, id="non-str"), |
| 4469 | + pytest.param({PARENT_TRACE_CONTEXT_KEY: {"nope": "x"}}, None, id="dict-without-traceparent"), |
| 4470 | + pytest.param({}, None, id="empty-conf"), |
| 4471 | + pytest.param(None, None, id="no-conf"), |
| 4472 | + pytest.param({"other": "x"}, None, id="unrelated-key"), |
| 4473 | + ], |
| 4474 | + ) |
| 4475 | + def test_parent_trace_context(self, conf, expected_trace_id): |
| 4476 | + """Only a valid W3C traceparent (string or carrier dict) yields a parent context; else None.""" |
| 4477 | + from airflow.models.dagrun import parent_trace_context |
| 4478 | + |
| 4479 | + ctx = parent_trace_context(conf) |
| 4480 | + if expected_trace_id is None: |
| 4481 | + assert ctx is None |
| 4482 | + else: |
| 4483 | + span_ctx = otel_trace.get_current_span(ctx).get_span_context() |
| 4484 | + assert span_ctx.is_valid |
| 4485 | + assert format(span_ctx.trace_id, "032x") == expected_trace_id |
| 4486 | + |
| 4487 | + def test_parent_trace_context_carrier_dict_preserves_tracestate(self): |
| 4488 | + """A carrier dict may also carry tracestate, which is extracted alongside traceparent.""" |
| 4489 | + from airflow.models.dagrun import parent_trace_context |
| 4490 | + |
| 4491 | + conf = { |
| 4492 | + PARENT_TRACE_CONTEXT_KEY: { |
| 4493 | + "traceparent": f"00-{self._EXTERNAL_TRACE_ID}-{self._EXTERNAL_SPAN_ID}-01", |
| 4494 | + "tracestate": "foo=bar", |
| 4495 | + } |
| 4496 | + } |
| 4497 | + span_ctx = otel_trace.get_current_span(parent_trace_context(conf)).get_span_context() |
| 4498 | + assert span_ctx.trace_state.get("foo") == "bar" |
| 4499 | + |
| 4500 | + def test_context_carrier_embeds_external_parent_from_conf(self, dag_maker): |
| 4501 | + """A run with airflow/parent_trace_context rides the external trace_id.""" |
| 4502 | + with dag_maker("test_tracing_embed_conf"): |
| 4503 | + EmptyOperator(task_id="t1") |
| 4504 | + dr = dag_maker.create_dagrun( |
| 4505 | + conf={PARENT_TRACE_CONTEXT_KEY: f"00-{self._EXTERNAL_TRACE_ID}-{self._EXTERNAL_SPAN_ID}-01"} |
| 4506 | + ) |
| 4507 | + |
| 4508 | + ctx = TraceContextTextMapPropagator().extract(dr.context_carrier) |
| 4509 | + span_ctx = otel_trace.get_current_span(ctx).get_span_context() |
| 4510 | + assert format(span_ctx.trace_id, "032x") == self._EXTERNAL_TRACE_ID |
| 4511 | + |
| 4512 | + def test_context_carrier_is_root_without_parent_conf(self, dag_maker): |
| 4513 | + """A run with no parent conf mints its own root trace, not the external one.""" |
| 4514 | + with dag_maker("test_tracing_root_default"): |
| 4515 | + EmptyOperator(task_id="t1") |
| 4516 | + dr = dag_maker.create_dagrun() |
| 4517 | + |
| 4518 | + ctx = TraceContextTextMapPropagator().extract(dr.context_carrier) |
| 4519 | + span_ctx = otel_trace.get_current_span(ctx).get_span_context() |
| 4520 | + assert format(span_ctx.trace_id, "032x") != self._EXTERNAL_TRACE_ID |
| 4521 | + |
| 4522 | + def test_emit_dagrun_span_nests_under_external_parent(self, dag_maker, session): |
| 4523 | + """With the parent conf key set, the dag_run span is a child of the external span.""" |
| 4524 | + in_mem_exporter = InMemorySpanExporter() |
| 4525 | + provider = TracerProvider(id_generator=OverrideableRandomIdGenerator()) |
| 4526 | + provider.add_span_processor(SimpleSpanProcessor(in_mem_exporter)) |
| 4527 | + test_tracer = provider.get_tracer("test") |
| 4528 | + |
| 4529 | + with dag_maker("test_tracing_embed_emit", session=session) as dag: |
| 4530 | + EmptyOperator(task_id="t1") |
| 4531 | + dr = dag_maker.create_dagrun(state=DagRunState.RUNNING) |
| 4532 | + dr.dag = dag |
| 4533 | + dr.conf = {PARENT_TRACE_CONTEXT_KEY: f"00-{self._EXTERNAL_TRACE_ID}-{self._EXTERNAL_SPAN_ID}-01"} |
| 4534 | + # Carrier already rides the external trace with its own child span id, sampled. |
| 4535 | + dr.context_carrier = {"traceparent": f"00-{self._EXTERNAL_TRACE_ID}-3333333333333333-01"} |
| 4536 | + |
| 4537 | + with mock.patch("airflow.models.dagrun.tracer", test_tracer): |
| 4538 | + dr._emit_dagrun_span(state=DagRunState.SUCCESS) |
| 4539 | + |
| 4540 | + spans = in_mem_exporter.get_finished_spans() |
| 4541 | + assert len(spans) == 1 |
| 4542 | + span = spans[0] |
| 4543 | + assert span.context.trace_id == int(self._EXTERNAL_TRACE_ID, 16) |
| 4544 | + assert span.context.span_id == int("3333333333333333", 16) |
| 4545 | + assert span.parent is not None |
| 4546 | + assert span.parent.trace_id == int(self._EXTERNAL_TRACE_ID, 16) |
| 4547 | + assert span.parent.span_id == int(self._EXTERNAL_SPAN_ID, 16) |
| 4548 | + |
| 4549 | + def test_emit_dagrun_span_is_root_by_default(self, dag_maker, session): |
| 4550 | + """Without the parent conf key, the dag_run span is a root span (no parent).""" |
| 4551 | + in_mem_exporter = InMemorySpanExporter() |
| 4552 | + provider = TracerProvider(id_generator=OverrideableRandomIdGenerator()) |
| 4553 | + provider.add_span_processor(SimpleSpanProcessor(in_mem_exporter)) |
| 4554 | + test_tracer = provider.get_tracer("test") |
| 4555 | + |
| 4556 | + with dag_maker("test_tracing_root_emit", session=session) as dag: |
| 4557 | + EmptyOperator(task_id="t1") |
| 4558 | + dr = dag_maker.create_dagrun(state=DagRunState.RUNNING) |
| 4559 | + dr.dag = dag |
| 4560 | + dr.context_carrier = {"traceparent": f"00-{self._EXTERNAL_TRACE_ID}-3333333333333333-01"} |
| 4561 | + |
| 4562 | + with mock.patch("airflow.models.dagrun.tracer", test_tracer): |
| 4563 | + dr._emit_dagrun_span(state=DagRunState.SUCCESS) |
| 4564 | + |
| 4565 | + spans = in_mem_exporter.get_finished_spans() |
| 4566 | + assert len(spans) == 1 |
| 4567 | + assert spans[0].parent is None |
| 4568 | + |
4444 | 4569 |
|
4445 | 4570 | class TestDagRunStatsTagsTeamName: |
4446 | 4571 | def test_stats_tags_without_team_name(self, dag_maker): |
|
0 commit comments