spdlog/README.md

92 lines
2.5 KiB
Markdown
Raw Normal View History

2014-10-31 21:20:54 -04:00
# spdlog
2014-10-31 21:40:52 -04:00
Very fast, header only, C++ logging library.
2014-10-31 21:20:54 -04:00
## Install
Just copy the files to your build tree and use a C++11 compiler
## Tested on:
* gcc 4.8.1 and above
* clang 3.5
* visual studio 2013
##Features
2014-11-03 18:47:50 -05:00
* Very fast - performance is the primary goal (see becnhmarks below)
2014-11-03 02:00:28 -05:00
* Headers only
* No dependencies
* Cross platform - Linux / Windows on 32/64 bits
* Mult/Single threaded loggers
2014-10-31 21:20:54 -04:00
* Rotating log files
* Daily log files
2014-11-03 02:00:28 -05:00
* Console logging
2014-11-03 02:03:56 -05:00
* Optional async logging
2014-11-03 02:00:28 -05:00
* Logging levels
* Custom formatting with user defined patterns
2014-10-31 21:20:54 -04:00
2014-11-03 18:43:20 -05:00
## Benchmarks comparison
Here are some [benchmarks](bench-comparison) comparing spdlog vs boost log(1.56.0) on Ubuntu 64 bits, Intel i7-4770 CPU @ 3.40GHz.
The bench writes 1000,000 log lines to a rotating log file of size 10MB with 5 back rotated files.
The multi threaded test uses a shared logger object across 10 threads.
2014-11-03 18:51:32 -05:00
#### spdlog vs. boost - single thread
2014-11-03 18:43:20 -05:00
|library|log lines|threads|elapsed|
|-------|:-------:|:-----:|------:|
|*boost*|1000,000|1|**4.207s**|
|*spdlog*|1000,000|1|**0.975s**|
2014-11-03 18:49:14 -05:00
2014-11-03 18:49:51 -05:00
2014-11-03 18:51:32 -05:00
#### spdlog vs. boost - 10 threads
2014-11-03 18:43:20 -05:00
|library|log lines|threads|elapsed|
|-------|:-------:|:-----:|------:|
|*boost*|1000,000|10|**6.592s**|
2014-11-03 18:46:58 -05:00
|*spdlog*|1000,000|10|**0.961s**|
2014-11-03 18:43:20 -05:00
2014-10-31 21:20:54 -04:00
## Usage Example
2014-11-03 07:40:12 -05:00
```c++
2014-10-31 21:20:54 -04:00
#include <iostream>
#include "spdlog/spdlog.h"
int main(int, char* [])
{
namespace spd = spdlog;
try
{
std::string filename = "spdlog_example";
2014-11-03 02:00:28 -05:00
auto console = spd::stdout_logger_mt("console");
2014-10-31 21:20:54 -04:00
console->info("Welcome to spdlog!") ;
console->info() << "Creating file " << filename << "..";
auto file_logger = spd::rotating_logger_mt("file_logger", filename, 1024 * 1024 * 5, 3);
file_logger->info("Log file message number", 1);
for (int i = 0; i < 100; ++i)
{
auto square = i*i;
file_logger->info() << i << '*' << i << '=' << square << " (" << "0x" << std::hex << square << ")";
}
// Change log level to all loggers to warning and above
spd::set_level(spd::level::WARN);
console->info("This should not be displayed");
console->warn("This should!");
spd::set_level(spd::level::INFO);
// Change format pattern to all loggers
spd::set_pattern(" **** %Y-%m-%d %H:%M:%S.%e %l **** %v");
spd::get("console")->info("This is another message with different format");
}
catch (const spd::spdlog_ex& ex)
{
std::cout << "Log failed: " << ex.what() << std::endl;
}
return 0;
}
```