Struct Event 

#[non_exhaustive]
pub struct Event {
    pub name: String,
    pub tool: String,
    pub tool_version: String,
    pub machine_id: String,
    pub timestamp_utc: String,
    pub args: Option<String>,
    pub err_msg: Option<String>,
    pub attrs: HashMap<String, String>,
}

A single telemetry event. #[non_exhaustive] so new fields can be added in a minor bump without breaking downstream match arms.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The event name, e.g. command.invoke, tool.start.

tool: String

The owning tool’s name.

tool_version: String

The owning tool’s version string.

machine_id: String

Salted SHA-256 of the host’s machine ID — hex-encoded.

timestamp_utc: String

RFC 3339 / ISO 8601 UTC timestamp.

args: Option<String>

Raw command-line args, when the caller chose to record them. Redacted automatically by out-of-process sinks via rtb_redact::string; see Event::redacted.

err_msg: Option<String>

Error / panic message, when the caller chose to record it. Redacted automatically by out-of-process sinks via rtb_redact::string; see Event::redacted.

attrs: HashMap<String, String>

Freeform string attributes.

Privacy — callers own redaction for attrs

Event::args and Event::err_msg flow through the framework redactor before leaving the process (see Event::redacted, applied by every built-in out-of-process sink). Values placed in attrs are not auto-redacted: callers must either use stable enumerated values or run rtb_redact::string themselves.

Prefer stable enumerated values for attrs: the command name, an outcome (ok/error/cancelled), a duration bucket, a framework-supplied version. Free-form strings belong in args or err_msg so they pick up the automatic redaction.

Implementations

impl Event

pub fn with_timestamp( name: impl Into<String>, tool: impl Into<String>, tool_version: impl Into<String>, machine_id: impl Into<String>, timestamp_utc: impl Into<String>, ) -> Self

Construct a fresh event with a caller-supplied timestamp already formatted as RFC 3339 UTC (see Event::now for the auto-timestamp path).

pub fn now( name: impl Into<String>, tool: impl Into<String>, tool_version: impl Into<String>, machine_id: impl Into<String>, ) -> Self

Construct an event stamped with the current UTC time.

pub fn with_attr(self, key: impl Into<String>, value: impl Into<String>) -> Self

Fluent setter for a single attribute. Overwrites existing entries with the same key.

pub fn with_args(self, args: impl Into<String>) -> Self

Attach raw command-line args. Redacted by outbound sinks via Event::redacted.

pub fn with_err_msg(self, msg: impl Into<String>) -> Self

Attach an error / panic message. Redacted by outbound sinks via Event::redacted.

pub fn redacted(&self) -> Self

Return a clone with Event::args and Event::err_msg passed through rtb_redact::string. Every built-in out-of-process sink calls this before serialisation.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Serialize for Event

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.