Struct tracing_gelf::Builder

pub struct Builder { /* fields omitted */ }

A builder for Logger.

Methods

impl Builder

pub fn additional_field<K: ToString, V: Into<Value>>(
    &mut self,
    key: K,
    value: V
) -> &mut Self

Add a persistent additional field to the GELF messages.

pub fn version<V: ToString>(&mut self, version: V)

Set the GELF version number. Defaults to "1.1".

pub fn line_numbers(&mut self, value: bool) -> &mut Self

Set whether line numbers should be logged. Defaults to true.

pub fn file_names(&mut self, value: bool) -> &mut Self

Set whether file names should be logged. Defaults to true.

pub fn module_paths(&mut self, value: bool) -> &mut Self

Set whether module paths should be logged. Defaults to true.

pub fn reconnection_timeout(&mut self, millis: u32) -> &mut Self

Set the reconnection timeout in milliseconds. Defaults to 10 seconds.

pub fn buffer(&mut self, length: usize) -> &mut Self

Sets the buffer length. Defaults to 512.

pub fn connect_tcp<A>(
    self,
    addr: A
) -> Result<(Logger, Pin<Box<dyn Future<Output = ()> + Send>>), BuilderError> where
    A: ToSocketAddrs,
    A: 'static + Clone + Send + Sync, 

Return Logger and TCP connection background task.

pub fn init_tcp_with_subscriber<A, S>(
    self,
    addr: A,
    subscriber: S
) -> Result<Pin<Box<dyn Future<Output = ()> + Send>>, BuilderError> where
    A: ToSocketAddrs,
    A: 'static + Clone + Send + Sync,
    S: Subscriber + Send + Sync + 'static, 

Initialize logging with a given Subscriber and return TCP connection background task.

pub fn init_tcp<A>(
    self,
    addr: A
) -> Result<Pin<Box<dyn Future<Output = ()> + Send>>, BuilderError> where
    A: ToSocketAddrs,
    A: 'static + Clone + Send + Sync, 

Initialize logging and return TCP connection background task.

pub fn connect_udp(
    self,
    addr: SocketAddr
) -> Result<(Logger, Pin<Box<dyn Future<Output = ()> + Send>>), BuilderError>

Return Logger layer and a UDP connection background task.

pub fn init_udp_with_subscriber<S>(
    self,
    addr: SocketAddr,
    subscriber: S
) -> Result<Pin<Box<dyn Future<Output = ()> + Send>>, BuilderError> where
    S: Subscriber + Send + Sync + 'static, 

Initialize logging with a given Subscriber and return UDP connection background task.

pub fn init_udp<A>(
    self,
    addr: SocketAddr
) -> Result<Pin<Box<dyn Future<Output = ()> + Send>>, BuilderError>

Initialize logging and return UDP connection background task.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the "default value" for a type.