Struct ErrorLogger

pub(super) struct ErrorLogger {
    shutdown_probe: ShutdownProbe,
    dataflow_name: String,
}

Error logger to be used by rendering code.

Holds onto a [ShutdownProbe] to ensure that no false-positive errors are logged while the dataflow is in the process of shutting down.

Fields

shutdown_probe: ShutdownProbe

dataflow_name: String

Implementations

impl ErrorLogger

pub fn new(shutdown_probe: ShutdownProbe, dataflow_name: String) -> Self

pub fn log(&self, message: &'static str, details: &str)

Log the given error, unless the dataflow is shutting down.

The logging format is optimized for surfacing errors with Sentry:

• error is logged at ERROR level and will appear as the error title in Sentry. We require it to be a static string, to ensure that Sentry always merges instances of the same error together.
• details is logged at WARN level and will appear in the breadcrumbs. Put relevant dynamic information here.

The message that’s logged at WARN level has the format “[customer-data] {message} ({details})” We include the [customer-data] tag out of the expectation that details will always contain some sensitive customer data. We include the message to make it possible to match the breadcrumbs to their associated error in Sentry.

pub fn log_always(&self, message: &'static str, details: &str)

Like Self::log, but also logs errors when the dataflow is shutting down.

Use this method to notify about errors that cannot be caused by dataflow shutdown.

pub fn soft_panic_or_log(&self, message: &'static str, details: &str)

Like Self::log_always, but panics in debug mode.

Use this method to notify about errors that are certainly caused by bugs in Materialize.

Trait Implementations

impl Clone for ErrorLogger

fn clone(&self) -> ErrorLogger

Returns a duplicate of the value.

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

Performs copy-assignment from source.