Skip to main content

RequestStreamMetrics

Struct RequestStreamMetrics 

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

Per-request streaming metrics collector.

Call record_first_token on the first generated token, record_token for each subsequent token, and finish when generation is complete.

Implementations§

Source§

impl RequestStreamMetrics

Source

pub fn new() -> Self

Create a new metrics collector with zero prompt tokens.

Source

pub fn new_with_prompt_tokens(prompt_tokens: usize) -> Self

Create a new metrics collector that records the prompt token count.

Source

pub fn record_first_token(&mut self)

Record the arrival of the first generated token.

Calling this multiple times is safe — only the first call is recorded.

Source

pub fn record_token(&mut self)

Record the arrival of a subsequent generated token (not the first).

If record_first_token has not been called yet, this call is treated as the first token.

Source

pub fn finish(&mut self)

Mark the end of the generation pass.

This records a final timestamp used for end-to-end latency. It is safe to call even before any tokens have been recorded.

Source

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

Time to first token (TTFT).

Returns None if record_first_token has not been called.

Source

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

Median inter-token latency.

Returns None when fewer than two tokens have been recorded (i.e. there are no TBT samples).

Source

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

P99 inter-token latency.

Returns None when there are no TBT samples.

Source

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

Mean (arithmetic average) inter-token latency.

Returns None when there are no TBT samples.

Source

pub fn tokens_per_second(&self) -> Option<f64>

Generation throughput in tokens per second.

Computed over the decode window (from first token to last token) so that TTFT does not distort the throughput figure.

Returns None if the decode window cannot be determined.

Source

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

End-to-end request latency (from request start to generation finish).

Returns None if finish has not been called.

Source

pub fn completion_tokens(&self) -> usize

Total number of completion tokens generated so far.

Source

pub fn snapshot(&self) -> StreamMetricsSnapshot

Take a point-in-time snapshot of the current metrics.

Trait Implementations§

Source§

impl Default for RequestStreamMetrics

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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