Skip to main content

OpenLineageConfig

Struct OpenLineageConfig 

Source
pub struct OpenLineageConfig {
    pub producer: String,
    pub job_namespace: String,
    pub engine_name: String,
    pub engine_version: String,
    pub adapter_version: String,
    pub request_timeout: Duration,
}
Expand description

Identifies the emitting integration on every emitted event/facet, and tunes the emit transport.

Fields§

§producer: String

producer URI stamped on events and facets (the emitting code). Engine integrations should override this with their own identity.

§job_namespace: String

Default job namespace when the context provides none (from OPENLINEAGE_NAMESPACE, falling back to "default").

§engine_name: String

Engine name for the processing_engine run facet. Empty unless an engine integration sets it.

§engine_version: String

Engine version for the processing_engine run facet. Empty unless an engine integration sets it.

§adapter_version: String

This crate’s version, for openlineageAdapterVersion.

§request_timeout: Duration

Per-request timeout applied by HTTP transports. One slow/hung upstream request can otherwise stall the shared background drain; bounding it lets the drain keep making progress. See OPENLINEAGE_TIMEOUT_MS.

Implementations§

Source§

impl OpenLineageConfig

Source

pub fn from_env() -> Self

Build a config from the standard OpenLineage environment conventions.

Reads OPENLINEAGE_NAMESPACE for the default job namespace (falling back to DEFAULT_NAMESPACE) and OPENLINEAGE_TIMEOUT_MS for the request timeout (falling back to DEFAULT_REQUEST_TIMEOUT); the producer/adapter identity is fixed for this crate and the engine identity is left empty (an engine integration such as datafusion-openlineage stamps it). This is the documented entry point for env-driven configuration — pair it with OpenLineageClient::from_env, which reads OPENLINEAGE_URL / OPENLINEAGE_ENDPOINT / OPENLINEAGE_API_KEY for the transport, so an integration can wire itself up entirely from the environment the rest of the OpenLineage ecosystem already uses.

Default is equivalent and reads the same environment; from_env exists to make the env dependency explicit and discoverable at call sites.

Source

pub fn with_env(namespace: Option<String>, timeout_ms: Option<String>) -> Self

Self::from_env with the OPENLINEAGE_NAMESPACE / OPENLINEAGE_TIMEOUT_MS values injected, so the fallback logic is unit-testable without mutating process-global env. An absent or empty namespace falls back to DEFAULT_NAMESPACE; an absent/empty/unparsable timeout falls back to DEFAULT_REQUEST_TIMEOUT.

Trait Implementations§

Source§

impl Clone for OpenLineageConfig

Source§

fn clone(&self) -> OpenLineageConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenLineageConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OpenLineageConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more