Skip to main content

ApiMetrics

Struct ApiMetrics 

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

Thread-safe metrics collector for API endpoints.

Tracks per-path request counts, response times, error counts, and active request gauge.

§Example

use auth_framework::api::metrics::ApiMetrics;
use std::time::Duration;
use axum::http::StatusCode;

let m = ApiMetrics::new();
m.record_request("/login");
m.record_response("/login", Duration::from_millis(5), StatusCode::OK);

let snap = m.get_metrics();
assert_eq!(snap.total_requests, 1);

Implementations§

Source§

impl ApiMetrics

Source

pub fn new() -> Self

Create a new, empty metrics collector.

§Example
use auth_framework::api::metrics::ApiMetrics;
let m = ApiMetrics::new();
assert_eq!(m.get_metrics().total_requests, 0);
Source

pub fn record_request(&self, path: &str)

Record an incoming request for path.

Increments the request counter and the active-requests gauge.

§Example
use auth_framework::api::metrics::ApiMetrics;
let m = ApiMetrics::new();
m.record_request("/health");
Source

pub fn record_response( &self, path: &str, duration: Duration, status: StatusCode, )

Record a completed response for path.

Stores the response duration, increments error counters for 4xx/5xx status codes, and decrements the active-requests gauge.

§Example
use auth_framework::api::metrics::ApiMetrics;
use std::time::Duration;
use axum::http::StatusCode;

let m = ApiMetrics::new();
m.record_request("/api");
m.record_response("/api", Duration::from_millis(12), StatusCode::OK);
Source

pub fn get_metrics(&self) -> MetricsSnapshot

Snapshot all collected metrics.

Returns a MetricsSnapshot with uptime, totals, and per-endpoint statistics including average, p95, and p99 response times.

§Example
use auth_framework::api::metrics::ApiMetrics;

let m = ApiMetrics::new();
let snap = m.get_metrics();
assert_eq!(snap.total_requests, 0);
Source

pub fn reset(&self)

Reset all counters and timers.

Clears request counts, response times, error counts, and resets the uptime clock.

§Example
use auth_framework::api::metrics::ApiMetrics;
use std::time::Duration;
use axum::http::StatusCode;

let m = ApiMetrics::new();
m.record_request("/x");
m.record_response("/x", Duration::from_millis(1), StatusCode::OK);
m.reset();
assert_eq!(m.get_metrics().total_requests, 0);

Trait Implementations§

Source§

impl Clone for ApiMetrics

Source§

fn clone(&self) -> ApiMetrics

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 ApiMetrics

Source§

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

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

impl Default for ApiMetrics

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = 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