detritus-protocol 0.2.0

Wire protocol types for Detritus telemetry and crash ingestion
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

#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(all(test, coverage_nightly), feature(coverage_attribute))]
//! Wire protocol types for Detritus telemetry and crash ingestion.
//!
//! `detritus-protocol` owns the schema shared by `detritus-client` and
//! `detritus-server`: source identity, crash envelopes, and the curated OTLP
//! log facade used by the client and receiver. Version `0.1.0` supports OTLP
//! logs only; traces and metrics are intentionally outside the published
//! compatibility surface.
//!
//! [`PROTOCOL_VERSION`] is carried in HTTP and gRPC metadata so clients and
//! servers can reject payloads encoded for an incompatible schema.
//!
//! ```
//! use detritus_protocol::PROTOCOL_VERSION;
//!
//! assert_eq!(PROTOCOL_VERSION, 1);
//! ```
//!
//! # Features
//!
//! - **`multipart`** *(enabled by default)* — RFC 7578 multipart encoding and
//!   parsing of crash envelopes ([`multipart`]). Building with
//!   `default-features = false` drops it along with the `bytes`,
//!   `futures-util`, `multer`, and `tokio` dependencies, leaving the schema
//!   types for a logs-only consumer.

/// Crash-report schema types and protocol errors.
pub mod crash;
#[cfg(feature = "multipart")]
#[cfg_attr(docsrs, doc(cfg(feature = "multipart")))]
/// Multipart encoding and parsing helpers for crash envelopes.
pub mod multipart;
/// Curated OpenTelemetry Protocol log-service bindings.
pub mod otlp;
/// Per-tenant JSON Schema descriptors for payload validation.
pub mod schema;
/// Source identity attached to Detritus payloads.
pub mod source;

/// Crash-report schema types re-exported for the common import path.
pub use crash::{
    AttachmentManifest, BuildInfo, CrashAttachment, CrashEnvelope, CrashKind, CrashMetadata,
    ProtocolError,
};
/// Source identity re-exported for the common import path.
pub use source::SourceId;

/// Current observability ingestion schema version.
pub const PROTOCOL_VERSION: u32 = 1;
/// gRPC metadata key carrying [`PROTOCOL_VERSION`].
pub const GRPC_VERSION_KEY: &str = "x-protocol-version";
/// HTTP header carrying [`PROTOCOL_VERSION`].
pub const HTTP_VERSION_HEADER: &str = "X-Protocol-Version";