Crate flexi_logger [−] [src]
A logger that can write the log to standard error or to a fresh file in a configurable folder and allows custom logline formats. It had started as an extended copy of env_logger.
Usage
This crate is on crates.io and
can be used by adding flexi_logger to the dependencies in your
project's Cargo.toml.
[dependencies]
flexi_logger = "^0.5.1"
log = "*"
and this to your crate root:
extern crate flexi_logger;
#[macro_use]
extern crate log;
The latter is needed because flexi_logger plugs into the standard Rust logging facade given by the
log crate,
and you use the log macros to write log lines from your code.
Early in the start-up of your program, call something like
flexi_logger::LogOptions::new()
.log_to_file(true)
// ... your configuration options go here ...
.init(Some("info".to_string()))
.unwrap_or_else(|e| panic!("Logger initialization failed with {}", e));
The configuration options allow e.g. to
- decide whether you want to write your logs to stderr (like with env_logger), or to a file,
- configure the folder in which the log files are created,
- specify the line format for the log lines
See LogOptions for a full description of all configuration options.
Structs
| FlexiLogger |
Does the logging in the background, is normally not used directly. |
| LogConfig |
Internal struct for influencing the behavior of flexi_logger. |
| LogOptions |
Allows initializing flexi_logger to your needs. |
| LogRecord |
The "payload" of a log message. |
Enums
| FlexiLoggerError |
Describes errors in the initialization of flexi_logger. |
| LogLevel |
An enum representing the available verbosity levels of the logging framework |
| LogLevelFilter |
An enum representing the available verbosity level filters of the logging framework. |
Functions
| default_format |
A logline-formatter that produces log lines like |
| detailed_format |
A logline-formatter that produces log lines like
|
| init |
Initializes the flexi_logger to your needs, and the global logger with flexi_logger. |
| opt_format |
A logline-formatter that produces log lines like
|
| with_thread |
A logline-formatter that produces log lines like
|