Skip to main content

SessionMetrics

Struct SessionMetrics 

Source
pub struct SessionMetrics {
Show 15 fields pub start: Option<Instant>, pub start_wall: Option<SystemTime>, pub service_time: Duration, pub wait_time: Duration, pub bin: usize, pub bout: usize, pub service_start: Option<Instant>, pub wait_start: Instant, pub backend_id: Option<Rc<str>>, pub backend_start: Option<Instant>, pub backend_connected: Option<Instant>, pub backend_headers_received: Option<Instant>, pub backend_stop: Option<Instant>, pub backend_bin: usize, pub backend_bout: usize,
}

Fields§

§start: Option<Instant>

date at which we started handling that request

§start_wall: Option<SystemTime>

wall-clock timestamp captured alongside start, for access-log consumers that need an absolute start time (e.g. OTel span reconstruction) without subtracting a monotonic duration from a wall-clock end time — which mixes two unsynchronised clock sources.

§service_time: Duration

time actually spent handling the request

§wait_time: Duration

time spent waiting for its turn

§bin: usize

bytes received by the frontend

§bout: usize

bytes sent by the frontend

§service_start: Option<Instant>

date at which we started working on the request

§wait_start: Instant§backend_id: Option<Rc<str>>

The id of the backend serving this request. An Rc<str> so the mux shares the one its BackendId carries instead of copying it (#1579).

§backend_start: Option<Instant>§backend_connected: Option<Instant>§backend_headers_received: Option<Instant>

date at which the backend’s response headers finished parsing — the time-to-first-header-byte anchor nginx calls $upstream_header_time. Set by the L7 read paths only; raw TCP has no headers and leaves it None (see SessionMetrics::backend_header_time).

§backend_stop: Option<Instant>§backend_bin: usize§backend_bout: usize

Implementations§

Source§

impl SessionMetrics

Source

pub fn new(wait_time: Option<Duration>) -> SessionMetrics

Source

pub fn reset(&mut self)

Source

pub fn service_start(&mut self)

Source

pub fn service_stop(&mut self)

Source

pub fn wait_start(&mut self)

Source

pub fn service_time(&self) -> Duration

Source

pub fn mark_request_start(&mut self) -> Instant

Arm both the monotonic and wall-clock start timestamps together. This must be the single place that sets start + start_wall outside of new(), so the two fields can never desynchronize. Returns the monotonic instant so callers that need it (e.g. service_start) can reuse it without a second syscall.

Source

pub fn request_time(&self) -> Duration

time elapsed since the beginning of the session

Source

pub fn start_wall_ns(&self) -> Option<i128>

Wall-clock start time as nanoseconds since the Unix epoch, or None if the monotonic start has not been set yet (post-reset(), pre-service_start()).

Source

pub fn backend_start(&mut self)

Source

pub fn backend_connected(&mut self)

Source

pub fn backend_headers_received(&mut self)

The backend’s response headers have just finished parsing. Called from the L7 read paths at the header -> body transition, once per response.

Overwrites, exactly like Self::backend_stop and for the same reason: a 1xx informational response is forwarded and the back buffer is then cleared — ConnectionH1::writable (lib/src/protocol/mux/h1.rs) in its 100-Continue and other-interim (102-199) arms, ConnectionH2::handle_1xx_reset (lib/src/protocol/mux/h2.rs) — so the final response re-enters that transition from the initial parsing phase. Last write wins, which anchors this on the FINAL response headers — the same response backend_stop anchors on, and what nginx reports in $upstream_header_time. A set-once guard would anchor the pair on two different responses and floor the metric at ~0ms for every Expect: 100-continue client, hiding the upstream think time the metric exists to expose.

Source

pub fn backend_stop(&mut self)

Source

pub fn backend_response_time(&self) -> Option<Duration>

Source

pub fn backend_connection_time(&self) -> Option<Duration>

Source

pub fn backend_header_time(&self) -> Option<Duration>

Time from the established backend connection to the moment its response headers finished parsing — nginx’s $upstream_header_time, the third of the three upstream timings of sozu-proxy/sozu#426.

Deliberately WITHOUT the elapsed-so-far fallback that Self::backend_response_time carries for its backend_stop-is-None case. That fallback serves a live read of a response still streaming; a time-to-first-header-byte has no in-flight meaning, because no header byte has arrived. Returning Instant::now() - connected anyway would publish a value that grows with the wait and then freezes wherever the session ended — indistinguishable, on a dashboard, from a slow backend that did answer. None is the honest answer, and it is also what keeps raw TCP (lib/src/tcp.rs, no headers at all) recording nothing here instead of recording a zero.

Source

pub fn register_end_of_session(&self, context: &LogContext<'_>)

Trait Implementations§

Source§

impl Clone for SessionMetrics

Source§

fn clone(&self) -> Self

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 SessionMetrics

Source§

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

Formats the value using the given formatter. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

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

Source§

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

Source§

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.