Struct PrometheusConfig 

pub struct PrometheusConfig { /* private fields */ }

Available on crate features observability and prometheus only.

Where and how metrics are exposed.

Implementations

impl PrometheusConfig

pub fn new() -> PrometheusConfig

/metrics on the application listener.

pub fn path(self, path: impl Into<String>) -> PrometheusConfig

The scrape path. Default /metrics.

Panics

Panics if path does not start with /.

pub fn listen(self, address: SocketAddr) -> PrometheusConfig

Serves metrics on a separate listener instead of the application’s. Recommended in production: the port can be firewalled to the Prometheus servers, and scrapes never share a connection limit or middleware with user traffic.

pub fn scope_labels(self, enabled: bool) -> PrometheusConfig

Adds otel_scope_name/otel_scope_version labels to every series. Off by default: they add a label to every series without helping most dashboards.

pub fn target_info(self, enabled: bool) -> PrometheusConfig

Emits the target_info series carrying resource attributes. Default on; join it in PromQL to filter by service or environment.

pub fn resource_labels<I, K>(self, keys: I) -> PrometheusConfig

where I: IntoIterator<Item = K>, K: Into<String>,

Resource attributes copied onto every series as labels (dots become underscores). Default: service.name, so dashboards can filter by service_name both here and behind an OpenTelemetry Collector with resource_to_telemetry_conversion. Each entry is one constant label per process and does not increase cardinality.

pub fn namespace(self, namespace: impl Into<String>) -> PrometheusConfig

Prefixes every metric name with namespace_.

pub fn scrape_path(&self) -> &str

The configured scrape path.

pub fn listen_address(&self) -> Option<SocketAddr>

The separate listener address, if any.

Trait Implementations

impl Clone for PrometheusConfig

fn clone(&self) -> PrometheusConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrometheusConfig

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

Formats the value using the given formatter.

impl Default for PrometheusConfig

fn default() -> PrometheusConfig

Returns the “default value” for a type.