Skip to main content

DebugState

Struct DebugState 

Source
pub struct DebugState {
    pub enabled: bool,
    pub sandbox_enabled: bool,
    pub trigger_header: String,
    pub trace_all: bool,
    pub capture_bodies: bool,
    pub max_body_bytes: usize,
    pub max_traces: usize,
    pub max_steps: usize,
    pub sandbox_timeout_seconds: u64,
    redaction: RedactionPolicy,
    traces: Mutex<VecDeque<Arc<Trace>>>,
    seq: AtomicU64,
}
Expand description

Resolved debug settings plus the trace buffer.

Every field is immutable after construction — system.yaml is not hot-reloaded, so debug mode cannot be switched on in a running process. That is deliberate: it means a compromised Admin API credential cannot start capturing request contexts.

Fields§

§enabled: bool§sandbox_enabled: bool§trigger_header: String

Lowercased, because GatewayRequest stores header names as hyper normalised them.

§trace_all: bool§capture_bodies: bool§max_body_bytes: usize§max_traces: usize§max_steps: usize§sandbox_timeout_seconds: u64§redaction: RedactionPolicy§traces: Mutex<VecDeque<Arc<Trace>>>§seq: AtomicU64

Implementations§

Source§

impl DebugState

Source

pub fn new(cfg: &DebugConfig) -> Self

Builds the runtime state from config.

Source

pub fn capture_options(&self) -> CaptureOptions

Capture knobs for a snapshot.

Source

pub fn should_trace(&self, headers: &HashMap<String, Vec<String>>) -> bool

Whether this request should be traced.

The whole cost on an untraced request: one HashMap::get against the already-built header map, and only when debug is enabled at all.

Source

pub fn header_opt_in(&self, headers: &HashMap<String, Vec<String>>) -> bool

Whether the request explicitly asked to be traced via the trigger header, as opposed to being swept up by trace_all.

The x-featherbit-trace-id response header is returned only in this case: the id is a reply to a caller who opted in. Under trace_all the traffic is anonymous, so stamping every response with a debug id would leak it to clients that never asked — those traces are found in the panel/list instead.

Source

pub fn next_seq(&self) -> u64

Next monotonic sequence number.

Source

pub fn record(&self, trace: Trace)

Stores a trace, evicting the oldest entries beyond max_traces.

Source

pub fn list(&self) -> Vec<TraceSummary>

Summaries, newest first.

Source

pub fn get(&self, id: &str) -> Option<Arc<Trace>>

Fetches one trace. Clones an Arc under the lock so serialization happens outside it.

Source

pub fn clear(&self) -> usize

Empties the buffer, returning how many traces were dropped.

Source

pub fn len(&self) -> usize

Number of traces currently held.

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<T> MaybeSend for T