Struct Reporter

pub struct Reporter {
    pub controller: String,
    pub instance: Option<String>,
}

Information about the reporting controller.

use kube::runtime::events::Reporter;

let reporter = Reporter {
    controller: "my-awesome-controller".into(),
    instance: std::env::var("CONTROLLER_POD_NAME").ok(),
};

Fields

controller: String

The name of the reporting controller that is publishing the event.

This is likely your deployment.metadata.name.

instance: Option<String>

The id of the controller publishing the event. Likely your pod name.

Useful when running more than one replica on your controller and you need to disambiguate where events came from.

The name of the controller pod can be retrieved using Kubernetes’ API or it can be injected as an environment variable using

env:
  - name: CONTROLLER_POD_NAME
    valueFrom:
      fieldRef:
        fieldPath: metadata.name

in the manifest of your controller.

Note: If instance is not provided, the hostname is used. If the hostname is also unavailable, reporting_instance defaults to reporting_controller in the Event.

Trait Implementations

impl Clone for Reporter

fn clone(&self) -> Reporter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Reporter

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

Formats the value using the given formatter.

impl From<&str> for Reporter

fn from(es: &str) -> Self

Converts to this type from the input type.

impl From<String> for Reporter

fn from(es: String) -> Self

Converts to this type from the input type.

impl Hash for Reporter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Reporter

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Reporter

impl StructuralPartialEq for Reporter