MetricsEndpoint

Struct MetricsEndpoint 

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

Lightweight HTTP server for exposing Prometheus metrics and health check endpoints.

MetricsEndpoint provides a simple, efficient HTTP server specifically designed for serving metrics to monitoring systems like Prometheus. It handles concurrent requests asynchronously and provides both metrics and health check endpoints.

§Features

§Prometheus Integration

  • Standard Format: Serves metrics in Prometheus exposition format
  • Content-Type: Proper content-type headers for Prometheus compatibility
  • Fresh Data: Generates metrics fresh on each request
  • Error Handling: Graceful error responses for metrics generation failures

§Health Monitoring

  • Health Endpoint: Simple health check endpoint for load balancers
  • Fast Response: Low-latency health check responses
  • Status Codes: Proper HTTP status codes for health states
  • Monitoring Integration: Compatible with various monitoring systems

§Performance Optimized

  • Async Processing: Non-blocking request handling
  • Concurrent Connections: Handles multiple simultaneous requests
  • Low Overhead: Minimal resource usage
  • Efficient Parsing: Simple HTTP request parsing

§Usage Examples

§Basic Server Setup

§Integration with Tokio Runtime

§Configuration

The server is configured through the ConfigService:

  • Port number for the HTTP server
  • Bind address (currently localhost only)
  • Request handling timeouts

§Error Handling

The server handles various error conditions gracefully:

  • Metrics Generation Errors: Returns HTTP 500 with error details
  • Connection Errors: Logs errors and continues serving other requests
  • Invalid Requests: Returns HTTP 404 for unknown endpoints
  • Resource Exhaustion: Graceful degradation under high load

§Thread Safety

The endpoint is thread-safe and can be used concurrently:

  • Immutable after construction
  • Shared metrics service through Arc
  • Safe concurrent request handling

Implementations§

Source§

impl MetricsEndpoint

Source

pub fn new(metrics_service: Arc<MetricsService>) -> Self

Creates a new metrics endpoint server with the provided metrics // service.

§Arguments
  • metrics_service - Arc-wrapped metrics service for generating metrics data
§Returns

A new MetricsEndpoint instance ready to start serving requests.

§Examples
Source

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

Starts the metrics endpoint HTTP server.

This method starts the HTTP server and begins accepting connections. It runs indefinitely, handling incoming requests concurrently. The server will bind to the configured port and serve metrics and health check endpoints.

§Returns
  • Ok(()) - Never returns normally (runs indefinitely)
  • Err(PipelineError) - If server fails to start or bind to port
§Endpoints Served
  • GET /metrics - Prometheus metrics in text format
  • GET /health - Simple health check returning “OK”
  • Other paths return 404 Not Found
§Examples
§Error Handling

The server handles individual request errors gracefully:

  • Connection errors are logged but don’t stop the server
  • Metrics generation errors return HTTP 500
  • Invalid requests return HTTP 404
§Performance
  • Handles requests concurrently using Tokio tasks
  • Low memory overhead per connection
  • Efficient request parsing and response generation

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> 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> 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<T> ErasedDestructor for T
where T: 'static,