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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
// Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // Copyright 2009 The log4rs-gelf Authors. All rights reserved. //! # log4rs_gelf //! //! [`log4rs`](https://docs.rs/log4rs/*/log4rs/index.html) is a highly configurable logging //! framework modeled after Java's Logback and log4j libraries. //! //! The Graylog Extended Log Format ([GELF](http://docs.graylog.org/en/latest/pages/gelf.html#gelf-payload-specification)) //! is a log format that avoids the shortcomings of classic log formats. GELF is a great choice for //! logging from within applications. You could use GELF to send every exception as a log message //! to your Graylog cluster. //! //! This crate provides the GELF support in log4rs. //! //! ## 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 //! log4rs_gelf::init_file("/tmp/log4rs.yml", None).unwrap(); //! ``` //! Programmatically constructing a configuration: //! ```rust //! 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 !"); //! } //! ``` #![doc( html_logo_url = "https://eu.api.ovh.com/images/com-square-bichro.png", html_favicon_url = "https://www.ovh.com/favicon.ico", )] extern crate gelf_logger; extern crate log; extern crate log4rs; extern crate serde_gelf; extern crate serde_value; pub use appender::{BufferAppender, BufferAppenderBuilder}; mod file; mod appender; /// Initializes the global logger as a log4rs logger configured via a file. /// /// Configuration is read from a file located at the provided path on the /// filesystem and components are created from the provided `Deserializers`. /// /// Any nonfatal errors encountered when processing the configuration are /// reported to stderr. /// /// ### Warning /// /// The logging system may only be initialized once. /// /// ## Example /// /// ```rust /// extern crate log4rs_gelf; /// /// fn main() { /// log4rs_gelf::init_file("/tmp/log4rs.yml", None).unwrap(); /// /// // Do whatever /// /// log4rs_gelf::flush().expect("Failed to send buffer, log records can be lost !"); /// } /// ``` /// pub fn init_file<P>(path: P, deserializers: Option<log4rs::file::Deserializers>) -> Result<(), log4rs::Error> where P: AsRef<std::path::Path> { log4rs::init_file(path, deserializers.unwrap_or(file::deserializers())) } /// Initializes the global logger as a log4rs logger with the provided config. /// /// A `Handle` object is returned which can be used to adjust the logging /// configuration. /// /// ### Warning /// /// The logging system may only be initialized once. /// /// ## Example /// /// ```rust ///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 !"); /// } /// ``` /// pub fn init_config(config: log4rs::config::Config) -> Result<log4rs::Handle, gelf_logger::Error> { Ok(log4rs::init_config(config)?) } /// Force current logger record buffer to be sent to the remote server. /// /// It can be useful to perform a flush just before program exit. /// /// ## Example /// /// ```rust /// extern crate log4rs_gelf; /// /// fn main() { /// log4rs_gelf::init_file("/tmp/log4rs.yml", None).unwrap(); /// /// // Do whatever /// /// log4rs_gelf::flush().expect("Failed to send buffer, log records can be lost !"); /// } /// ``` /// pub fn flush() -> Result<(), gelf_logger::Error> { gelf_logger::processor().flush() }