Skip to main content

OcsfEvent

Struct OcsfEvent 

Source
pub struct OcsfEvent {
Show 19 fields pub metadata: Metadata, pub class_name: EventClass, pub class_uid: u32, pub category_uid: u8, pub activity_id: u8, pub type_uid: u64, pub time: u64, pub time_iso: String, pub severity_id: u8, pub status_id: u8, pub session_uid: String, pub ai_agent: AgentIdentity, pub stop_reason_id: Option<u8>, pub stop_reason: Option<String>, pub payload: Value, pub metrics: Option<EventMetrics>, pub inventory: Option<Fingerprint>, pub prev_inventory: Option<Fingerprint>, pub unmapped: Map<String, Value>,
}
Expand description

A schema-conformant agent event.

Unknown inbound fields at the TOP LEVEL are preserved in Self::unmapped (never silently dropped); outbound serialization is always the current schema shape.

§Round-34 F3 — additive tolerance is TOP-LEVEL ONLY

The deny_unknown_fields attribute on every nested struct (Metadata, AgentIdentity, Product, CharterFile, EventMetrics, Fingerprint) means an unknown field INSIDE one of those objects fails deserialization for the whole event — it does NOT flow into unmapped. Cross-version replay of a mixed-fleet stream during a rolling upgrade therefore requires that nested-object shape additions bump config_version in lockstep with the schema; only newly-added TOP-LEVEL fields are safe to deploy incrementally. This asymmetry is deliberate: nested types are the audit-trail schema surface consumers commit to (SIEM ingestion pipelines depend on their exact shape), while the top-level union tolerates additive OCSF evolution so consumers can continue to parse events emitted by newer nodes during a rolling deploy of the harness itself.

Fields§

§metadata: Metadata

Event metadata.

§class_name: EventClass

Class enum (serialized as agent.<class>).

§class_uid: u32

Numeric class uid.

§category_uid: u8

OCSF Application Activity category uid.

§activity_id: u8

Activity within the class (1 = default activity).

§type_uid: u64

class_uid * 100 + activity_id per OCSF convention.

§time: u64

Epoch milliseconds.

§time_iso: String

ISO-8601 mirror of time for human consumers.

§severity_id: u8

Severity (1 = informational … 6 = fatal).

§status_id: u8

Outcome status.

§session_uid: String

Session this event belongs to.

§ai_agent: AgentIdentity

Agent config-state identity block.

§stop_reason_id: Option<u8>

Stop reason id, when applicable.

§stop_reason: Option<String>

Stop reason text: the provider’s native value when captured, otherwise the normalized crate::StopReason caption.

§payload: Value

Class-specific payload.

§metrics: Option<EventMetrics>

Token metrics (ATIF-mirrored names).

§inventory: Option<Fingerprint>

Per-forward-pass inventory fingerprint (roadmap, flag-gated).

§prev_inventory: Option<Fingerprint>

Previous inventory fingerprint (chained like prev_event).

§unmapped: Map<String, Value>

Unknown fields captured on inbound parse (evolution tolerance).

Trait Implementations§

Source§

impl Clone for OcsfEvent

Source§

fn clone(&self) -> OcsfEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OcsfEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for OcsfEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for OcsfEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for OcsfEvent

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for OcsfEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,