Skip to main content

ShadowConfig

Struct ShadowConfig 

Source
pub struct ShadowConfig {
    pub shadow_timeout: Duration,
    pub ignore: Vec<IgnoreField>,
    /* private fields */
}
Expand description

Knobs the shadower needs.

Fields§

§shadow_timeout: Duration

Max time the shadow leg is allowed. After this we drop it and flag a ShadowTimeout on the outcome — never blocks the primary.

§ignore: Vec<IgnoreField>

Fields to skip in the divergence check.

Implementations§

Source§

impl ShadowConfig

Source

pub fn full_sample() -> Self

Mirror every request, default timeout 2s.

Source

pub fn sample_rate(self, percent: u32) -> Self

Set sampling rate as a percentage (0..=100). Values >100 are clamped.

Source

pub fn shadow_timeout(self, d: Duration) -> Self

Override the shadow timeout.

Source

pub fn ignore(self, field: IgnoreField) -> Self

Add a field to skip in the divergence diff.

Source

pub fn sample_rate_percent(&self) -> u32

Configured sample rate (0..=100).

Source

pub fn should_shadow(&self, key: &[u8]) -> bool

Decide whether this request should be mirrored. Bucketing is sticky on the key — the same key always gets the same yes/no for a given sample_rate. SHA-256 (mod 100) is cheap and avoids an RNG dep.

Trait Implementations§

Source§

impl Clone for ShadowConfig

Source§

fn clone(&self) -> ShadowConfig

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 ShadowConfig

Source§

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

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

impl Default for ShadowConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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.