Struct st2_logformat::LogRecord

pub struct LogRecord {
    pub seq_no: u64,
    pub epoch: u64,
    pub timestamp: Timestamp,
    pub local_worker: Worker,
    pub activity_type: ActivityType,
    pub event_type: EventType,
    pub remote_worker: Option<Worker>,
    pub operator_id: Option<OperatorId>,
    pub channel_id: Option<ChannelId>,
    pub correlator_id: Option<u64>,
    pub length: Option<usize>,
}

A LogRecord constitutes the unified struct representation of log messages from various stream processors.

It is the underlying structure from which the PAG construction starts. If necessary, it can also be serialized e.g. into a msgpack representation.

Fields

seq_no: u64

worker-unique identifier of a message, given in order the events are logged in the computation.

epoch: u64

epoch of the computation this record belongs to

timestamp: Timestamp

Event time in nanoseconds since the Epoch (midnight, January 1, 1970 UTC).

local_worker: Worker

Context this event occured in; denotes which of the parallel timelines it belongs to.

activity_type: ActivityType

Describes the instrumentation point which triggered this event.

event_type: EventType

Identifies which end of an edge this program event belongs to.

remote_worker: Option<Worker>

Similar to local_worker but specifies the worker ID for the other end of a sent/received message.

operator_id: Option<OperatorId>

Unique id for the operator in the dataflow. This only applies for some event types, e.g. scheduling or processing.

channel_id: Option<ChannelId>

Unique id for the channel in the dataflow. This only applies for some event types, e.g. data / control messages.

correlator_id: Option<u64>

correlates remote events belonging together

length: Option<usize>

Number of records to detect skew

Trait Implementations

impl Clone for LogRecord

fn clone(&self) -> LogRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for LogRecord

fn cmp(&self, other: &LogRecord) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<LogRecord> for LogRecord

fn partial_cmp(&self, other: &LogRecord) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<LogRecord> for LogRecord

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for LogRecord

impl Debug for LogRecord

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

Formats the value using the given formatter.

impl Hash for LogRecord

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Abomonation for LogRecord

unsafe fn entomb<W: Write>(&self, _write: &mut W) -> Result<()>

Write any additional information about &self beyond its binary representation.

fn extent(&self) -> usize

Reports the number of further bytes required to entomb self.

unsafe fn exhume<'a, 'b>(
    &'a mut self,
    bytes: &'b mut [u8]
) -> Option<&'b mut [u8]>

Recover any information for &mut self not evident from its binary representation.