Struct AdminSection 

#[non_exhaustive]
pub struct AdminSection {
    pub listen: Option<SocketAddr>,
}

The HTTP server carrying /metrics, /healthz and /readyz (admin:).

One server serves all three. The probes answer regardless of MetricsSection::exporter. /metrics is served only where this pipeline’s own handle renders an exposition. exporter: none leaves it a 404, and so does a recorder another library installed first, which this pipeline records into but cannot render.

Construct with AdminSection::default and set the fields. The struct is #[non_exhaustive] so new knobs can be added without breaking callers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

listen: Option<SocketAddr>

Bind address, or none for no server at all.

With no server the probes and the exposition are unreachable over HTTP. The exposition is still readable in-process through Pipeline::metrics, which is what an embedding program mounting it on its own server uses.

A port of 0 asks the kernel to pick a free one, and the start logs the address the server bound, at INFO. Monitoring names the message it goes out under.

Trait Implementations

impl Debug for AdminSection

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

Formats the value using the given formatter.

impl Default for AdminSection

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AdminSection

where AdminSection: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AdminSection

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for AdminSection