Struct EventRecorder 

pub struct EventRecorder { /* private fields */ }

Publishes Kubernetes events on resources on behalf of one controller, aggregating repeats as described in the module documentation.

Share a recorder (via Arc) between a Controller and whatever else publishes events on that controller’s behalf, but not between controllers.

Implementations

impl EventRecorder

pub fn new(client: Client, reporter: Reporter) -> Self

Creates a recorder that publishes events as reporter, with the default timeout.

Reporter::controller becomes each event’s reportingController, shown by kubectl describe as where the event came from. It should name the individual controller, and must be a qualified name (for instance "my-operator.example.com/widgets"), or the API server rejects the event. Reporter::instance becomes each event’s reportingInstance, and should identify the replica, for which the pod name is a good choice; if it is None, the controller name is used instead.

pub fn with_timeout(self, timeout: Duration) -> Self

Sets how long publishing an event may take, including any wait for a concurrent publish of the same event, before giving up with PublishError::Timeout.

pub fn reporter(&self) -> &Reporter

The reporter this recorder publishes events as.

pub async fn publish<K>( &self, resource: &K, event: &Event, ) -> Result<(), PublishError>

where K: Resource, K::DynamicType: Default,

Publishes event about resource.

A note longer than MAX_NOTE_BYTES is truncated to fit rather than having the whole event rejected.

Events are informational, so callers should usually log a failure to publish one rather than let it change what they do next.

pub fn forget<K: Resource>(&self, resource: &K)

Forgets every event published about resource, so that the next event published about it creates a new event object even if it is identical to the last one.

This is useful when an event reports a state that the resource can leave and later re-enter, and each entry should be reported as a distinct occurrence.

Trait Implementations

impl Debug for EventRecorder

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

Formats the value using the given formatter.