CanaryController

Struct CanaryController 

Source
pub struct CanaryController { /* private fields */ }
Expand description

The per-generation canary analysis controller (DW-091). Compiled once per config generation from the canary_analysis blocks on service splits and AI model aliases; shared via Arc from the dataplane generation. record_outcome runs on the response path and evaluate runs on the background CanaryRunner loop.

Implementations§

Source§

impl CanaryController

Source

pub fn new() -> Self

New empty controller (no canary groups). The fast path: record_outcome and evaluate are no-ops.

Source

pub fn compile(gateway: &Gateway, obs: Option<Arc<Observability>>) -> Self

Compile the controller from a gateway’s service splits and AI model aliases. Only services/aliases with an enabled canary_analysis block contribute a group. The observability handle wires the metric families; pass None for direct unit-test construction (metrics are then a no-op).

Source

pub fn compile_with_clock( gateway: &Gateway, obs: Option<Arc<Observability>>, now_secs: fn() -> u64, ) -> Self

Self::compile with a caller-supplied second clock (Unix epoch). Intended for tests that need to advance time deterministically (the same pattern as AdaptiveController::compile_with_clock); production keeps the system clock via Self::compile.

Source

pub fn is_empty(&self) -> bool

Whether any canary group is compiled in at all (the fast path: configs with no canary_analysis skip the per-request record_outcome entirely).

Source

pub fn record_outcome( &self, group_name: &str, is_canary: bool, status: u16, latency_ms: f64, )

Record one upstream outcome for group_name (DW-091): increment the appropriate side’s request/error counters and add the latency sample. A no-op when the group has no canary_analysis. is_canary selects the side (true = canary, false = baseline); status is the upstream HTTP status (5xx counts as an error); latency_ms is the upstream round-trip in milliseconds.

Source

pub fn evaluate(&self) -> Vec<CanaryAction>

Evaluate all groups and return the actions the runner should apply. Each action carries the recommended new canary weight. The runner applies them and emits events; the controller’s last_adjustment and current_canary_weight are updated by Self::note_applied.

Source

pub fn note_applied(&self, action: &CanaryAction)

Note that an action was successfully applied (the runner calls this after apply_*_weights returns true). Updates the group’s last_adjustment and current_canary_weight, and records the promotion/rollback metric.

Source

pub fn current_canary_weight(&self, group: &str) -> Option<u64>

The current transient canary weight for a group (tests / diagnostics). Returns None when the group does not exist.

Source

pub fn total_weight(&self, group: &str) -> Option<u64>

The total weight for a group (tests / diagnostics).

Trait Implementations§

Source§

impl Debug for CanaryController

Source§

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

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

impl Default for CanaryController

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
§

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

§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
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
§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

§

fn coerce_box_to(self: Box<X>) -> Box<T>

§

fn coerce_ref_to(&self) -> &T

§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,