datafusion-tracing 53.0.0

DataFusion tracing of execution plans
Documentation 
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

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/) Copyright 2025 Datadog, Inc.

use crate::utils::DefaultDisplay;
use datafusion::arrow::array::RecordBatch;
use datafusion::arrow::datatypes::SchemaRef;
use datafusion::execution::{RecordBatchStream, SendableRecordBatchStream};
use datafusion::physical_plan::ExecutionPlan;
use futures::Stream;
use pin_project::pin_project;
use std::pin::Pin;
use std::sync::Arc;
use std::task::{Context, Poll};
use tracing::{Span, field};

/// Records the `datafusion.node` span field once execution completes across all
/// partitions, when the value is fully qualified.
pub(crate) struct NodeRecorder {
    execution_plan: Arc<dyn ExecutionPlan>,
    span: Span,
}

impl NodeRecorder {
    pub fn new(execution_plan: Arc<dyn ExecutionPlan>, span: Span) -> Self {
        Self {
            execution_plan,
            span,
        }
    }
}

impl Drop for NodeRecorder {
    fn drop(&mut self) {
        self.span.record(
            "datafusion.node",
            field::display(DefaultDisplay(self.execution_plan.as_ref())),
        );
    }
}

/// A wrapper around a DataFusion stream that keeps a `NodeRecorder` alive
/// so the `datafusion.node` field is recorded only when the stream completes.
#[pin_project]
pub(crate) struct NodeRecordingStream {
    #[pin]
    inner: SendableRecordBatchStream,
    _recorder: Arc<NodeRecorder>,
}

impl NodeRecordingStream {
    pub fn new(inner: SendableRecordBatchStream, recorder: Arc<NodeRecorder>) -> Self {
        Self {
            inner,
            _recorder: recorder,
        }
    }
}

impl Stream for NodeRecordingStream {
    type Item = datafusion::common::Result<RecordBatch>;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        self.project().inner.poll_next(cx)
    }
}

impl RecordBatchStream for NodeRecordingStream {
    fn schema(&self) -> SchemaRef {
        self.inner.schema()
    }
}