#log-format #log-entries #gelf #logs #logging #serde #log-messages

gelf_logger

Minimal rust logger to send log entries in GELF

6 releases

0.2.0 Feb 14, 2024
0.1.4 Dec 2, 2019
0.1.3 Nov 29, 2019
0.1.2 May 23, 2019

#511 in Encoding

Download history 28/week @ 2023-12-18 77/week @ 2024-01-08 123/week @ 2024-01-15 160/week @ 2024-01-22 44/week @ 2024-01-29 38/week @ 2024-02-05 178/week @ 2024-02-12 58/week @ 2024-02-19 95/week @ 2024-02-26 135/week @ 2024-03-04 58/week @ 2024-03-11 57/week @ 2024-03-18 9/week @ 2024-03-25 147/week @ 2024-04-01

281 downloads per month
Used in log4rs-gelf

Custom license

43KB
754 lines

gelf_logger

Build Status Latest version Documentation License

The Graylog Extended Log Format (GELF) is a log format that avoids the shortcomings of classic log formats. GELF is a great choice for logging from within applications. There are libraries and appenders for many programming languages and logging frameworks so it is easy to implement. You could use GELF to send every exception as a log message to your Graylog cluster.

The logger will:

  1. serialize log entries using the serde_gelf crate.
  2. bufferize the result into memory.
  3. batch send over network using TCP/TLS.

Example

use std::time::Duration;

use gelf_logger::{gelf_warn, Config, GelfLevel};
use log::info;
use serde_derive::Serialize;

#[derive(Serialize)]
struct Myapp {
    name: String,
    version: String,
}

impl Default for Myapp {
    fn default() -> Myapp {
        Myapp {
            name: env!("CARGO_PKG_NAME").into(),
            version: env!("CARGO_PKG_VERSION").into(),
        }
    }
}

fn main() {
    let cfg = Config::builder()
        .set_hostname("localhost".into())
        .set_port(12202)
        .set_level(GelfLevel::Informational)
        .set_buffer_duration(Duration::from_millis(300))
        .set_buffer_size(500)
        .put_additional_field("myValue".into(), gelf_logger::Value::I64(10))
        .set_null_character(true)
        .build();

    // Initialize logger
    gelf_logger::init(cfg).unwrap();

    // Send log using a macro defined in the create log
    info!("common message");

    // Use a macro from gelf_logger to send additional data
    gelf_warn!(extra: &Myapp::default(), "My app info");

    // make sure all buffered records are sent before exiting
    gelf_logger::flush().unwrap();
}

License

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

Dependencies

~1–12MB
~135K SLoC