Struct TelemetryHub 

pub struct TelemetryHub { /* private fields */ }

The engine-wide telemetry hub.

Implementations

impl TelemetryHub

pub fn new() -> Arc<Self>

Creates a shared hub.

pub fn global() -> &'static Arc<TelemetryHub>

The process-wide hub.

Cluster executors do not build their operators — the plan arrives over the wire and the codec rebuilds it — so there is no session object to hand a hub to. The codec attaches this one to every Gpu*Exec it decodes, which is what makes a worker’s /metrics describe the work the worker actually did. Embedded sessions own their own hub and never touch this one.

pub fn register_operator( &self, name: impl Into<String>, backend: BackendKind, ) -> Arc<OperatorStats>

Registers an operator and returns its live counters. Ids increase monotonically for the life of the hub; the oldest registrations are evicted once MAX_OPERATORS are held.

pub fn clear_operators(&self)

Forgets every registered operator (e.g. before running a new query whose dashboard should not show the previous one’s counters).

pub fn record_skip(&self, node: impl Into<String>, reason: impl Into<String>)

Records why the placement rule left a node on the CPU.

pub fn skips(&self) -> Vec<PlacementSkip>

The placement notes recorded since the last Self::clear_skips.

pub fn clear_skips(&self)

Forgets the placement notes (called before planning a fresh query, so the notes belong to the plan being looked at).

pub fn set_plan(&self, nodes: Vec<PlanNodeSummary>)

Replaces the displayed plan.

pub fn set_capacity(&self, capacity: TierCapacity)

Records what the backend says the tiers hold, and whether anything on the query path fills them.

pub fn capacity(&self) -> TierCapacity

What was last recorded by Self::set_capacity.

pub const fn tiers(&self) -> &TierGauges

Memory tier gauges.

pub const fn spill(&self) -> &SpillCounters

Spill counters.

pub fn snapshot(&self) -> TelemetrySnapshot

A consistent point-in-time copy of everything the dashboard renders.

Trait Implementations

impl Debug for TelemetryHub

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

Formats the value using the given formatter.

impl Default for TelemetryHub

fn default() -> Self

Returns the “default value” for a type.