spdlog/README.md

101 lines
3.2 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.
2014-12-06 22:20:24 -05:00
* **new**! Feature rich [cppfromat call style](http://cppformat.readthedocs.org/en/stable/syntax.html) using the excellent [cppformat](http://cppformat.github.io/) library:```logger.info("Hello {} !!", "world");```
2014-12-06 22:23:50 -05:00
* ostream call style ```logger.info() << "Hello << "logger";```
* Mixed cppformat/ostream call style ```logger.info("{} + {} = ", 1, 2) << "?";```
2014-11-22 03:27:01 -05:00
* [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).
2014-12-06 22:26:08 -05:00
* Optional, (extremly fast!), async logging.
2014-11-22 03:27:01 -05:00
* 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 19:05:17 -05:00
Below are some [benchmarks](bench) comparing the time needed to log 1,000,000 lines to file under Ubuntu 64 bit, Intel i7-4770 CPU @ 3.40GHz:
2014-11-03 18:52:30 -05:00
2014-11-24 16:40:01 -05:00
|threads|boost log|glog|g2log|spdlog|spdlog <sup>async mode</sup>|
2014-11-24 16:38:58 -05:00
|-------|:-------:|:-----:|------:|------:|------:|
|1|4.779s|1.109s|3.155s|0.947s|1.455s
|10|15.151ss|3.546s|3.500s|1.549s|2.040s|
2014-11-24 16:31:02 -05:00
2014-11-22 19:05:17 -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!") ;
2014-12-06 22:05:01 -05:00
console->info("Creating file {}..", filename);
2014-10-31 21:20:54 -04:00
auto file_logger = spd::rotating_logger_mt("file_logger", filename, 1024 * 1024 * 5, 3);
2014-12-06 22:29:56 -05:00
file_logger->info("Log file message number {}..", 1);
2014-10-31 21:20:54 -04:00
2014-12-06 22:29:56 -05:00
for (int j = 1; j <= 10; ++j)
for (int i = 1; i < 10; ++i)
file_logger->info("{} * {} equals {}, i, j, i*j );
2014-12-06 22:05:01 -05:00
console->info("Easy padding in numbers like {:08d}", 12);
console->info("int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}", 42);
console->info("Positional args are {1} {0}..", "too", "supported):
console->info("{:<30}", "left aligned");
console->info("{:>30}", "right aligned");
console->info("{:^30}", "centered");
//see cppformat's full docs here:
//http://cppformat.readthedocs.org/en/stable/syntax.html
2014-10-31 21:20:54 -04:00
// 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;
}
```