AnalyticsConfig

Struct AnalyticsConfig 

Source
pub struct AnalyticsConfig {
    pub path: String,
    pub flush_ms: Option<u64>,
    pub retention: Option<AnalyticsRetention>,
    pub dimensions: Vec<AnalyticsDimension>,
    pub exports: Option<AnalyticsExports>,
    pub live_sketches: Option<AnalyticsLiveSketches>,
    pub insights: Option<AnalyticsInsights>,
    pub replay_capture: Option<AnalyticsReplayCapture>,
    pub sampled_degradation: Option<AnalyticsSampledDegradation>,
}
Expand description

The embedded analytics store config (DW-043, gateway.analytics).

Fields§

§path: String

Filesystem path of the analytics SQLite database. The file is created (and migrated) on first open. A separate file from the state store on purpose: retention deletes and incremental vacuum churn must never compact the identity store.

§flush_ms: Option<u64>

Maximum batch latency of the background writer, in milliseconds (default 1000; validated to [100, 60 000]). Not a correctness knob — the rollup grace covers multiples of this.

§retention: Option<AnalyticsRetention>

Per-store retention, in milliseconds (defaults: raw 24 h, 1m 48 h, 5m 7 d, 1h 30 d, 1d 365 d). Validation enforces each floor (a granularity must outlive its own window comfortably) and monotonicity (no coarser table may expire before a finer one).

§dimensions: Vec<AnalyticsDimension>

Custom dimensions (DW-043): request-header-sourced tags that become analytics dimensions — x-plan as dimension plan, for consumer tier / plan / feature-flag style cuts the fixed dimensions cannot express. Extracted at request completion capture; analytics-only (never added to the access log). At most 16 (cardinality guard); values are capped at 128 bytes (longer values are skipped for that request).

§exports: Option<AnalyticsExports>

Scheduled usage-report exports (DW-120): durable CSV/JSON dumps of the per-consumer usage statement, one file set per closed UTC calendar window, written by a background worker that reuses the analytics store’s scheduling machinery. Absent (the default): no exports run and the admin export endpoints answer that exports are not configured. See the analytics::exports module docs for the schedule, the statement’s reconciliation contract with the query API, and the quota-column window-alignment rule.

§live_sketches: Option<AnalyticsLiveSketches>

Live in-process sketches (DW-092): sub-second-freshness aggregation maintained synchronously on the request-completion hot path (per-route rolling window with counts, errors, and latency samples). Never blocks the dataplane — the sketch is updated in place under atomics and a short mutex over a capped sample vector. Absent (the default): no live sketches; the GET /analytics/live endpoint answers analytics_not_configured.

§insights: Option<AnalyticsInsights>

ML traffic insights (DW-092): EWMA-based capacity forecasting and seasonal-baseline anomaly detection over the live sketch window rotations. The insights engine is in-process and hand-rolled (no ML crates): a minute-of-day ring buffer holds the seasonal pattern, an EWMA over recent windows carries the trend, and anomaly detection compares the current window’s shape to the seasonal baseline. Absent (the default): no forecasting or anomaly detection; the GET /analytics/forecast and GET /analytics/anomalies endpoints answer analytics_not_configured.

§replay_capture: Option<AnalyticsReplayCapture>

Replay time-travel debugging capture (DW-102): opt-in capture of request detail (redacted headers, auth identity) into the raw analytics table for offline replay against candidate configs. Absent (the default): no replay capture; the raw table’s request_headers_redacted and auth_identity columns stay NULL. When present with enabled: true, the fire-and-forget analytics writer records the redacted headers and auth identity alongside the existing access fields, bounded by retain_hours. See AnalyticsReplayCapture.

§sampled_degradation: Option<AnalyticsSampledDegradation>

REL-10 (#221): sampled degradation under channel pressure. When the analytics channel’s fill ratio exceeds high_watermark, the offer path probabilistically drops records (keeping 1 in sample_rate) BEFORE the channel fills, so a sustained burst degrades to sampled telemetry rather than a hard drop cliff. Below low_watermark every record is kept. Defaults to off (no sampling); when enabled, high_watermark must be > low_watermark and both are in (0.0, 1.0].

Trait Implementations§

Source§

impl Clone for AnalyticsConfig

Source§

fn clone(&self) -> AnalyticsConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnalyticsConfig

Source§

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

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

impl<'de> Deserialize<'de> for AnalyticsConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for AnalyticsConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for AnalyticsConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Serialize for AnalyticsConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AnalyticsConfig

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
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
§

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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.
§

impl<T> TryIntoValue for T
where T: Serialize,

§

type Error = SerializationError

§

fn try_into_value(self) -> Result<Value, <T as TryIntoValue>::Error>

§

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,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

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