spdlog/README.md

114 lines
4.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-12-06 23:27:40 -05:00
* Very fast - performance is the primary goal (see [becnhmarks](#benchmarks) below).
2014-11-22 03:27:01 -05:00
* Headers only.
* No dependencies.
* Cross platform - Linux / Windows on 32/64 bits.
2014-12-06 23:51:04 -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.
* Example: ```logger.info("Hello {} {:08x}!!", "world", 42);```
2014-12-06 23:47:43 -05:00
* ostream call style: ```logger.info() << "Hello << "logger";```
2014-12-06 23:46:18 -05:00
* **new!** Optional, extremly fast asynchronous mode using lockfree queues, pre allocated memory and deffered formatting.
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-07 00:10:52 -05:00
* Severity based filtering - can be modified in runtime.
2014-11-22 03:27:01 -05:00
2014-11-03 19:47:26 -05:00
## Benchmarks
2014-11-03 18:43:20 -05:00
2014-12-06 23:05:44 -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 (the best of 3 runs for each logger):
2014-11-03 18:52:30 -05:00
2014-12-06 23:40:59 -05:00
|threads|boost log|glog|g2log <sup>async mode</sup>|spdlog|spdlog <sup>async mode</sup>|
2014-11-24 16:38:58 -05:00
|-------|:-------:|:-----:|------:|------:|------:|
2014-12-06 23:05:44 -05:00
|1|4.779s|1.109s|3.155s|0.319s|0.212s
|10|15.151ss|3.546s|3.500s|0.641s|0.199s|
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
{
2014-12-06 23:01:10 -05:00
std::string filename = "logs/spdlog_example";
// Set log level to all loggers to DEBUG and above
spd::set_level(spd::level::DEBUG);
//Create console, multithreaded logger
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 23:01:10 -05:00
console->info("An info message example {}..", 1);
console->info() << "Streams are supported too " << 1;
2014-10-31 21:20:54 -04:00
2014-12-06 22:05:01 -05:00
console->info("Easy padding in numbers like {:08d}", 12);
2014-12-06 22:33:33 -05:00
console->info("Support for int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}", 42);
2014-12-06 23:01:10 -05:00
console->info("Support for floats {:03.2f}", 1.23456);
console->info("Positional args are {1} {0}..", "too", "supported");
2014-12-06 22:05:01 -05:00
console->info("{:<30}", "left aligned");
console->info("{:>30}", "right aligned");
console->info("{:^30}", "centered");
2014-12-06 23:26:33 -05:00
//See cppformat syntax documation here:
2014-12-06 23:25:45 -05:00
//http://cppformat.readthedocs.org/en/stable/syntax.html
2014-12-06 23:01:10 -05:00
//Create a file rotating logger with 5mb size max and 3 rotated files
auto file_logger = spd::rotating_logger_mt("file_logger", filename, 1024 * 1024 * 5, 3);
file_logger->info("Log file message number", 1);
2014-12-07 00:16:45 -05:00
for(int i = 0; i < 10; ++i)
file_logger->info("{} * {} equals {:>10}", i, i, i*i);
2014-12-06 23:01:10 -05:00
spd::set_pattern("*** [%H:%M:%S %z] [thread %t] %v ***");
file_logger->info("This is another message with custom format");
spd::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name) function");
SPDLOG_TRACE(file_logger, "This is a trace message (only #ifdef _DEBUG)", 123);
//
// Asynchronous logging is easy..
// Just call spdlog::set_async_mode(max_q_size) and all created loggers from now on will be asynchronous..
//
2014-12-06 23:45:37 -05:00
size_t q_size = 1048576; //queue size must be power of 2
spdlog::set_async_mode(q_size);
2014-12-06 23:01:10 -05:00
auto async_file= spd::daily_logger_st("async_file_logger", "logs/async_log.txt");
async_file->info() << "This is async log.." << "Should be very fast!";
2014-12-07 00:16:45 -05:00
2014-12-06 23:01:10 -05:00
//
// syslog example
//
#ifdef __linux__
auto syslog_logger = spd::syslog_logger("syslog");
syslog_logger->warn("This is warning that will end up in syslog. This is Linux only!");
#endif
2014-10-31 21:20:54 -04:00
}
catch (const spd::spdlog_ex& ex)
{
std::cout << "Log failed: " << ex.what() << std::endl;
}
}
2014-12-06 23:01:10 -05:00
2014-10-31 21:20:54 -04:00
```