spdlog/README.md

349 lines
12 KiB
Markdown
Raw Normal View History

2016-04-02 19:14:54 -04:00
# spdlog
2019-05-28 18:03:34 -04:00
Very fast, header-only/statically-compiled, 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
2018-09-04 12:34:59 -04:00
2019-05-28 17:51:04 -04:00
## Install
2019-05-28 17:57:00 -04:00
#### Header only version
2018-08-01 15:01:35 -04:00
* Copy the source [folder](https://github.com/gabime/spdlog/tree/v1.x/include/spdlog) to your build tree and use a C++11 compiler.
2017-02-15 19:12:50 -05:00
2019-06-10 12:18:47 -04:00
#### Static lib version (recommended - much faster compile times, v1.4.0)
2019-06-03 05:19:57 -04:00
* Copy [src/spdlog.cpp](https://github.com/gabime/spdlog/blob/v1.x/src/spdlog.cpp) to your build tree and pass the `-DSPDLOG_COMPILED_LIB` to the compiler.
2019-06-04 16:42:13 -04:00
* Or use CMake to build and use. See [example](https://github.com/gabime/spdlog/blob/v1.x/example/CMakeLists.txt).
2019-05-28 17:57:56 -04:00
2016-04-02 19:14:54 -04:00
## Platforms
2018-09-06 19:07:25 -04:00
* Linux, FreeBSD, OpenBSD, Solaris, AIX
2018-09-06 19:12:28 -04:00
* Windows (msvc 2013+, cygwin)
2018-09-06 19:09:13 -04:00
* macOS (clang 3.5+)
2016-09-15 19:58:02 -04:00
* Android
2016-04-02 19:14:54 -04:00
2019-05-28 17:51:04 -04:00
## Package managers:
* Homebrew: `brew install spdlog`
* FreeBSD: `cd /usr/ports/devel/spdlog/ && make install clean`
* Fedora: `yum install spdlog`
* Gentoo: `emerge dev-libs/spdlog`
* Arch Linux: `yaourt -S spdlog-git`
* vcpkg: `vcpkg install spdlog`
2017-03-22 04:22:56 -04:00
## Features
2018-09-26 20:59:43 -04:00
* Very fast (see [benchmarks](#benchmarks) below).
2019-06-03 05:23:33 -04:00
* Headers only, just copy and use. Or use as a compiled library.
2018-10-06 08:38:26 -04:00
* Feature rich formatting, using the excellent [fmt](https://github.com/fmtlib/fmt) library.
2018-07-08 09:49:57 -04:00
* Fast asynchronous mode (optional)
2016-04-02 19:14:54 -04:00
* [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.
2018-09-24 18:51:03 -04:00
* Binary data logging.
2016-04-02 19:14:54 -04:00
2019-05-28 17:51:04 -04:00
2018-07-23 15:53:23 -04:00
## Usage samples
2018-07-17 08:13:31 -04:00
2019-01-09 08:56:05 -05:00
#### Basic usage
```c++
#include "spdlog/spdlog.h"
#include "spdlog/sinks/basic_file_sink.h"
2019-01-09 08:56:05 -05:00
int main()
{
spdlog::info("Welcome to spdlog!");
spdlog::error("Some error message with arg: {}", 1);
spdlog::warn("Easy padding in numbers like {:08d}", 12);
spdlog::critical("Support for int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}", 42);
spdlog::info("Support for floats {:03.2f}", 1.23456);
spdlog::info("Positional args are {1} {0}..", "too", "supported");
spdlog::info("{:<30}", "left aligned");
2019-01-14 04:39:35 -05:00
spdlog::set_level(spdlog::level::debug); // Set global log level to debug
2019-01-09 08:56:05 -05:00
spdlog::debug("This message should be displayed..");
// change log pattern
spdlog::set_pattern("[%H:%M:%S %z] [%n] [%^---%L---%$] [thread %t] %v");
// Compile time log levels
// define SPDLOG_ACTIVE_LEVEL to desired level
SPDLOG_TRACE("Some trace message with param {}", {});
SPDLOG_DEBUG("Some debug message");
2019-01-27 12:10:34 -05:00
// Set the default logger to file logger
auto file_logger = spdlog::basic_logger_mt("basic_logger", "logs/basic.txt");
spdlog::set_default_logger(file_logger);
2019-01-09 08:56:05 -05:00
}
```
#### create stdout/stderr logger object
2016-04-02 19:14:54 -04:00
```c++
2018-07-08 09:39:25 -04:00
#include "spdlog/spdlog.h"
2018-04-28 18:55:09 -04:00
#include "spdlog/sinks/stdout_color_sinks.h"
2018-07-08 09:39:25 -04:00
void stdout_example()
2016-12-30 05:16:09 -05:00
{
2018-07-08 09:39:25 -04:00
// create color multi threaded logger
2019-01-09 08:56:05 -05:00
auto console = spdlog::stdout_color_mt("console");
auto err_logger = spdlog::stderr_color_mt("stderr");
2018-07-08 09:39:25 -04:00
spdlog::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name)");
}
2018-07-17 08:09:36 -04:00
```
2018-07-17 08:16:14 -04:00
---
2018-07-26 14:52:52 -04:00
#### Basic file logger
2018-07-17 08:09:36 -04:00
```c++
2018-07-08 09:39:25 -04:00
#include "spdlog/sinks/basic_file_sink.h"
void basic_logfile_example()
{
try
2016-12-30 05:16:09 -05:00
{
2018-07-08 09:39:25 -04:00
auto my_logger = spdlog::basic_logger_mt("basic_logger", "logs/basic-log.txt");
2016-12-30 05:16:09 -05:00
}
2018-07-08 09:39:25 -04:00
catch (const spdlog::spdlog_ex &ex)
2016-12-30 05:16:09 -05:00
{
std::cout << "Log init failed: " << ex.what() << std::endl;
}
2016-08-04 20:56:40 -04:00
}
2018-07-17 08:09:36 -04:00
```
2018-07-17 08:26:12 -04:00
---
2018-07-17 08:13:31 -04:00
#### Rotating files
2018-07-17 08:09:36 -04:00
```c++
2018-07-08 09:39:25 -04:00
#include "spdlog/sinks/rotating_file_sink.h"
void rotating_example()
{
// Create a file rotating logger with 5mb size max and 3 rotated files
auto rotating_logger = spdlog::rotating_logger_mt("some_logger_name", "logs/rotating.txt", 1048576 * 5, 3);
}
2018-07-17 08:09:36 -04:00
```
2018-07-17 08:17:31 -04:00
---
2018-07-17 08:13:31 -04:00
#### Daily files
2018-07-17 08:09:36 -04:00
```c++
2018-07-08 09:39:25 -04:00
#include "spdlog/sinks/daily_file_sink.h"
void daily_example()
{
// Create a daily logger - a new file is created every day on 2:30am
auto daily_logger = spdlog::daily_logger_mt("daily_logger", "logs/daily.txt", 2, 30);
}
2018-07-17 08:09:36 -04:00
```
---
2018-08-25 11:10:42 -04:00
#### Cloning loggers
```c++
2018-08-25 10:55:31 -04:00
// clone a logger and give it new name.
// Useful for creating subsystem loggers from some "root" logger
void clone_example()
{
2018-08-30 21:14:23 -04:00
auto network_logger = spdlog::get("root")->clone("network");
2018-08-25 10:55:31 -04:00
network_logger->info("Logging network stuff..");
}
```
---
2018-08-25 10:57:41 -04:00
#### Periodic flush
2018-08-25 10:55:31 -04:00
```c++
// periodically flush all *registered* loggers every 3 seconds:
// warning: only use if all your loggers are thread safe!
spdlog::flush_every(std::chrono::seconds(3));
```
2018-09-24 18:24:17 -04:00
---
#### Binary logging
```c++
// log binary data as hex.
// many types of std::container<char> types can be used.
// ranges are supported too.
// format flags:
// {:X} - print in uppercase.
// {:s} - don't separate each byte with space.
// {:p} - don't print the position on each line start.
// {:n} - don't split the output to lines.
#include "spdlog/fmt/bin_to_hex.h"
void binary_example()
{
auto console = spdlog::get("console");
std::array<char, 80> buf;
console->info("Binary example: {}", spdlog::to_hex(buf));
console->info("Another binary example:{:n}", spdlog::to_hex(std::begin(buf), std::begin(buf) + 10));
// more examples:
// logger->info("uppercase: {:X}", spdlog::to_hex(buf));
// logger->info("uppercase, no delimiters: {:Xs}", spdlog::to_hex(buf));
// logger->info("uppercase, no delimiters, no position info: {:Xsp}", spdlog::to_hex(buf));
}
```
2016-08-04 20:56:40 -04:00
2018-07-17 08:17:31 -04:00
---
2018-08-13 05:33:58 -04:00
#### Logger with multi sinks - each with different format and log level
2018-07-17 08:09:36 -04:00
```c++
2018-07-08 10:03:13 -04:00
// create logger with 2 targets with different log levels and formats.
// the console will show only warnings or errors, while the file will log all.
2018-07-08 09:39:25 -04:00
void multi_sink_example()
2018-04-28 18:55:09 -04:00
{
2018-07-08 09:39:25 -04:00
auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
console_sink->set_level(spdlog::level::warn);
console_sink->set_pattern("[multi_sink_example] [%^%l%$] %v");
2016-08-04 20:56:40 -04:00
2018-07-08 09:39:25 -04:00
auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("logs/multisink.txt", true);
file_sink->set_level(spdlog::level::trace);
2018-04-28 18:55:09 -04:00
2018-07-08 09:39:25 -04:00
spdlog::logger logger("multi_sink", {console_sink, file_sink});
logger.set_level(spdlog::level::debug);
logger.warn("this should appear in both console and file");
logger.info("this message should not appear in the console, only in the file");
}
2018-07-17 08:09:36 -04:00
```
2018-08-13 05:33:58 -04:00
---
2018-08-13 05:37:15 -04:00
#### Asynchronous logging
```c++
#include "spdlog/async.h"
#include "spdlog/sinks/basic_file_sink.h"
void async_example()
{
// default thread pool settings can be modified *before* creating the async logger:
// spdlog::init_thread_pool(8192, 1); // queue with 8k items and 1 backing thread.
auto async_file = spdlog::basic_logger_mt<spdlog::async_factory>("async_file_logger", "logs/async_log.txt");
// alternatively:
// auto async_file = spdlog::create_async<spdlog::sinks::basic_file_sink_mt>("async_file_logger", "logs/async_log.txt");
}
```
---
#### Asynchronous logger with multi sinks
2018-08-13 05:33:58 -04:00
```c++
2018-08-13 05:37:15 -04:00
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/rotating_file_sink.h"
2018-08-13 05:33:58 -04:00
void multi_sink_example2()
{
spdlog::init_thread_pool(8192, 1);
auto stdout_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt >();
auto rotating_sink = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("mylog.txt", 1024*1024*10, 3);
std::vector<spdlog::sink_ptr> sinks {stdout_sink, rotating_sink};
auto logger = std::make_shared<spdlog::async_logger>("loggername", sinks.begin(), sinks.end(), spdlog::thread_pool(), spdlog::async_overflow_policy::block);
spdlog::register_logger(logger);
}
```
2018-07-17 08:17:31 -04:00
---
2018-07-17 08:13:31 -04:00
#### User defined types
2018-07-17 08:09:36 -04:00
```c++
2016-08-04 20:56:40 -04:00
// user defined types logging by implementing operator<<
2018-07-08 09:39:25 -04:00
#include "spdlog/fmt/ostr.h" // must be included
2016-08-04 20:56:40 -04:00
struct my_type
{
int i;
template<typename OStream>
2018-04-28 18:55:09 -04:00
friend OStream &operator<<(OStream &os, const my_type &c)
2016-08-04 20:56:40 -04:00
{
2018-04-28 18:55:09 -04:00
return os << "[my_type i=" << c.i << "]";
2016-04-02 19:14:54 -04:00
}
2016-08-04 20:56:40 -04:00
};
void user_defined_example()
{
2018-07-08 09:39:25 -04:00
spdlog::get("console")->info("user defined type: {}", my_type{14});
2016-04-02 19:14:54 -04:00
}
2018-07-17 08:09:36 -04:00
```
2018-07-17 08:17:31 -04:00
---
2018-07-17 08:09:36 -04:00
#### Custom error handler
```c++
2016-08-04 20:56:40 -04:00
void err_handler_example()
2018-04-28 18:55:09 -04:00
{
2018-07-08 09:39:25 -04:00
// can be set globally or per logger(logger->set_error_handler(..))
spdlog::set_error_handler([](const std::string &msg) { spdlog::get("console")->error("*** LOGGER ERROR ***: {}", msg); });
spdlog::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3);
}
2018-07-17 08:09:36 -04:00
```
2018-07-17 08:17:31 -04:00
---
2018-07-17 08:13:31 -04:00
#### syslog
2018-07-17 08:09:36 -04:00
```c++
2018-07-08 09:39:25 -04:00
#include "spdlog/sinks/syslog_sink.h"
void syslog_example()
{
std::string ident = "spdlog-example";
2018-08-06 15:19:16 -04:00
auto syslog_logger = spdlog::syslog_logger_mt("syslog", ident, LOG_PID);
2018-07-08 09:39:25 -04:00
syslog_logger->warn("This is warning that will end up in syslog.");
2016-08-04 20:56:40 -04:00
}
2018-07-17 08:09:36 -04:00
```
2018-07-17 08:17:31 -04:00
---
2018-07-17 08:09:36 -04:00
#### Android example
```c++
2018-11-04 19:04:22 -05:00
#include "spdlog/sinks/android_sink.h"
2018-07-08 09:39:25 -04:00
void android_example()
{
std::string tag = "spdlog-android";
2019-02-13 03:19:29 -05:00
auto android_logger = spdlog::android_logger_mt("android", tag);
2018-07-08 09:39:25 -04:00
android_logger->critical("Use \"adb shell logcat\" to view this message.");
}
2016-04-02 19:14:54 -04:00
```
2019-06-06 11:50:03 -04:00
## Benchmarks
Below are some [benchmarks](https://github.com/gabime/spdlog/blob/v1.x/bench/bench.cpp) done in Ubuntu 64 bit, Intel i7-4770 CPU @ 3.40GHz
#### Synchronous mode
```
[info] **************************************************************
[info] Single thread, 1,000,000 iterations
[info] **************************************************************
[info] basic_st Elapsed: 0.17 secs 5,777,626/sec
[info] rotating_st Elapsed: 0.18 secs 5,475,894/sec
[info] daily_st Elapsed: 0.20 secs 5,062,659/sec
[info] empty_logger Elapsed: 0.07 secs 14,127,300/sec
[info] **************************************************************
[info] C-string (400 bytes). Single thread, 1,000,000 iterations
[info] **************************************************************
[info] basic_st Elapsed: 0.41 secs 2,412,483/sec
[info] rotating_st Elapsed: 0.72 secs 1,389,196/sec
[info] daily_st Elapsed: 0.42 secs 2,393,298/sec
[info] null_st Elapsed: 0.04 secs 27,446,957/sec
[info] **************************************************************
[info] 10 threads sharing same logger, 1,000,000 iterations
[info] **************************************************************
[info] basic_mt Elapsed: 0.60 secs 1,659,613/sec
[info] rotating_mt Elapsed: 0.62 secs 1,612,493/sec
[info] daily_mt Elapsed: 0.61 secs 1,638,305/sec
[info] null_mt Elapsed: 0.16 secs 6,272,758/sec
```
#### ASynchronous mode
2019-06-06 12:25:07 -04:00
```
2019-06-06 12:23:55 -04:00
[info] -------------------------------------------------
[info] Messages : 1,000,000
[info] Threads : 10
[info] Queue : 8,192 slots
[info] Queue memory : 8,192 x 272 = 2,176 KB
[info] Total iters : 3
[info] -------------------------------------------------
[info]
[info] *********************************
[info] Queue Overflow Policy: block
[info] *********************************
[info] Elapsed: 1.70784 secs 585,535/sec
[info] Elapsed: 1.69805 secs 588,910/sec
[info] Elapsed: 1.7026 secs 587,337/sec
[info]
[info] *********************************
[info] Queue Overflow Policy: overrun
[info] *********************************
[info] Elapsed: 0.372816 secs 2,682,285/sec
[info] Elapsed: 0.379758 secs 2,633,255/sec
[info] Elapsed: 0.373532 secs 2,677,147/sec
2019-06-06 11:50:03 -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.