log4rs-gelf 0.1.4

TCP Handler and GELF Encoder to use with the log4rs logging framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# log4rs-gelf 

[![Build Status](https://travis-ci.org/ovh/rust-log4rs-gelf.svg?branch=master)](https://travis-ci.org/ovh/rust-log4rs-gelf) 
[![Latest version](https://img.shields.io/crates/v/log4rs-gelf.svg)](https://crates.io/crates/log4rs-gelf) 
[![Documentation](https://docs.rs/log4rs-gelf/badge.svg)](https://docs.rs/log4rs-gelf) 
![License](https://img.shields.io/crates/l/log4rs-gelf.svg)

`log4rs-gelf` - A TCP/Gelf appender for [log4rs](https://github.com/sfackler/log4rs) based on 
[serde_gelf](https://github.com/ovh/rust-serde_gelf) and [gelf_logger](https://github.com/ovh/rust-gelf_logger).


## Examples

Configuration via a YAML file:

```yaml
appenders:
  ldp:
    additional_fields:
      component: rust-cs
    buffer_duration: 5
    buffer_size: 5
    hostname: 127.0.0.1
    kind: buffer
    level: Informational
    null_character: true
    port: 12202
    use_tls: false
root:
  appenders:
  - ldp
  level: info
```

```rust,no_run
    log4rs_gelf::init_file("/tmp/log4rs.yml", None).unwrap();
```

Programmatically constructing a configuration:

```rust,no_run
use serde_gelf::GelfLevel;
use serde_value::Value;
use log4rs::config::{Config, Appender, Root};
use log::LevelFilter;

fn main() {
   let buffer = log4rs_gelf::BufferAppender::builder()
       .set_level(GelfLevel::Informational)
       .set_hostname("localhost")
       .set_port(12202)
       .set_use_tls(false)
       .set_null_character(true)
       .set_buffer_size(Some(5))
       .set_buffer_duration(Some(5))
       .put_additional_field("component", Value::String("rust-cs".to_string()))
       .build()
       .unwrap();

   let config = Config::builder()
       .appender(Appender::builder().build("gelf", Box::new(buffer)))
       .build(Root::builder().appender("gelf").build(LevelFilter::Info))
       .unwrap();

   log4rs_gelf::init_config(config).unwrap();

   // Do whatever

   log4rs_gelf::flush().expect("Failed to send buffer, log records can be lost !");
}
```

## OVH Log Data Platform

You can activate the OVH [LDP](https://docs.ovh.com/gb/en/logs-data-platform/) 
feature including field typing and an preconfigured handler:

```toml
[dependencies]
log4rs_gelf = { version = "0.1", features = ["ovh-ldp"] }
```

And then build the appender:

```rust,no_run
let buffer = BufferAppender::builder("gra1.logs.ovh.com","XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
    .put_additional_field("component", Value::String("rust-cs".to_string()))
    .build()
    .unwrap();
```

## License

Licensed under [BSD 3-Clause License](./LICENSE) or (https://opensource.org/licenses/BSD-3-Clause)