Struct gelf_logger::Config

pub struct Config { /* private fields */ }

Struct to manipulate configuration.

Implementations

impl Config

pub fn try_from_yaml(path: &str) -> Result<Config, Error>

Load configuration using the given path file.

Example

use gelf_logger::Config;

let config = Config::try_from_yaml("/tmp/myconf.yml").unwrap();

pub fn ldp(cluster: &str, token: &str) -> Config

Shortcut to create a valid configuration for OVH LDP service.

Example

[dependencies.gelf_logger]
version = "*"
features = ["ovh-ldp"]

And then:

use gelf_logger::Config;

let cfg = Config::ldp("gra1.logs.ovh.com", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

pub fn level(&self) -> GelfLevel

The threshold for this logger to level. Logging messages which are less severe than level will be ignored.

pub fn hostname(&self) -> &String

The name of the remote server.

pub fn port(&self) -> u64

The port of the remote host.

pub fn null_character(&self) -> bool

Adds a NUL byte (\0) after each entry.

pub fn use_tls(&self) -> bool

Activate transport security.

pub fn async_buffer_size(&self) -> Option<usize>

Get the asynchronous buffer size. This buffer is placed between the log subsystem and the network sender. This represent the maximum number of message the system will buffer before blocking while waiting for message to be actually sent to the remote server.

If None is configured, it defaults to 1000

pub fn buffer_size(&self) -> Option<usize>

Get the upperbound limit on the number of records that can be placed in the buffer, once this size has been reached, the buffer will be sent to the remote server.

pub fn buffer_duration(&self) -> Option<Duration>

Get the maximum lifetime of the buffer before send it to the remote server.

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

Every additional data which will be append to each log entry.

pub fn full_buffer_policy(&self) -> Option<FullBufferPolicy>

Get the full buffer policy

pub fn write_timeout(&self) -> Option<Duration>

Get the write timeout

pub fn connect_timeout(&self) -> Option<Duration>

Get the connect timeout

pub fn builder() -> ConfigBuilder

Returns a new builder.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Config> for GelfTcpOutput

fn from(cfg: &Config) -> GelfTcpOutput

Converts to this type from the input type.