Skip to main content

sc_observability/
error_codes.rs

1//! Stable `ErrorCode` registry for `sc-observability`.
2
3use sc_observability_types::ErrorCode;
4
5/// Stable error code for invalid event payloads.
6pub const LOGGER_INVALID_EVENT: ErrorCode =
7    ErrorCode::new_static("SC_OBSERVABILITY_LOGGER_INVALID_EVENT");
8/// Stable error code for post-shutdown logger use.
9pub const LOGGER_SHUTDOWN: ErrorCode = ErrorCode::new_static("SC_OBSERVABILITY_LOGGER_SHUTDOWN");
10/// Stable error code for sink write failures.
11pub const LOGGER_SINK_WRITE_FAILED: ErrorCode =
12    ErrorCode::new_static("SC_OBSERVABILITY_LOGGER_SINK_WRITE_FAILED");
13/// Stable error code for logger initialization failures.
14pub const LOGGER_INIT_FAILED: ErrorCode =
15    ErrorCode::new_static("SC_OBSERVABILITY_LOGGER_INIT_FAILED");
16/// Stable error code for flush failures.
17pub const LOGGER_FLUSH_FAILED: ErrorCode =
18    ErrorCode::new_static("SC_OBSERVABILITY_LOGGER_FLUSH_FAILED");
19/// Stable error code for deliberate retained-sink fault injection.
20#[cfg(feature = "fault-injection")]
21pub const LOGGER_SINK_FAULT_INJECTED: ErrorCode =
22    ErrorCode::new_static("SC_OBSERVABILITY_LOGGER_SINK_FAULT_INJECTED");
23
24/// All stable error codes exported by this crate.
25pub const ALL: &[ErrorCode] = &[
26    LOGGER_INVALID_EVENT,
27    LOGGER_SHUTDOWN,
28    LOGGER_SINK_WRITE_FAILED,
29    LOGGER_INIT_FAILED,
30    LOGGER_FLUSH_FAILED,
31    #[cfg(feature = "fault-injection")]
32    LOGGER_SINK_FAULT_INJECTED,
33];