spdlog/README.md

86 lines
2.4 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 02:00:28 -05:00
* Very fast - performance is the primary goal
* 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 02:00:28 -05:00
## Benchmarks
Here are some benchmarks (Ubuntu 64 bits, Intel i7-4770 CPU @ 3.40GHz)
2014-10-31 21:20:54 -04:00
```
*******************************************************************************
Single thread, 250,000 iterations, flush every 1000 lines
*******************************************************************************
rotating_st... 817,860 lines/sec
daily_st... 827,820 lines /sec
*******************************************************************************
4 threads sharing same logger, 250,000 iterations, flush every 1000 lines
*******************************************************************************
rotating_mt... 1,476,013 lines/sec
daily_mt... 1,477,619 lines/sec
2014-11-03 07:39:43 -05:00
```c++
2014-10-31 21:20:54 -04:00
## Usage Example
```
#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;
}
```