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

//! A GELF library for Rust.
//!
//! The library can be used either as a standalone logging library
//! or it can be used as a logging-subsystem with the
//! [`log`-crate](https://doc.rust-lang.org/log/log/index.html)
//!
//! # Use
//!
//! In general you should only use this crate in applications. Libraries should
//! only develop against [`log`](https://doc.rust-lang.org/log/log/index.html).
//! This then allows applications to use a custom logging-framework (like `gelf`)
//! to do the actual logging.
//!
//! ## Standalone
//!
//! Standalone usage is recommended if the lightweight `log`-crate's features
//! are not sufficient. In this case you need to inject/use an instance of
//! `gelf::Logger` directly. This allows for sending custom built `gelf::Message`-objects.
//! These messages can use all bells and whistles of GELF.
//!
//! ### Example
//!
//! ```
//! extern crate gelf;
//!
//! # use gelf::NullBackend;
//! use gelf::{Logger, UdpBackend, Message, Level};
//!
//! pub fn main() {
//!     // Set up logging
//!     let backend = UdpBackend::new("127.0.0.1:12201")
//!         .expect("Failed to create UDP backend");
//!     # let backend = NullBackend::new();
//!     let mut logger = Logger::new(Box::new(backend))
//!         .expect("Failed to determine hostname");
//!     logger.set_default_metadata(String::from("facility"),
//!          String::from("example-rust-app"));
//!
//!     // Create a (complex) message
//!     let mut message = Message::new(String::from("Custom message!"));
//!     message
//!         .set_full_message(String::from("The full message text is more descriptive"))
//!         .set_metadata("foo", String::from("bar")).unwrap()
//!         .set_metadata("baz", String::from("bat")).unwrap();
//!
//!     // Log it
//!     logger.log_message(message);
//! }
//! ```
//!
//! ## With `log`
//!
//! Usage with `log` allows to log easily with the help of its macros. There is no need to
//! inject or access the logger object anywhere in your application.
//!
//! All the context information (line, file, etc.) the `log`-crate provides is added as metadata
//! to the logged GELF message.
//!
//! ```
//! #[macro_use]
//! extern crate log;
//!
//! extern crate gelf;
//!
//! # use gelf::NullBackend;
//! use gelf::{Logger, UdpBackend, Message, Level};
//! use log::LevelFilter;
//!
//! pub fn main() {
//!     let backend = UdpBackend::new("127.0.0.1:12201")
//!         .expect("Failed to create UDP backend");
//!     # let backend = NullBackend::new();
//!
//!     // Init logging system
//!     let logger = Logger::new(Box::new(backend))
//!         .expect("Failed to determine hostname");
//!     logger.install(LevelFilter::Trace)
//!         .expect("Failed to install logger");
//!
//!     info!("Descend into our program!");
//!     somewhere()
//! }
//!
//! pub fn somewhere() {
//!     trace!("Trace something here!");
//!     over::the_rainbow();
//! }
//!
//! mod over {
//!     pub fn the_rainbow() {
//!         error!("Oh well...");
//!     }
//! }
//! ```
#![crate_type = "lib"]

extern crate chrono;
extern crate hostname;
extern crate libc;
extern crate libdeflater;
extern crate rand;

#[macro_use]
extern crate serde;

#[cfg_attr(test, macro_use)]
extern crate serde_json;

#[macro_use]
extern crate log;

#[macro_use]
extern crate failure;
extern crate bytes;

mod backends;
mod errors;
mod level;
mod logger;
mod message;
mod util;

pub use backends::{Backend, NullBackend, TcpBackend, UdpBackend};
pub use errors::{Error, Result};
pub use level::Level;
pub use logger::Logger;
pub use message::{ChunkSize, Message, MessageCompression, WireMessage};