Skip to main content

Sli

Enum Sli 

Source
pub enum Sli {
    Events {
        error_query: String,
        total_query: String,
    },
    Raw {
        error_ratio_query: String,
    },
    Latency {
        histogram_metric: String,
        threshold: String,
        selector: Option<String>,
    },
}
Expand description

How an SLO’s error ratio is computed from Prometheus.

Covers sloth’s two SLI shapes (events-based and raw) plus a slokit extension, Sli::Latency, that generates the histogram bucket query for the common “fraction of requests slower than a threshold” SLO.

Variants§

§

Events

Bad events divided by total events. Both queries should contain the WINDOW_TOKEN.

Fields

§error_query: String

Query counting failing events over the window.

§total_query: String

Query counting all events over the window.

§

Raw

A query that already yields an error ratio in [0, 1]. Should contain the WINDOW_TOKEN.

Fields

§error_ratio_query: String

Query yielding the error ratio over the window.

§

Latency

A latency SLI built from a Prometheus histogram: the fraction of requests that took longer than threshold (the le bucket boundary). The error ratio query is generated, so it needs no WINDOW_TOKEN.

Fields

§histogram_metric: String

Histogram base metric name, without the _bucket/_count suffix, e.g. http_request_duration_seconds.

§threshold: String

The le bucket boundary, kept as a string to match the label exactly, e.g. "0.3".

§selector: Option<String>

Optional label matchers, written without braces, e.g. job="api".

Implementations§

Source§

impl Sli

Source

pub fn error_ratio_expr(&self, window: Window) -> String

Render the SLI’s error-ratio PromQL expression for a given window, substituting WINDOW_TOKEN with the Prometheus duration.

For Sli::Events this is (error) / (total); for Sli::Raw it is the raw query as written.

Source

pub fn queries(&self) -> Vec<&str>

Every user-supplied query string this SLI carries, for validation. A Sli::Latency carries none (its query is generated).

Trait Implementations§

Source§

impl Clone for Sli

Source§

fn clone(&self) -> Sli

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Sli

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for Sli

Source§

impl PartialEq for Sli

Source§

fn eq(&self, other: &Sli) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Sli

Auto Trait Implementations§

§

impl Freeze for Sli

§

impl RefUnwindSafe for Sli

§

impl Send for Sli

§

impl Sync for Sli

§

impl Unpin for Sli

§

impl UnsafeUnpin for Sli

§

impl UnwindSafe for Sli

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more