spdlog/example/example.cpp

229 lines
7.6 KiB
C++
Raw Normal View History

2018-04-20 06:20:19 -04:00
//
2016-04-20 04:57:49 -04:00
// Copyright(c) 2015 Gabi Melman.
// Distributed under the MIT License (http://opensource.org/licenses/MIT)
//
//
// spdlog usage example
//
//
2017-06-17 17:42:31 -04:00
2018-10-11 20:04:55 -04:00
#include <cstdio>
2018-07-07 05:37:17 -04:00
2018-10-11 20:04:55 -04:00
void stdout_logger_example();
2018-07-07 05:37:17 -04:00
void basic_example();
void rotating_example();
void daily_example();
2016-04-20 04:57:49 -04:00
void async_example();
void binary_example();
2018-10-11 20:04:55 -04:00
void trace_example();
2018-07-08 09:20:28 -04:00
void multi_sink_example();
2016-07-22 11:06:36 -04:00
void user_defined_example();
2016-08-04 20:56:40 -04:00
void err_handler_example();
2018-06-10 16:01:46 -04:00
void syslog_example();
2018-08-25 10:35:20 -04:00
void clone_example();
2016-04-20 04:57:49 -04:00
2018-10-11 20:04:55 -04:00
#define SPDLOG_TRACE_ON
2018-10-13 12:23:11 -04:00
2018-07-07 05:53:56 -04:00
#include "spdlog/spdlog.h"
2018-03-09 08:26:33 -05:00
int main(int, char *[])
2016-04-20 04:57:49 -04:00
{
2018-10-11 20:04:55 -04:00
spdlog::info("Welcome to spdlog version {}.{}.{} !", SPDLOG_VER_MAJOR, SPDLOG_VER_MINOR, SPDLOG_VER_PATCH);
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("{:>8} aligned, {:>8} aligned", "right", "left");
// Runtime log levels
spdlog::set_level(spdlog::level::info); // Set global log level to info
spdlog::debug("This message should not be displayed!");
spdlog::set_level(spdlog::level::trace); // Set specific logger's log level
spdlog::debug("This message should be displayed..");
// Customize msg format for all loggers
spdlog::set_pattern("[%H:%M:%S %z] [%^%L%$] [thread %t] %v");
spdlog::info("This an info message with custom format");
spdlog::set_pattern("%+"); // back to default format
2018-04-20 06:20:19 -04:00
try
{
2018-10-11 20:04:55 -04:00
stdout_logger_example();
2018-07-07 05:37:17 -04:00
basic_example();
rotating_example();
daily_example();
2018-08-25 10:35:20 -04:00
clone_example();
2018-05-26 18:29:13 -04:00
async_example();
binary_example();
2018-07-08 09:20:28 -04:00
multi_sink_example();
2018-04-20 06:20:19 -04:00
user_defined_example();
err_handler_example();
2018-10-11 20:04:55 -04:00
trace_example();
2018-04-20 06:20:19 -04:00
2018-10-11 20:04:55 -04:00
// Flush all *registered* loggers using a worker thread every 3 seconds.
2018-07-21 16:48:07 -04:00
// note: registered loggers *must* be thread safe for this to work correctly!
spdlog::flush_every(std::chrono::seconds(3));
2018-10-11 20:04:55 -04:00
// Apply some function on all registered loggers
2018-07-21 16:48:07 -04:00
spdlog::apply_all([&](std::shared_ptr<spdlog::logger> l) { l->info("End of example."); });
2018-04-20 06:20:19 -04:00
2018-10-11 20:04:55 -04:00
// Release all spdlog resources, and drop all loggers in the registry.
// This is optional (only mandatory if using windows + async log).
2018-07-24 17:06:10 -04:00
spdlog::shutdown();
2018-04-20 06:20:19 -04:00
}
2018-10-11 20:04:55 -04:00
// Exceptions will only be thrown upon failed logger or sink construction (not during logging).
2018-07-07 05:53:56 -04:00
catch (const spdlog::spdlog_ex &ex)
2018-04-20 06:20:19 -04:00
{
2018-10-11 20:04:55 -04:00
std::printf("Log initialization failed: %s\n", ex.what());
2018-04-20 06:20:19 -04:00
return 1;
}
2016-04-20 04:57:49 -04:00
}
2018-07-07 05:37:17 -04:00
#include "spdlog/sinks/stdout_color_sinks.h"
2018-10-11 20:04:55 -04:00
// or #include "spdlog/sinks/stdout_sinks.h" if no colors needed.
void stdout_logger_example()
2018-07-07 05:53:56 -04:00
{
2018-10-11 20:04:55 -04:00
// Create color multi threaded logger.
2018-07-07 08:27:17 -04:00
auto console = spdlog::stdout_color_mt("console");
2018-10-11 20:04:55 -04:00
// or for stderr:
// auto console = spdlog::stderr_color_mt("error-logger");
2018-07-07 05:53:56 -04:00
}
2018-07-07 05:37:17 -04:00
#include "spdlog/sinks/basic_file_sink.h"
void basic_example()
{
2018-10-11 20:04:55 -04:00
// Create basic file logger (not rotated).
auto my_logger = spdlog::basic_logger_mt("file_logger", "logs/basic-log.txt");
2018-07-07 05:37:17 -04:00
}
#include "spdlog/sinks/rotating_file_sink.h"
void rotating_example()
{
2018-10-11 20:04:55 -04:00
// Create a file rotating logger with 5mb size max and 3 rotated files.
2018-07-07 05:53:56 -04:00
auto rotating_logger = spdlog::rotating_logger_mt("some_logger_name", "logs/rotating.txt", 1048576 * 5, 3);
2018-07-07 05:37:17 -04:00
}
#include "spdlog/sinks/daily_file_sink.h"
void daily_example()
{
2018-10-11 20:04:55 -04:00
// Create a daily logger - a new file is created every day on 2:30am.
2018-07-07 05:53:56 -04:00
auto daily_logger = spdlog::daily_logger_mt("daily_logger", "logs/daily.txt", 2, 30);
2018-07-07 05:37:17 -04:00
}
2018-10-11 20:04:55 -04:00
// Clone a logger and give it new name.
// Useful for creating component/subsystem loggers from some "root" logger.
2018-08-25 10:35:20 -04:00
void clone_example()
{
2018-10-13 12:23:11 -04:00
auto network_logger = spdlog::default_logger()->clone("network");
2018-08-25 10:35:20 -04:00
network_logger->info("Logging network stuff..");
}
2018-04-13 20:47:26 -04:00
#include "spdlog/async.h"
2016-04-20 04:57:49 -04:00
void async_example()
{
2018-10-11 20:04:55 -04:00
// Default thread pool settings can be modified *before* creating the async logger:
// spdlog::init_thread_pool(32768, 1); // queue with max 32k items 1 backing thread.
2018-07-07 05:53:56 -04:00
auto async_file = spdlog::basic_logger_mt<spdlog::async_factory>("async_file_logger", "logs/async_log.txt");
// alternatively:
2018-07-07 05:53:56 -04:00
// auto async_file = spdlog::create_async<spdlog::sinks::basic_file_sink_mt>("async_file_logger", "logs/async_log.txt");
2018-07-07 05:53:56 -04:00
for (int i = 1; i < 101; ++i)
2018-05-26 11:48:39 -04:00
{
2018-07-07 05:53:56 -04:00
async_file->info("Async message #{}", i);
2018-06-01 10:52:05 -04:00
}
2016-04-20 04:57:49 -04:00
}
2018-10-11 20:04:55 -04:00
// Log binary data as hex.
// Many types of std::container<char> types can be used.
// Iterator 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()
{
std::array<char, 80> buf;
2018-10-11 20:04:55 -04:00
spdlog::info("Binary example: {}", spdlog::to_hex(buf));
spdlog::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));
}
2018-10-11 20:04:55 -04:00
// Compile time log levels.
2018-10-13 12:23:11 -04:00
// Must define SPDLOG_DEBUG_ON or SPDLOG_TRACE_ON before including spdlog.h to turn them on.
2018-10-11 20:04:55 -04:00
void trace_example()
{
2018-10-13 12:23:11 -04:00
auto logger = spdlog::get("file_logger");
2018-10-11 20:04:55 -04:00
SPDLOG_TRACE(logger, "Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}", 1, 3.23);
SPDLOG_DEBUG(logger, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23);
}
2018-07-08 09:20:28 -04:00
2018-10-11 20:04:55 -04:00
// A logger with multiple sinks (stdout and file) - each with a different format and log level.
2018-07-08 09:20:28 -04:00
void multi_sink_example()
{
2018-07-08 09:26:14 -04:00
auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
2018-07-08 09:20:28 -04:00
console_sink->set_level(spdlog::level::warn);
console_sink->set_pattern("[multi_sink_example] [%^%l%$] %v");
2018-07-08 09:26:14 -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-07-08 09:20:28 -04:00
spdlog::logger logger("multi_sink", {console_sink, file_sink});
2018-07-08 09:26:14 -04:00
logger.set_level(spdlog::level::debug);
2018-07-08 09:20:28 -04:00
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-10-11 20:04:55 -04:00
// User defined types logging by implementing operator<<
2018-07-07 05:37:17 -04:00
#include "spdlog/fmt/ostr.h" // must be included
2016-07-22 11:06:36 -04:00
struct my_type
{
2018-04-20 06:20:19 -04:00
int i;
template<typename OStream>
friend OStream &operator<<(OStream &os, const my_type &c)
{
return os << "[my_type i=" << c.i << "]";
}
2016-07-22 11:06:36 -04:00
};
void user_defined_example()
{
2018-10-11 20:04:55 -04:00
spdlog::info("user defined type: {}", my_type{14});
2016-07-22 11:06:36 -04:00
}
2018-10-11 20:04:55 -04:00
// Custom error handler. Will be triggered on log failure.
2016-08-04 20:56:40 -04:00
void err_handler_example()
2016-08-04 21:43:20 -04:00
{
2018-07-07 05:53:56 -04:00
// can be set globally or per logger(logger->set_error_handler(..))
2018-10-11 20:04:55 -04:00
spdlog::set_error_handler([](const std::string &msg) { printf("*** Custom log error handler: %s ***\n", msg.c_str()); });
2016-08-04 20:56:40 -04:00
}
2018-07-07 05:37:17 -04:00
// syslog example (linux/osx/freebsd)
#ifndef _WIN32
#include "spdlog/sinks/syslog_sink.h"
void syslog_example()
{
std::string ident = "spdlog-example";
auto syslog_logger = spdlog::syslog_logger_mt("syslog", ident, LOG_PID);
2018-07-07 05:37:17 -04:00
syslog_logger->warn("This is warning that will end up in syslog.");
}
#endif
2018-10-11 20:04:55 -04:00
// Android example.
2018-07-07 05:37:17 -04:00
#if defined(__ANDROID__)
#include "spdlog/sinks/android_sink.h"
2018-07-07 05:37:17 -04:00
void android_example()
{
std::string tag = "spdlog-android";
auto android_logger = spdlog::android_logger_mt("android", tag);
2018-07-07 05:37:17 -04:00
android_logger->critical("Use \"adb shell logcat\" to view this message.");
}
#endif