Struct HooksBuilder 

pub struct HooksBuilder { /* private fields */ }

A builder-like type to create a new Hooks instance.

Implementations

impl HooksBuilder

pub const DEFAULT_BACKGROUND_INTERVAL: Duration

Default interval at which background hooks are refreshed.

pub fn with_hook(self, hook: impl Hook) -> Self

Registers a Hook that runs while metrics are collected.

Only suitable for cheap collection; anything that can take longer than a scrape timeout belongs in with_background_hook.

pub fn install_hook<F, H>(self, f: F) -> Self

where F: FnOnce() -> H, H: Hook,

Registers a Hook by calling the provided closure.

pub fn with_boxed_hook(self, hook: Box<dyn Hook<Output = ()>>) -> Self

Registers a Hook.

pub fn with_background_hook(self, hook: impl Hook) -> Self

Registers a Hook whose collection is refreshed out of band: metrics collection kicks it off, at most once per background_interval and never while a previous refresh is still running, but never waits for it.

Collection that walks a backing store (e.g. every static file jar) scales with the dataset and can take seconds, which would stall a scrape for its entire duration. Such hooks only set gauges, and the interval already means most scrapes render values collected by an earlier one, so serving the previous values while the refresh runs costs at most one scrape worth of freshness.

Background hooks are collected sequentially in registration order. A hook that panics is logged and does not prevent the hooks registered after it from being collected.

pub const fn with_background_interval(self, interval: Duration) -> Self

Sets the minimum interval between the starts of two background collections.

pub fn build(self) -> Hooks

Builds the Hooks collection from the registered hooks.

Trait Implementations

impl Debug for HooksBuilder

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

Formats the value using the given formatter.

impl Default for HooksBuilder

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 64 bytes