otel-arrow-dfe-engine 0.61.0

Async pipeline engine
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

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

//! Extension wrapper and typestate builder.
//!
//! Extensions are PData-free -- they never process PData, only
//! control messages. This module is split into:
//!
//! | Submodule     | Contents                                                                 |
//! |---------------|--------------------------------------------------------------------------|
//! | [`wrapper`]   | [`ControlChannel`], [`EffectHandler`], [`ExtensionLifecycle`], [`ExtensionWrapper`], [`ExtensionBundle`] |
//! | [`builder`]   | Typestate chain: [`ExtensionBundleBuilder`] plus per-axis stages (see module docs) and [`SharedDecomposed`] / [`LocalDecomposed`] |
//! | [`readiness`] | [`ReadinessSignaller`] / [`ReadinessProbe`] primitive for extension startup gating |
//!
//! For the local (!Send) and shared (Send) Extension traits, see
//! [`local::extension`](crate::local::extension) and
//! [`shared::extension`](crate::shared::extension).

pub mod builder;
pub mod readiness;
pub mod wrapper;

#[cfg(test)]
mod tests;

pub use builder::{
    ActiveCompleteStage, ActiveLocalStage, ActiveSharedStage, ActiveStage, BackgroundCompleteStage,
    BackgroundEmptyStage, ExtensionBundleBuilder, LocalDecomposed, PassiveClonedCompleteStage,
    PassiveClonedLocalStage, PassiveClonedSharedStage, PassiveClonedStage,
    PassiveConstructedCompleteStage, PassiveConstructedLocalStage, PassiveConstructedSharedStage,
    PassiveConstructedStage, PassiveStage, SharedDecomposed,
};
// TODO: reduce public visibility of the readiness types.
// `ReadinessSignaller`, `ReadinessProbe`, and `ReadinessProbeError` have no
// consumers outside the engine crate and should be `pub(crate)`. Blocked by
// `ExtensionWrapper` being a `pub enum` whose variants carry
// `lifecycle: ExtensionLifecycle<...>`, which transitively forces these types
// public (E0446). Make `ExtensionWrapper` opaque first, then demote these and
// `ExtensionLifecycle` to `pub(crate)`. Do this in a dedicated PR.
pub use readiness::{
    DEFAULT_READINESS_TIMEOUT, ReadinessProbe, ReadinessProbeError, ReadinessSignaller,
};
pub use wrapper::{
    ControlChannel, ControlReceiver, EffectHandler, ExtensionBundle, ExtensionLifecycle,
    ExtensionWrapper,
};