obs-core 0.2.1

Runtime engine for the obs SDK: Observer, Sink, schema registry, sampling, config.
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

//! Sinks consume `ScrubbedEnvelope` and ship it to a destination
//! (stdout, NDJSON file, OTLP, ClickHouse, etc.).
//!
//! Phase-3 surface (impl-plan tasks 3.7 / 3.12 + 3.1 worker pool):
//!
//! - `Sink` trait + `flush` / `shutdown` lifecycle.
//! - `NoopSink`, `InMemorySink` (test harness).
//! - `StdoutSink` with all four `FormatterStyle`s.
//! - `NdjsonFileSink` over `RollingFileWriter`.
//! - `MakeWriter` family: `StdoutWriter`, `StderrWriter`, `LevelSplitWriter`, `TeeWriter`,
//!   `RollingFileWriter`, `NonBlockingWriter`.

pub mod fanout;
mod in_memory;
mod ndjson;
mod noop;
mod stdout;
pub(crate) mod writer;

use std::{future::Future, pin::Pin};

pub use self::{
    fanout::FanOutSink,
    in_memory::{InMemoryHandle, InMemorySink},
    ndjson::NdjsonFileSink,
    noop::NoopSink,
    stdout::{FormatterStyle, StdoutSink},
    writer::{
        ErasedWriter, LevelSplitWriter, MakeWriter, NonBlockingHandle, NonBlockingWriter,
        RollingFileHandle, RollingFileWriter, RollingFileWriterBuilder, RollingPolicy,
        StderrWriter, StdoutWriter, TeeWriter, WorkerGuard,
    },
};
use crate::registry::ScrubbedEnvelope;

/// Pinned future returned by `Sink::flush` / `Sink::shutdown`. Spec 11 § 4.
pub type SinkFut<'a> = Pin<Box<dyn Future<Output = ()> + Send + 'a>>;

/// A delivery destination. Called from per-tier worker tasks, never on
/// the emit thread.
pub trait Sink: Send + Sync + 'static {
    /// Hand the envelope to the sink. **Must not block**; long IO is
    /// queued internally. Spec 11 § 4 / spec 14 § 5.
    fn deliver(&self, env: ScrubbedEnvelope<'_>);

    /// Flush in-flight batches; awaits IO if needed.
    fn flush(&self) -> SinkFut<'_> {
        Box::pin(async {})
    }

    /// Shut down (drain + close). Idempotent.
    fn shutdown(&self) -> SinkFut<'_> {
        Box::pin(async {})
    }
}