|
| 1 | +//! Utilities for publishing Kubernetes events |
| 2 | +
|
| 3 | +use std::error::Error; |
| 4 | + |
| 5 | +use crate::client::Client; |
| 6 | +use kube::runtime::{ |
| 7 | + controller, |
| 8 | + events::{Event, EventType, Recorder, Reporter}, |
| 9 | +}; |
| 10 | +use tracing::Instrument; |
| 11 | + |
| 12 | +use super::controller::ReconcilerError; |
| 13 | + |
| 14 | +/// Converts an [`Error`] into a publishable Kubernetes [`Event`] |
| 15 | +fn error_to_event<E: ReconcilerError>(err: &E) -> Event { |
| 16 | + // Walk the whole error chain, so that we get all the full reason for the error |
| 17 | + let full_msg = { |
| 18 | + use std::fmt::Write; |
| 19 | + let mut buf = err.to_string(); |
| 20 | + let mut err: &dyn Error = err; |
| 21 | + loop { |
| 22 | + err = match err.source() { |
| 23 | + Some(err) => { |
| 24 | + write!(buf, ": {}", err).unwrap(); |
| 25 | + err |
| 26 | + } |
| 27 | + None => break buf, |
| 28 | + } |
| 29 | + } |
| 30 | + }; |
| 31 | + Event { |
| 32 | + type_: EventType::Warning, |
| 33 | + reason: err.category().to_string(), |
| 34 | + note: Some(full_msg), |
| 35 | + action: "Reconcile".to_string(), |
| 36 | + secondary: err.secondary_object().map(|secondary| secondary.into()), |
| 37 | + } |
| 38 | +} |
| 39 | + |
| 40 | +/// Reports an error coming from a controller to Kubernetes |
| 41 | +/// |
| 42 | +/// This is inteded to be executed on the log entries returned by [`Controller::run`] |
| 43 | +#[tracing::instrument(skip(client))] |
| 44 | +pub fn publish_controller_error_as_k8s_event<ReconcileErr, QueueErr>( |
| 45 | + client: &Client, |
| 46 | + controller: &str, |
| 47 | + controller_error: &controller::Error<ReconcileErr, QueueErr>, |
| 48 | +) where |
| 49 | + ReconcileErr: ReconcilerError, |
| 50 | + QueueErr: Error, |
| 51 | +{ |
| 52 | + let (error, obj) = match controller_error { |
| 53 | + controller::Error::ReconcilerFailed(err, obj) => (err, obj), |
| 54 | + // Other error types are intended for the operator administrator, and aren't linked to a specific object |
| 55 | + _ => return, |
| 56 | + }; |
| 57 | + let recorder = Recorder::new( |
| 58 | + client.as_kube_client(), |
| 59 | + Reporter { |
| 60 | + controller: controller.to_string(), |
| 61 | + instance: None, |
| 62 | + }, |
| 63 | + obj.clone().into(), |
| 64 | + ); |
| 65 | + let event = error_to_event(error); |
| 66 | + // Run in the background |
| 67 | + tokio::spawn( |
| 68 | + async move { |
| 69 | + if let Err(err) = recorder.publish(event).await { |
| 70 | + tracing::error!( |
| 71 | + error = &err as &dyn std::error::Error, |
| 72 | + "Failed to report error as K8s event" |
| 73 | + ); |
| 74 | + } |
| 75 | + } |
| 76 | + .in_current_span(), |
| 77 | + ); |
| 78 | +} |
| 79 | + |
| 80 | +#[cfg(test)] |
| 81 | +mod tests { |
| 82 | + use k8s_openapi::api::core::v1::ConfigMap; |
| 83 | + use kube::runtime::reflector::ObjectRef; |
| 84 | + use strum_macros::EnumDiscriminants; |
| 85 | + |
| 86 | + use super::{error_to_event, ReconcilerError}; |
| 87 | + |
| 88 | + #[derive(Debug, thiserror::Error, EnumDiscriminants)] |
| 89 | + #[strum_discriminants(derive(strum_macros::IntoStaticStr))] |
| 90 | + enum ErrorFoo { |
| 91 | + #[error("bar failed")] |
| 92 | + Bar { source: ErrorBar }, |
| 93 | + } |
| 94 | + #[derive(Debug, thiserror::Error)] |
| 95 | + enum ErrorBar { |
| 96 | + #[error("baz failed")] |
| 97 | + Baz { source: ErrorBaz }, |
| 98 | + } |
| 99 | + #[derive(Debug, thiserror::Error)] |
| 100 | + enum ErrorBaz { |
| 101 | + #[error("couldn't find chocolate")] |
| 102 | + NoChocolate { descriptor: ObjectRef<ConfigMap> }, |
| 103 | + } |
| 104 | + impl ErrorFoo { |
| 105 | + fn no_chocolate() -> Self { |
| 106 | + Self::Bar { |
| 107 | + source: ErrorBar::Baz { |
| 108 | + source: ErrorBaz::NoChocolate { |
| 109 | + descriptor: ObjectRef::new("chocolate-descriptor").within("cupboard"), |
| 110 | + }, |
| 111 | + }, |
| 112 | + } |
| 113 | + } |
| 114 | + } |
| 115 | + impl ReconcilerError for ErrorFoo { |
| 116 | + fn category(&self) -> &'static str { |
| 117 | + ErrorFooDiscriminants::from(self).into() |
| 118 | + } |
| 119 | + |
| 120 | + fn secondary_object(&self) -> Option<ObjectRef<kube::core::DynamicObject>> { |
| 121 | + match self { |
| 122 | + ErrorFoo::Bar { |
| 123 | + source: |
| 124 | + ErrorBar::Baz { |
| 125 | + source: ErrorBaz::NoChocolate { descriptor }, |
| 126 | + }, |
| 127 | + } => Some(descriptor.clone().erase()), |
| 128 | + } |
| 129 | + } |
| 130 | + } |
| 131 | + |
| 132 | + #[test] |
| 133 | + fn event_should_report_full_nested_message() { |
| 134 | + let err = ErrorFoo::no_chocolate(); |
| 135 | + assert_eq!( |
| 136 | + error_to_event(&err).note.as_deref(), |
| 137 | + Some("bar failed: baz failed: couldn't find chocolate") |
| 138 | + ); |
| 139 | + } |
| 140 | + |
| 141 | + #[test] |
| 142 | + fn event_should_include_secondary_object() { |
| 143 | + let err = ErrorFoo::no_chocolate(); |
| 144 | + let event = error_to_event(&err); |
| 145 | + let secondary = event.secondary.unwrap(); |
| 146 | + assert_eq!(secondary.name.as_deref(), Some("chocolate-descriptor")); |
| 147 | + assert_eq!(secondary.namespace.as_deref(), Some("cupboard")); |
| 148 | + assert_eq!(secondary.kind.as_deref(), Some("ConfigMap")); |
| 149 | + } |
| 150 | + |
| 151 | + #[test] |
| 152 | + fn event_should_include_reason_code() { |
| 153 | + let err = ErrorFoo::no_chocolate(); |
| 154 | + let event = error_to_event(&err); |
| 155 | + assert_eq!(event.reason, "Bar"); |
| 156 | + } |
| 157 | +} |
![bors[bot]](https://avatars.githubusercontent.com/in/1847?v=4&size=40){kind=avatar}
0 commit comments