Config

Struct Config 

Source
pub struct Config {
    pub output_dir: PathBuf,
    pub write_interval_secs: u64,
    pub trace_cleanup_interval_secs: u64,
    pub metric_cleanup_interval_secs: u64,
    pub max_trace_buffer_size: usize,
    pub max_metric_buffer_size: usize,
    pub protocols: ProtocolConfig,
    pub forwarding: Option<ForwardingConfig>,
    pub dashboard: DashboardConfig,
    pub metric_temporality: Option<Temporality>,
}
Expand description

Main configuration structure for the OTLP Arrow Library

This structure contains all configuration options for the library, including output directory, write intervals, cleanup schedules, protocol settings, optional remote forwarding, and dashboard HTTP server.

§Configuration Sources

Configuration can be loaded from:

  • YAML files
  • Environment variables (with OTLP_* prefix)
  • Programmatic API (using ConfigBuilder)

§Default Values

  • output_dir: ./output_dir
  • write_interval_secs: 5
  • trace_cleanup_interval_secs: 600 (10 minutes)
  • metric_cleanup_interval_secs: 3600 (1 hour)
  • protocols: Both Protobuf and Arrow Flight enabled by default
  • forwarding: Disabled by default
  • dashboard: Disabled by default

§Example

use otlp_arrow_library::Config;

// Use defaults
let config = Config::default();

// Or use builder
let config = otlp_arrow_library::ConfigBuilder::new()
    .output_dir("./custom_output")
    .write_interval_secs(10)
    .build()?;

Fields§

§output_dir: PathBuf

Output directory for Arrow IPC files (default: ./output_dir)

§write_interval_secs: u64

How frequently to write batches to disk in seconds (default: 5)

§trace_cleanup_interval_secs: u64

How frequently to clean old trace files in seconds (default: 600)

§metric_cleanup_interval_secs: u64

How frequently to clean old metric files in seconds (default: 3600)

§max_trace_buffer_size: usize

Maximum number of trace spans to buffer in memory (default: 10000)

§max_metric_buffer_size: usize

Maximum number of metric requests to buffer in memory (default: 10000)

§protocols: ProtocolConfig

Protocol configuration (Protobuf and Arrow Flight)

§forwarding: Option<ForwardingConfig>

Optional remote forwarding configuration

§dashboard: DashboardConfig

Dashboard HTTP server configuration

§metric_temporality: Option<Temporality>

Temporality mode for metric exporters (default: Cumulative)

This setting controls how metrics are aggregated:

  • Cumulative: Metrics accumulate values over time (default, backward compatible)
  • Delta: Metrics represent changes since last export

Note: Temporality is not serializable, so this field is skipped during serialization. It can only be set programmatically via ConfigBuilder.

Implementations§

Source§

impl Config

Source

pub fn validate(&self) -> Result<(), OtlpConfigError>

Validate configuration values

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Config

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Config

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

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<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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,