Skip to main content

GelfMessage

Struct GelfMessage 

Source
pub struct GelfMessage { /* private fields */ }
Expand description

One GELF 1.1 message. Build it with GelfMessage::new and set_field, or from a LogRecord with GelfMessage::from_log_record. Display renders the compact JSON text.

Implementations§

Source§

impl GelfMessage

Source

pub fn new(opts: GelfMessageOptions) -> Result<GelfMessage>

Validates opts and returns a message (VALIDATION for a blank host or short message or a bad field key).

Source

pub fn simple( host: impl Into<String>, short_message: impl Into<String>, ) -> Result<Self>

Shorthand for a message with only host and short_message.

Source

pub fn set_field( &mut self, key: &str, value: impl Into<AttrValue>, ) -> Result<()>

Sets an additional field (name or _name). The key is validated with validate_gelf_field_key, the value mapped with gelf_field_value; null removes the field.

Source

pub fn with_field(self, key: &str, value: impl Into<AttrValue>) -> Result<Self>

Builder form of set_field.

Source

pub fn host(&self) -> &str

host.

Source

pub fn short_message(&self) -> &str

short_message.

Source

pub fn full_message(&self) -> Option<&str>

full_message, when set.

Source

pub fn timestamp(&self) -> Option<SystemTime>

Event time, when set.

Source

pub fn level(&self) -> Option<GelfLevel>

level, when set.

Source

pub fn fields(&self) -> &BTreeMap<String, Value>

Additional fields (keys with the _ prefix).

Source

pub fn to_value(&self) -> Value

The GELF wire object: version, host, short_message and, when set, full_message, timestamp, level and the additional fields (keys sorted).

Source

pub fn encode(&self) -> Vec<u8> ⓘ

UTF-8 JSON bytes.

Source

pub fn from_log_record( record: &LogRecord, opts: &FromLogRecordOptions, ) -> GelfMessage

Converts a record with the mapping shared by all five languages: host = resource["host.name"] (else opts.host, else the local host name); short_message = body (- when blank); timestamp; level from the severity; resource attributes flattened with dotted keys (except host.name), then the record attributes (they win), then _trace_id, _span_id and _trace_flags (numeric). Keys go through gelf_field_key, values through gelf_field_value.

Trait Implementations§

Source§

impl Clone for GelfMessage

Source§

fn clone(&self) -> Self

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 GelfMessage

Source§

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

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

impl Display for GelfMessage

Source§

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

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

impl PartialEq for GelfMessage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GelfMessage

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.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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