Skip to main content

MetricsServer

Struct MetricsServer 

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

HTTP server for exposing Prometheus metrics.

The server provides a /metrics endpoint that returns all registered metrics in Prometheus text exposition format. The server runs asynchronously and can be gracefully shut down.

Implementations§

Source§

impl MetricsServer

Source

pub fn new(config: MetricsServerConfig, registry: MetricsRegistry) -> Self

Creates a new metrics server with the given configuration and registry.

§Arguments
  • config - Server configuration (bind address and port)
  • registry - Metrics registry to export
§Example
use elara_runtime::observability::metrics::MetricsRegistry;
use elara_runtime::observability::metrics_server::{MetricsServer, MetricsServerConfig};

let registry = MetricsRegistry::new();
let config = MetricsServerConfig::default();
let server = MetricsServer::new(config, registry);
Source

pub async fn start(&mut self) -> Result<(), MetricsServerError>

Starts the metrics server.

This method spawns the HTTP server on a background task and returns immediately. The server will continue running until shutdown() is called or the process exits.

§Errors

Returns MetricsServerError::BindError if the server cannot bind to the specified address/port (e.g., port already in use).

§Example
let registry = MetricsRegistry::new();
let config = MetricsServerConfig::default();
let mut server = MetricsServer::new(config, registry);
 
server.start().await?;
Source

pub async fn shutdown(&mut self)

Shuts down the metrics server gracefully.

This method aborts the server task and waits for it to complete. After shutdown, the server can be restarted by calling start() again.

§Example
let mut server = MetricsServer::new(config, registry);
server.start().await?;
 
// ... do work ...
 
server.shutdown().await;
Source

pub fn is_running(&self) -> bool

Returns true if the server is currently running.

Source

pub fn bind_address(&self) -> &str

Returns the configured bind address.

Source

pub fn port(&self) -> u16

Returns the configured port.

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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> 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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,