slokit 0.12.0

SLO and error-budget engine for Rust: compute error budgets and burn rates, and generate multi-window multi-burn-rate Prometheus alert rules from sloth-compatible specs.
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

//! Error type for the `slokit` crate.

/// Errors produced by the core library.
///
/// I/O and CLI-level concerns are handled by the binary (via `anyhow`); this
/// enum stays focused on domain and parsing failures so library consumers get
/// precise, matchable variants.
///
/// The enum is `#[non_exhaustive]`: new failure domains have been added before
/// (the `Plugin` variant arrived with the SLI plugin system) and more may
/// follow, so matches need a wildcard arm.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum SlokitError {
    /// An objective was outside the open interval that makes it a valid SLO.
    #[error("invalid objective: {0}")]
    InvalidObjective(String),

    /// A duration string (e.g. `30d`, `1h`) could not be parsed.
    #[error("invalid duration: {0}")]
    InvalidDuration(String),

    /// A spec could not be deserialized or was structurally malformed.
    #[error("spec error: {0}")]
    Spec(String),

    /// A spec parsed but failed semantic validation. The message contains one
    /// line per problem found.
    #[error("validation failed:\n{0}")]
    Validation(String),

    /// A live Prometheus query failed (transport, HTTP status, or response
    /// shape). Only produced with the `check` feature.
    #[error("prometheus query failed: {0}")]
    Query(String),

    /// An SLI plugin registry operation failed: a duplicate or unknown plugin
    /// id, or option values that violate the plugin's declared contract. Only
    /// produced with the `spec` feature.
    #[error("plugin error: {0}")]
    Plugin(String),
}

/// Convenience alias used throughout the crate.
pub type Result<T> = std::result::Result<T, SlokitError>;