Struct Observation 

pub struct Observation<T>
where
    T: Observable,
{
    pub version: SchemaVersion,
    pub timestamp: Timestamp,
    pub service: ServiceName,
    pub identity: ProcessIdentity,
    pub trace: Option<TraceContext>,
    pub payload: T,
}

Shared envelope around a typed observation payload.

Fields

version: SchemaVersion

Envelope schema version.

timestamp: Timestamp

UTC observation timestamp.

service: ServiceName

Service that emitted the observation.

identity: ProcessIdentity

Process identity attached to the observation.

trace: Option<TraceContext>

Optional trace context for correlation.

payload: T

Caller-owned typed payload.

Implementations

impl<T> Observation<T>

where T: Observable,

pub fn new(service: ServiceName, payload: T) -> Self

Creates a new observation envelope using the current UTC timestamp.

Examples

use sc_observability_types::{Observation, ServiceName};

let observation = Observation::new(
    ServiceName::new("demo").expect("valid service"),
    "payload".to_string(),
);

assert_eq!(observation.service.as_str(), "demo");
assert_eq!(observation.version.as_str(), "v1");

Trait Implementations

impl<T> Clone for Observation<T>

where T: Observable + Clone,

fn clone(&self) -> Observation<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Observation<T>

where T: Observable + Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Observation<T>

where T: Observable + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> PartialEq for Observation<T>

where T: Observable + PartialEq,

fn eq(&self, other: &Observation<T>) -> 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<T> Serialize for Observation<T>

where T: Observable + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for Observation<T>

where T: Observable,