Skip to main content

StatsServer

Struct StatsServer 

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

A bound TCP listener serving the stats endpoint.

Construct via StatsServer::bind then call StatsServer::run to accept connections in a loop, or StatsServer::accept_one for one-shot tests.

§Examples

use std::sync::Arc;
use dynomite::stats::{Snapshot, StatsServer};
use parking_lot::Mutex;

let sink = Arc::new(Mutex::new(Snapshot::default()));
let server = StatsServer::bind("127.0.0.1:0".parse().unwrap(), sink).await?;
let _addr = server.local_addr()?;

Implementations§

Source§

impl StatsServer

Source

pub async fn bind( addr: SocketAddr, source: Arc<Mutex<Snapshot>>, ) -> Result<Self>

Bind a listener at addr. Returns the bound server alongside its actual local address (useful when binding to port 0).

§Examples
use std::sync::Arc;
use dynomite::stats::{Snapshot, StatsServer};
use parking_lot::Mutex;

let sink = Arc::new(Mutex::new(Snapshot::default()));
let _server = StatsServer::bind("127.0.0.1:0".parse().unwrap(), sink).await?;
Source

pub fn with_cluster_info_provider(self, provider: ClusterInfoProvider) -> Self

Attach a ClusterInfoProvider so the server answers GET /cluster-info.txt with a freshly assembled snapshot. When no provider is registered the route returns 503 Service Unavailable.

§Examples
use std::sync::Arc;
use dynomite::admin::cluster_info::ClusterInfoSnapshot;
use dynomite::stats::{Snapshot, StatsServer};
use parking_lot::Mutex;

let sink = Arc::new(Mutex::new(Snapshot::default()));
let server = StatsServer::bind("127.0.0.1:0".parse().unwrap(), sink)
    .await?
    .with_cluster_info_provider(Arc::new(ClusterInfoSnapshot::synthetic));
drop(server);
Source

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the local socket address the server is listening on.

§Examples
use std::sync::Arc;
use dynomite::stats::{Snapshot, StatsServer};
use parking_lot::Mutex;

let sink = Arc::new(Mutex::new(Snapshot::default()));
let server = StatsServer::bind("127.0.0.1:0".parse().unwrap(), sink).await?;
let addr = server.local_addr()?;
assert!(addr.port() != 0);
Source

pub async fn accept_one(&self) -> Result<()>

Accept a single connection, serve one HTTP/1.1 request, and return.

§Examples
use std::sync::Arc;
use dynomite::stats::{Snapshot, StatsServer};
use parking_lot::Mutex;

let sink = Arc::new(Mutex::new(Snapshot::default()));
let server = StatsServer::bind("127.0.0.1:0".parse().unwrap(), sink).await?;
server.accept_one().await?;
Source

pub async fn run(self) -> Result<()>

Run the accept loop until cancelled. Each connection is handled on a fresh task so a slow client cannot stall the listener.

§Examples
use std::sync::Arc;
use dynomite::stats::{Snapshot, StatsServer};
use parking_lot::Mutex;

let sink = Arc::new(Mutex::new(Snapshot::default()));
let server = StatsServer::bind("127.0.0.1:0".parse().unwrap(), sink).await?;
let _ = tokio::spawn(async move { server.run().await });

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> 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.
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
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,