spdlog/README.md

103 lines
2.8 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
2014-11-05 15:54:13 -05:00
* mingw with g++ 4.9.x
2014-10-31 21:20:54 -04:00
##Features
2014-11-22 03:27:01 -05:00
* Very fast - performance is the primary goal (see becnhmarks below).
* Headers only.
* No dependencies.
* Cross platform - Linux / Windows on 32/64 bits.
* Variadic-template/stream call styles: ```logger.info("variadic", x, y) << "or stream" << x << y;```
* [Custom](https://github.com/gabime/spdlog/wiki/Custom-formatting) formatting.
* Multi/Single threaded loggers.
* Various log targets:
* Rotating log files.
* Daily log files.
* Console logging.
* Linux syslog.
* Easily extendable with custom log targets (just implement a single function in the [sink](include/spdlog/sinks/sink.h) interface).
* Optional async logging .
* Log levels.
2014-10-31 21:20:54 -04:00
2014-11-03 19:47:26 -05:00
## Benchmarks
2014-11-03 18:43:20 -05:00
2014-11-22 17:45:58 -05:00
Here are some [benchmarks](bench) comparing spdlog vs other libs <sup>(Ubuntu 64, Intel i7-4770 CPU @ 3.40GHz)</sup>.
2014-11-03 18:43:20 -05:00
2014-11-03 19:47:26 -05:00
The bench writes 1,000,000 log lines to a rotating log file (using shared synchronous logger object):
2014-11-03 18:52:30 -05:00
2014-11-22 17:38:08 -05:00
#### Single thread bench
2014-11-03 18:43:20 -05:00
|library|log lines|threads|elapsed|
|-------|:-------:|:-----:|------:|
2014-11-22 17:35:53 -05:00
|*boost log v1.56*|1,000,000|1|**4.207s**|
2014-11-22 17:36:17 -05:00
|*glog v0.3.3*|1,000,000|1|**1.077s**|
2014-11-03 18:59:36 -05:00
|*spdlog*|1,000,000|1|**0.975s**|
2014-11-03 18:43:20 -05:00
2014-11-03 18:49:14 -05:00
2014-11-03 18:49:51 -05:00
2014-11-22 17:38:08 -05:00
#### 10 threads bench
2014-11-03 18:43:20 -05:00
|library|log lines|threads|elapsed|
|-------|:-------:|:-----:|------:|
2014-11-22 17:35:53 -05:00
|*boost log v1.56*|1,000,000|10|**6.592s**|
2014-11-22 17:37:00 -05:00
|*glog v0.3.3*|1,000,000|10|**1.678s**|
2014-11-03 18:59:57 -05:00
|*spdlog*|1,000,000|10|**0.961s**|
2014-11-03 18:57:02 -05:00
2014-11-03 18:54:51 -05:00
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;
}
```