Enum LogFormat 

pub enum LogFormat {
    Default,
    Rfc5424,
    Rfc3164,
    Json,
}

Selectable on-disk / on-stderr shape for emitted tracing events.

Examples

use dynomite::core::log::LogFormat;
assert_eq!(LogFormat::default(), LogFormat::Default);

Variants

Default

Human-readable text via tracing_subscriber::fmt(). This is the historical default and is what dynomited emits when neither the configuration nor the CLI request another shape.

Rfc5424

Modern structured syslog per RFC 5424.

Rfc3164

BSD-style syslog per RFC 3164.

The user-facing brief originally said “RFC 3124” - that is “The Congestion Manager” and is unrelated to logging. We treat it as a typo for RFC 3164 and implement the BSD syslog shape here.

Json

Newline-delimited JSON, one event per line. Selected by either json or ndjson.

Implementations

impl LogFormat

pub fn parse(s: &str) -> Result<Self, LogFormatParseError>

Parse a configuration / CLI value into a LogFormat.

The match is case-insensitive. Empty input maps to LogFormat::Default so a YAML value of "" (or no value at all) selects the default. The aliases json and ndjson both map to LogFormat::Json.

Examples

use dynomite::core::log::LogFormat;
assert_eq!(LogFormat::parse("").unwrap(), LogFormat::Default);
assert_eq!(LogFormat::parse("json").unwrap(), LogFormat::Json);
assert_eq!(LogFormat::parse("ndjson").unwrap(), LogFormat::Json);
assert!(LogFormat::parse("xml").is_err());

pub fn as_str(self) -> &'static str

Stable canonical name used by the CLI / config / docs.

Examples

use dynomite::core::log::LogFormat;
assert_eq!(LogFormat::Json.as_str(), "json");
assert_eq!(LogFormat::Rfc5424.as_str(), "rfc5424");

Trait Implementations

impl Clone for LogFormat

fn clone(&self) -> LogFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogFormat

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

Formats the value using the given formatter.

impl Default for LogFormat

fn default() -> Self

Returns the “default value” for a type.

impl Display for LogFormat

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

Formats the value using the given formatter.

impl Hash for LogFormat

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LogFormat

fn eq(&self, other: &LogFormat) -> 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 Copy for LogFormat

impl Eq for LogFormat

impl StructuralPartialEq for LogFormat