spdlog/README.md

282 lines
9.5 KiB
Markdown
Raw Normal View History

2016-04-03 07:14:54 +08: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-03 07:14:54 +08:00
## Install
2017-02-21 18:13:04 +08:00
#### Just copy the headers:
2017-02-03 20:44:03 +08:00
2018-08-02 03:01:35 +08: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-16 08:12:50 +08:00
2017-08-29 17:00:10 +08:00
#### Or use your favorite package manager:
2017-02-16 08:10:18 +08:00
2017-02-03 20:44:03 +08:00
* Ubuntu: `apt-get install libspdlog-dev`
* Homebrew: `brew install spdlog`
2017-02-03 21:19:23 +08:00
* FreeBSD: `cd /usr/ports/devel/spdlog/ && make install clean`
2017-02-03 20:44:03 +08:00
* Fedora: `yum install spdlog`
2017-08-13 00:01:47 +08:00
* Gentoo: `emerge dev-libs/spdlog`
* Arch Linux: `yaourt -S spdlog-git`
2017-02-03 20:44:03 +08:00
* vcpkg: `vcpkg install spdlog`
2016-04-03 07:14:54 +08:00
## Platforms
2018-07-08 21:50:56 +08:00
* Linux, FreeBSD, Solaris, AIX
2017-12-26 19:26:04 +08:00
* Windows (vc 2013+, cygwin)
2016-07-12 03:48:31 +08:00
* Mac OSX (clang 3.5+)
2016-09-16 07:58:02 +08:00
* Android
2016-04-03 07:14:54 +08:00
2017-03-22 16:22:56 +08:00
## Features
2016-04-03 07:14:54 +08:00
* Very fast - performance is the primary goal (see [benchmarks](#benchmarks) below).
2016-08-24 08:00:55 +08:00
* Headers only, just copy and use.
* Feature rich using the excellent [fmt](https://github.com/fmtlib/fmt) library.
2018-07-08 21:49:57 +08:00
* Fast asynchronous mode (optional)
2016-04-03 07:14:54 +08:00
* [Custom](https://github.com/gabime/spdlog/wiki/3.-Custom-formatting) formatting.
2017-06-18 02:26:07 +08:00
* Conditional Logging
2016-04-03 07:14:54 +08:00
* Multi/Single threaded loggers.
* Various log targets:
* Rotating log files.
* Daily log files.
2016-04-03 07:18:33 +08:00
* Console logging (colors supported).
2016-08-24 08:02:01 +08:00
* syslog.
2017-01-06 18:39:12 +08:00
* Windows debugger (```OutputDebugString(..)```)
2016-04-03 07:14:54 +08: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
2018-07-08 21:46:52 +08:00
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
2016-04-03 07:14:54 +08:00
#### Synchronous mode
2018-07-08 21:43:04 +08:00
```
2018-07-08 21:42:21 +08:00
*******************************************************************************
Single thread, 1,000,000 iterations
*******************************************************************************
basic_st... Elapsed: 0.231041 4,328,228/sec
2018-07-08 21:48:58 +08:00
rotating... Elapsed: 0.233466 4,283,282/sec
2018-07-08 21:42:21 +08:00
daily_st... Elapsed: 0.244491 4,090,136/sec
null_st... Elapsed: 0.162708 6,145,995/sec
*******************************************************************************
10 threads sharing same logger, 1,000,000 iterations
*******************************************************************************
basic_mt... Elapsed: 0.854029 1,170,920/sec
rotating_mt Elapsed: 0.867038 1,153,351/sec
daily_mt... Elapsed: 0.869593 1,149,963/sec
2018-07-13 04:48:24 +08:00
null_mt... Elapsed: 0.171215 2,033,537/sec
2018-07-08 21:43:55 +08:00
```
2016-04-03 07:14:54 +08:00
#### Asynchronous mode
2018-07-08 21:43:55 +08:00
```
2018-07-08 21:42:21 +08:00
*******************************************************************************
2018-07-08 21:45:35 +08:00
10 threads sharing same logger, 1,000,000 iterations
2018-07-08 21:42:21 +08:00
*******************************************************************************
async... Elapsed: 0.442731 2,258,706/sec
async... Elapsed: 0.427072 2,341,527/sec
async... Elapsed: 0.449768 2,223,369/sec
2018-07-08 21:43:04 +08:00
```
2016-04-03 07:14:54 +08:00
2018-07-24 03:53:23 +08:00
## Usage samples
2018-07-17 20:13:31 +08:00
2016-04-03 07:14:54 +08:00
```c++
2018-07-08 21:39:25 +08:00
#include "spdlog/spdlog.h"
2018-04-29 06:55:09 +08:00
#include "spdlog/sinks/stdout_color_sinks.h"
2018-07-08 21:39:25 +08:00
void stdout_example()
2016-12-30 18:16:09 +08:00
{
2018-07-08 21:39:25 +08:00
// create color multi threaded logger
auto console = spdlog::stdout_color_mt("console");
console->info("Welcome to spdlog!");
console->error("Some error message with arg: {}", 1);
auto err_logger = spdlog::stderr_color_mt("stderr");
err_logger->error("Some error message");
// 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");
spdlog::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name)");
// Runtime log levels
spdlog::set_level(spdlog::level::info); // Set global log level to info
console->debug("This message should not be displayed!");
console->set_level(spdlog::level::trace); // Set specific logger's log level
console->debug("This message should be displayed..");
// Customize msg format for all loggers
spdlog::set_pattern("[%H:%M:%S %z] [%n] [%^---%L---%$] [thread %t] %v");
console->info("This an info message with custom format");
// 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);
}
2018-07-17 20:09:36 +08:00
```
2018-07-17 20:16:14 +08:00
---
2018-07-27 02:52:52 +08:00
#### Basic file logger
2018-07-17 20:09:36 +08:00
```c++
2018-07-08 21:39:25 +08:00
#include "spdlog/sinks/basic_file_sink.h"
void basic_logfile_example()
{
try
2016-12-30 18:16:09 +08:00
{
2018-07-08 21:39:25 +08:00
auto my_logger = spdlog::basic_logger_mt("basic_logger", "logs/basic-log.txt");
2016-12-30 18:16:09 +08:00
}
2018-07-08 21:39:25 +08:00
catch (const spdlog::spdlog_ex &ex)
2016-12-30 18:16:09 +08:00
{
std::cout << "Log init failed: " << ex.what() << std::endl;
return 1;
}
2016-08-05 08:56:40 +08:00
}
2018-07-17 20:09:36 +08:00
```
2018-07-17 20:26:12 +08:00
---
2018-07-17 20:13:31 +08:00
#### Rotating files
2018-07-17 20:09:36 +08:00
```c++
2018-07-08 21:39:25 +08: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 20:09:36 +08:00
```
2018-07-17 20:17:31 +08:00
---
2018-07-17 20:13:31 +08:00
#### Daily files
2018-07-17 20:09:36 +08:00
```c++
2018-07-08 21:39:25 +08: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 20:09:36 +08:00
```
---
#### Periodic flush
```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));
```
2016-08-05 08:56:40 +08:00
2018-07-17 20:17:31 +08:00
---
2018-08-13 17:33:58 +08:00
#### Logger with multi sinks - each with different format and log level
2018-07-17 20:09:36 +08:00
```c++
2018-07-08 22:03:13 +08: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 21:39:25 +08:00
void multi_sink_example()
2018-04-29 06:55:09 +08:00
{
2018-07-08 21:39:25 +08: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-05 08:56:40 +08:00
2018-07-08 21:39:25 +08: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-29 06:55:09 +08:00
2018-07-08 21:39:25 +08: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 20:09:36 +08:00
```
2018-08-13 17:33:58 +08:00
---
2018-08-13 17:37:15 +08: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 17:33:58 +08:00
```c++
2018-08-13 17:37:15 +08:00
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/rotating_file_sink.h"
2018-08-13 17:33:58 +08: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 20:17:31 +08:00
---
2018-07-17 20:13:31 +08:00
#### User defined types
2018-07-17 20:09:36 +08:00
```c++
2016-08-05 08:56:40 +08:00
// user defined types logging by implementing operator<<
2018-07-08 21:39:25 +08:00
#include "spdlog/fmt/ostr.h" // must be included
2016-08-05 08:56:40 +08:00
struct my_type
{
int i;
template<typename OStream>
2018-04-29 06:55:09 +08:00
friend OStream &operator<<(OStream &os, const my_type &c)
2016-08-05 08:56:40 +08:00
{
2018-04-29 06:55:09 +08:00
return os << "[my_type i=" << c.i << "]";
2016-04-03 07:14:54 +08:00
}
2016-08-05 08:56:40 +08:00
};
void user_defined_example()
{
2018-07-08 21:39:25 +08:00
spdlog::get("console")->info("user defined type: {}", my_type{14});
2016-04-03 07:14:54 +08:00
}
2018-07-17 20:09:36 +08:00
```
2018-07-17 20:17:31 +08:00
---
2018-07-17 20:09:36 +08:00
#### Custom error handler
```c++
2016-08-05 08:56:40 +08:00
void err_handler_example()
2018-04-29 06:55:09 +08:00
{
2018-07-08 21:39:25 +08: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 20:09:36 +08:00
```
2018-07-17 20:17:31 +08:00
---
2018-07-17 20:13:31 +08:00
#### syslog
2018-07-17 20:09:36 +08:00
```c++
2018-07-08 21:39:25 +08:00
#include "spdlog/sinks/syslog_sink.h"
void syslog_example()
{
std::string ident = "spdlog-example";
2018-08-07 03:19:16 +08:00
auto syslog_logger = spdlog::syslog_logger_mt("syslog", ident, LOG_PID);
2018-07-08 21:39:25 +08:00
syslog_logger->warn("This is warning that will end up in syslog.");
2016-08-05 08:56:40 +08:00
}
2018-07-17 20:09:36 +08:00
```
2018-07-17 20:17:31 +08:00
---
2018-07-17 20:09:36 +08:00
#### Android example
```c++
2018-07-08 21:39:25 +08:00
#incude "spdlog/sinks/android_sink.h"
void android_example()
{
std::string tag = "spdlog-android";
auto android_logger = spdlog::android_logger("android", tag);
android_logger->critical("Use \"adb shell logcat\" to view this message.");
}
2016-04-03 07:14:54 +08:00
```
## Documentation
Documentation can be found in the [wiki](https://github.com/gabime/spdlog/wiki/1.-QuickStart) pages.