Struct sirlog::Log

pub struct Log {
    pub level: Level,
    pub process: String,
    pub message: String,
    pub timestamp: DateTime<Utc>,
    pub payload: Value,
}

A log entry

Fields

level: Level

The severity of the entry

process: String

The process that generated this entry

message: String

The log message

timestamp: DateTime<Utc>

The timestamp when the entry was created

payload: Value

Structured information that is relevant to the log message

Implementations

impl Log

pub fn new<M: Display>(level: Level, message: M) -> Self

Create a new log entry with the message and level provided

Panics

This must be called when either a global Configuration is set or from within an async task that is executed within Configuration::run()

pub fn error<M: Display>(message: M) -> Self

Create a new log entry with Level::Error and the message provided

Panics

This must be called when either a global Configuration is set or from within an async task that is executed within Configuration::run()

pub fn warning<M: Display>(message: M) -> Self

Create a new log entry with Level::Warning and the message provided

Panics

This must be called when either a global Configuration is set or from within an async task that is executed within Configuration::run()

pub fn info<M: Display>(message: M) -> Self

Create a new log entry with Level::Info and the message provided

Panics

This must be called when either a global Configuration is set or from within an async task that is executed within Configuration::run()

pub fn debug<M: Display>(message: M) -> Self

Create a new log entry with Level::Debug and the message provided

Panics

This must be called when either a global Configuration is set or from within an async task that is executed within Configuration::run()

pub fn trace<M: Display>(message: M) -> Self

Create a new log entry with Level::Trace and the message provided

Panics

This must be called when either a global Configuration is set or from within an async task that is executed within Configuration::run()

pub fn add<K: Into<String>, V: Serialize>(
    &mut self,
    key: K,
    value: V
) -> Result<&mut Self, Error>

Add extra information to this log entry, useful for attaching information that will help understand the entry or the context in which it was created

pub fn with<K: Into<String>, V: Serialize>(
    self,
    key: K,
    value: V
) -> Result<Self, Error>

The equivalent of add(), but exposed in a builder-style pattern

pub fn submit(self)

Submits this log entry to the current manager

Panics

• If no Configuration is available
• If the manager is not able to receive the log message

Trait Implementations

impl Clone for Log

fn clone(&self) -> Log

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Log

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Log

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

Deserialize this value from the given Serde deserializer.

impl Eq for Log

impl PartialEq<Log> for Log

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

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

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

This method tests for !=.

impl Serialize for Log

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Log

impl StructuralPartialEq for Log