tailtriage-core 0.2.0

Framework-agnostic request instrumentation and run schema for tailtriage triage artifacts
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

#![doc = include_str!("../README.md")]
#![warn(missing_docs)]

// Core run schema and split request lifecycle instrumentation API for tailtriage.
//
// ```no_run
// use tailtriage_core::{RequestOptions, Tailtriage};
//
// # async fn demo() -> Result<(), Box<dyn std::error::Error>> {
// let tailtriage = Tailtriage::builder("checkout-service")
//     .output("tailtriage-run.json")
//     .build()?;
//
// let started = tailtriage
//     .begin_request_with("/checkout", RequestOptions::new().request_id("req-1").kind("http"));
// let request = started.handle.clone();
//
// // queue(...), stage(...), and inflight(...) instrumentation can happen here.
// // They do not finish the request lifecycle.
// started.completion.finish_ok();
// // You must finish each request exactly once via finish(...), finish_ok(), or finish_result(...).
// // Drop only asserts on unfinished completions in debug builds; it does not auto-record completion.
//
// tailtriage.shutdown()?;
// # Ok(())
// # }
// ```

mod collector;
mod config;
mod events;
mod sink;
mod time;
mod timers;

pub use collector::{
    OwnedRequestCompletion, OwnedRequestHandle, OwnedStartedRequest, RequestCompletion,
    RequestHandle, RuntimeSamplerRegistrationError, StartedRequest, Tailtriage,
};
pub use config::{
    BuildError, CaptureLimits, CaptureLimitsOverride, CaptureMode, EffectiveCoreConfig,
    RequestOptions, TailtriageBuilder,
};
pub use events::{
    EffectiveTokioSamplerConfig, InFlightSnapshot, Outcome, QueueEvent, RequestEvent, Run,
    RunEndReason, RunMetadata, RuntimeSnapshot, StageEvent, TruncationSummary,
    UnfinishedRequestSample, UnfinishedRequests, SCHEMA_VERSION,
};
pub use sink::{DiscardSink, LocalJsonSink, MemorySink, RunSink, SinkError};
pub use time::{system_time_to_unix_ms, unix_time_ms};
pub use timers::{InflightGuard, QueueTimer, StageTimer};

/// Internal integration hooks for sibling crates in this workspace.
#[doc(hidden)]
pub mod __internal {
    use crate::{EffectiveTokioSamplerConfig, RuntimeSamplerRegistrationError, Tailtriage};

    /// Registers Tokio sampler startup metadata after real sampler preconditions pass.
    ///
    /// This is an intentionally narrow cross-crate boundary for
    /// `tailtriage-tokio` integration. It is hidden from docs and not a
    /// supported end-user API surface.
    ///
    /// # Errors
    ///
    /// Returns [`RuntimeSamplerRegistrationError::DuplicateStart`] when a sampler
    /// was already registered for this run.
    pub fn register_tokio_runtime_sampler(
        tailtriage: &Tailtriage,
        config: EffectiveTokioSamplerConfig,
    ) -> Result<(), RuntimeSamplerRegistrationError> {
        tailtriage.register_tokio_runtime_sampler(config)
    }
}

#[cfg(test)]
mod tests;