Struct TraceMetadata 

pub struct TraceMetadata { /* private fields */ }

Per-pass state handed to Context::apply and Context::cleanup.

It collects annotations for the pass’s tracing span, times steps, overrides the pass’s reported outcome, and publishes events about the resource being reconciled.

A TraceMetadata created with Default (for instance, to call a reconciler from a unit test) accepts all of these, but reports steps and publishes events nowhere.

Implementations

impl TraceMetadata

pub fn annotate<K: Display, V: Display>(&mut self, key: K, val: V)

Adds a key/value pair to the metadata field of the pass’s reconcile tracing span, replacing any earlier value for key.

pub fn step(&self, name: &'static str) -> Step

Starts timing the step named name. See Step.

Step names become metric labels, so they should come from a small fixed set.

pub fn set_outcome(&mut self, outcome: Outcome)

Overrides the outcome reported for this pass, if the reconciler returns Ok. By default the outcome is classified from what the reconciler returns; an Err is always reported as Outcome::Failed.

pub async fn publish_event(&self, event: Event)

Publishes event about the resource being reconciled, using the controller’s event recorder. Does nothing if the controller has none.

Failure to publish is logged rather than returned, since an event only reports on reconciliation and should not change its course. Use EventRecorder::publish directly to handle errors.

Trait Implementations

impl Debug for TraceMetadata

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

Formats the value using the given formatter.

impl Default for TraceMetadata

fn default() -> TraceMetadata

Returns the “default value” for a type.