spdlog/README.md

219 lines
7.5 KiB
Markdown
Raw Normal View History

2016-04-02 19:14:54 -04:00
# spdlog
Very fast, header only, C++ logging library. [![Build Status](https://travis-ci.org/gabime/spdlog.svg?branch=master)](https://travis-ci.org/gabime/spdlog)  [![Build status](https://ci.appveyor.com/api/projects/status/d2jnxclg20vd0o50?svg=true)](https://ci.appveyor.com/project/gabime/spdlog)
2016-04-02 19:14:54 -04:00
## Install
2017-02-21 05:13:04 -05:00
#### Just copy the headers:
2017-02-03 07:44:03 -05:00
2017-02-15 19:12:50 -05:00
* Copy the source [folder](https://github.com/gabime/spdlog/tree/master/include/spdlog) to your build tree and use a C++11 compiler.
#### Or use your favourite package manager:
2017-02-15 19:10:18 -05:00
2017-02-03 07:44:03 -05:00
* Ubuntu: `apt-get install libspdlog-dev`
* Homebrew: `brew install spdlog`
2017-02-03 08:19:23 -05:00
* FreeBSD: `cd /usr/ports/devel/spdlog/ && make install clean`
2017-02-03 07:44:03 -05:00
* Fedora: `yum install spdlog`
* Arch Linux: `pacman -S spdlog-git`
* vcpkg: `vcpkg install spdlog`
2016-04-02 19:14:54 -04:00
## Platforms
2016-12-30 05:16:09 -05:00
* Linux, FreeBSD, Solaris
2016-12-30 05:16:44 -05:00
* Windows (vc 2013+, cygwin/mingw)
2016-07-11 15:48:31 -04:00
* Mac OSX (clang 3.5+)
2016-09-15 19:58:02 -04:00
* Android
2016-04-02 19:14:54 -04:00
##Features
* Very fast - performance is the primary goal (see [benchmarks](#benchmarks) below).
2016-08-23 20:00:55 -04:00
* Headers only, just copy and use.
2016-05-22 05:13:36 -04:00
* Feature rich [call style](#usage-example) using the excellent [fmt](https://github.com/fmtlib/fmt) library.
2016-04-02 19:14:54 -04:00
* Extremely fast asynchronous mode (optional) - using lockfree queues and other tricks to reach millions of calls/sec.
* [Custom](https://github.com/gabime/spdlog/wiki/3.-Custom-formatting) formatting.
* Multi/Single threaded loggers.
* Various log targets:
* Rotating log files.
* Daily log files.
2016-04-02 19:18:33 -04:00
* Console logging (colors supported).
2016-08-23 20:02:01 -04:00
* syslog.
2017-01-06 05:39:12 -05:00
* Windows debugger (```OutputDebugString(..)```)
2016-04-02 19:14:54 -04:00
* Easily extendable with custom log targets (just implement a single function in the [sink](include/spdlog/sinks/sink.h) interface).
* Severity based filtering - threshold levels can be modified in runtime as well as in compile time.
## Benchmarks
Below are some [benchmarks](bench) comparing popular log libraries under Ubuntu 64 bit, Intel i7-4770 CPU @ 3.40GHz
#### Synchronous mode
Time needed to log 1,000,000 lines in synchronous mode (in seconds, the best of 3 runs):
|threads|boost log 1.54|glog |easylogging |spdlog|
|-------|:-------:|:-----:|----------:|------:|
|1| 4.169s |1.066s |0.975s |0.302s|
|10| 6.180s |3.032s |2.857s |0.968s|
|100| 5.981s |1.139s |4.512s |0.497s|
#### Asynchronous mode
Time needed to log 1,000,000 lines in asynchronous mode, i.e. the time it takes to put them in the async queue (in seconds, the best of 3 runs):
|threads|g2log <sup>async logger</sup> |spdlog <sup>async mode</sup>|
|:-------|:-----:|-------------------------:|
|1| 1.850s |0.216s |
|10| 0.943s |0.173s|
|100| 0.959s |0.202s|
## Usage Example
```c++
2016-08-26 07:16:36 -04:00
2016-04-02 19:14:54 -04:00
#include "spdlog/spdlog.h"
2016-08-04 20:56:40 -04:00
#include <iostream>
#include <memory>
void async_example();
void syslog_example();
void user_defined_example();
void err_handler_example();
namespace spd = spdlog;
2016-12-30 05:16:09 -05:00
int main(int, char*[])
{
try
{
// Console logger with color
auto console = spd::stdout_color_mt("console");
console->info("Welcome to spdlog!");
console->error("Some error message with arg{}..", 1);
// Formatting examples
console->warn("Easy padding in numbers like {:08d}", 12);
console->critical("Support for int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}", 42);
console->info("Support for floats {:03.2f}", 1.23456);
console->info("Positional args are {1} {0}..", "too", "supported");
console->info("{:<30}", "left aligned");
spd::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name) function");
// Create basic file logger (not rotated)
auto my_logger = spd::basic_logger_mt("basic_logger", "logs/basic.txt");
my_logger->info("Some log message");
// Create a file rotating logger with 5mb size max and 3 rotated files
auto rotating_logger = spd::rotating_logger_mt("some_logger_name", "logs/mylogfile", 1048576 * 5, 3);
for (int i = 0; i < 10; ++i)
rotating_logger->info("{} * {} equals {:>10}", i, i, i*i);
// Create a daily logger - a new file is created every day on 2:30am
auto daily_logger = spd::daily_logger_mt("daily_logger", "logs/daily", 2, 30);
// trigger flush if the log severity is error or higher
daily_logger->flush_on(spd::level::err);
daily_logger->info(123.44);
// Customize msg format for all messages
spd::set_pattern("*** [%H:%M:%S %z] [thread %t] %v ***");
rotating_logger->info("This is another message with custom format");
// Runtime log levels
spd::set_level(spd::level::info); //Set global log level to info
console->debug("This message shold not be displayed!");
console->set_level(spd::level::debug); // Set specific logger's log level
console->debug("This message shold be displayed..");
// Compile time log levels
// define SPDLOG_DEBUG_ON or SPDLOG_TRACE_ON
SPDLOG_TRACE(console, "Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}", 1, 3.23);
SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23);
// Asynchronous logging is very fast..
// Just call spdlog::set_async_mode(q_size) and all created loggers from now on will be asynchronous..
async_example();
// syslog example. linux/osx only
syslog_example();
// android example. compile with NDK
android_example();
// Log user-defined types example
user_defined_example();
// Change default log error handler
err_handler_example();
// Apply a function on all registered loggers
spd::apply_all([&](std::shared_ptr<spdlog::logger> l)
{
l->info("End of example.");
});
// Release and close all loggers
spdlog::drop_all();
}
// Exceptions will only be thrown upon failed logger or sink construction (not during logging)
catch (const spd::spdlog_ex& ex)
{
std::cout << "Log init failed: " << ex.what() << std::endl;
return 1;
}
2016-08-04 20:56:40 -04:00
}
void async_example()
{
size_t q_size = 4096; //queue size must be power of 2
spdlog::set_async_mode(q_size);
auto async_file = spd::daily_logger_st("async_file_logger", "logs/async_log.txt");
for (int i = 0; i < 100; ++i)
2016-08-20 07:01:40 -04:00
async_file->info("Async message #{}", i);
2016-08-04 20:56:40 -04:00
}
2016-08-23 20:03:58 -04:00
//syslog example
2016-08-04 20:56:40 -04:00
void syslog_example()
{
2016-08-23 20:03:58 -04:00
#ifdef SPDLOG_ENABLE_SYSLOG
2016-08-04 20:56:40 -04:00
std::string ident = "spdlog-example";
auto syslog_logger = spd::syslog_logger("syslog", ident, LOG_PID);
2016-08-23 20:04:55 -04:00
syslog_logger->warn("This is warning that will end up in syslog..");
2016-08-04 20:56:40 -04:00
#endif
}
// user defined types logging by implementing operator<<
struct my_type
{
int i;
template<typename OStream>
friend OStream& operator<<(OStream& os, const my_type &c)
{
return os << "[my_type i="<<c.i << "]";
2016-04-02 19:14:54 -04:00
}
2016-08-04 20:56:40 -04:00
};
#include <spdlog/fmt/ostr.h> // must be included
void user_defined_example()
{
spd::get("console")->info("user defined type: {}", my_type { 14 });
2016-04-02 19:14:54 -04:00
}
2016-08-04 20:56:40 -04:00
//
//custom error handler
//
void err_handler_example()
{
spdlog::set_error_handler([](const std::string& msg) {
std::cerr << "my err handler: " << msg << std::endl;
2016-08-04 21:23:34 -04:00
});
// (or logger->set_error_handler(..) to set for specific logger)
2016-08-04 20:56:40 -04:00
}
2016-04-02 19:14:54 -04:00
```
## Documentation
Documentation can be found in the [wiki](https://github.com/gabime/spdlog/wiki/1.-QuickStart) pages.