Struct OpenLineageBuilder 

pub struct OpenLineageBuilder { /* private fields */ }

Builds and installs OpenLineage instrumentation on a SessionState.

Set a transport (or client) and, optionally, a context provider and config; then call Self::instrument. Self::from_env is the one-call path that derives everything from the standard OpenLineage environment.

Implementations

impl OpenLineageBuilder

pub fn from_env(self) -> Result<Self, ClientError>

Derive client, context, and config from the standard OpenLineage environment in one call.

Builds the client via OpenLineageClient::from_env (reads OPENLINEAGE_URL / OPENLINEAGE_ENDPOINT / OPENLINEAGE_API_KEY), the config via OpenLineageConfig::for_datafusion_from_env (reads OPENLINEAGE_NAMESPACE / OPENLINEAGE_TIMEOUT_MS), and the context via LineageContext::from_env (reads the parent-run variables). Anything set explicitly on the builder beforehand is preserved.

Errors

Returns ClientError if the client cannot be built — e.g. called outside a Tokio runtime, or OPENLINEAGE_URL is malformed.

pub fn client(self, client: OpenLineageClient) -> Self

Use a pre-built OpenLineageClient. Takes precedence over Self::transport.

pub fn transport(self, transport: Arc<dyn Transport>) -> Self

Drain events into transport. A client is constructed around it at Self::instrument time. Ignored if Self::client is also set.

pub fn context(self, context: Arc<dyn LineageContextProvider>) -> Self

Set the per-query context provider. Defaults to an empty StaticContextProvider.

pub fn config(self, config: OpenLineageConfig) -> Self

Set the static config. Defaults to OpenLineageConfig::for_datafusion.

pub fn instrument(self, state: SessionState) -> SessionState

Install the instrumentation on state, returning the wired SessionState.

Sets the session’s query planner to an OpenLineageQueryPlanner. A pre-existing custom QueryPlanner is replaced; standard physical planning (including extension nodes) is preserved because the new planner delegates to a DefaultPhysicalPlanner.

Panics

Panics if no client or transport was set and a default client must be built outside a Tokio runtime. Prefer Self::from_env (which surfaces a ClientError) or set a client built with OpenLineageClient::try_new.

Trait Implementations

impl Debug for OpenLineageBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenLineageBuilder

fn default() -> OpenLineageBuilder

Returns the “default value” for a type.