Struct PrometheusExporter 

pub struct PrometheusExporter { /* private fields */ }

Available on crate features observability and prometheus only.

A handle that renders and serves the metrics collected by the paired PrometheusReader. Cheap to clone.

Implementations

impl PrometheusExporter

pub fn build( config: PrometheusConfig, ) -> Result<(PrometheusExporter, PrometheusExporter), Error>

Builds the reader (register it with an SdkMeterProvider) and the handle that renders it.

pub fn config(&self) -> &PrometheusConfig

The configuration this exporter was built with.

pub fn render(&self) -> Result<String, Error>

Collects and encodes the current metrics in the Prometheus text format (0.0.4). Synchronous and CPU-bound; prefer render_async from async code.

pub async fn render_async(&self) -> Result<String, Error>

render on Tokio’s blocking pool.

pub fn router<S>(&self) -> Router<S>

where S: Clone + Send + Sync + 'static,

A router answering GET <path>. It carries no Kerniq middleware, so merging it after the application’s middleware has been applied keeps scrapes out of the HTTP metrics.

pub async fn serve( &self, listener: TcpListener, shutdown: impl Future<Output = ()> + Send + 'static, ) -> Result<(), Error>

Serves the metrics endpoint on listener until shutdown completes. Used for PrometheusConfig::listen; usable directly for custom setups.

Trait Implementations

impl Clone for PrometheusExporter

fn clone(&self) -> PrometheusExporter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PrometheusExporter

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

Formats the value using the given formatter.