spdlog/example/example.cpp

171 lines
5.5 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
#define SPDLOG_TRACE_ON
#define SPDLOG_DEBUG_ON
2018-04-28 18:26:10 -04:00
#include "spdlog/sinks/daily_file_sink.h"
#include "spdlog/sinks/rotating_file_sink.h"
2018-04-28 18:36:45 -04:00
#include "spdlog/sinks/simple_file_sink.h"
2018-04-20 06:20:19 -04:00
#include "spdlog/sinks/stdout_color_sinks.h"
2016-04-20 04:57:49 -04:00
#include <iostream>
#include <memory>
void async_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();
2016-04-20 04:57:49 -04:00
namespace spd = spdlog;
2018-03-09 08:26:33 -05:00
int main(int, char *[])
2016-04-20 04:57:49 -04:00
{
2018-04-19 18:50:09 -04:00
2018-04-20 06:20:19 -04:00
try
{
2018-06-10 16:01:46 -04:00
syslog_example();
2018-04-20 06:20:19 -04:00
auto console = spdlog::stdout_color_st("console");
console->info("Welcome to spdlog!");
console->info("Welcome to spdlog!");
console->error("Some error message with arg: {}", 1);
err_handler_example();
// 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-log.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/rotating.txt", 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.txt", 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
2018-04-28 18:36:45 -04:00
spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v");
2018-04-20 06:20:19 -04:00
console->info("This an info message with custom format");
console->error("This an error message with custom format");
2018-04-28 18:36:45 -04:00
// Change format back to to default
spd::set_pattern("%+");
2018-04-28 17:35:32 -04:00
2018-04-20 06:20:19 -04:00
// Runtime log levels
spd::set_level(spd::level::info); // Set global log level to info
console->debug("This message should not be displayed!");
console->set_level(spd::level::debug); // Set specific logger's log level
console->debug("This message should 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);
2018-05-26 18:29:13 -04:00
// Asynchronous logging example
async_example();
2018-04-20 06:20:19 -04:00
// 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-04-20 04:57:49 -04:00
}
2018-04-13 20:47:26 -04:00
// must be included to use async logger
#include "spdlog/async.h"
2016-04-20 04:57:49 -04:00
void async_example()
{
2018-05-26 18:29:13 -04:00
auto async_file = spd::basic_logger_mt<spdlog::create_async>("async_file_logger", "logs/async_log.txt");
2018-05-26 11:48:39 -04:00
2018-05-26 18:29:13 -04:00
// thread pool settings can be modified *before* creating the async logger:
// spdlog::init_thread_pool(32768, 4); // queue with max 32k items 4 backing threads.
for (int i = 0; i < 100; ++i)
2018-05-26 11:48:39 -04:00
{
2018-05-26 18:29:13 -04:00
async_file->info("Async message #{}", i + 1);
2018-06-01 10:52:05 -04:00
}
2016-04-20 04:57:49 -04:00
}
2018-03-09 08:26:33 -05:00
// syslog example (linux/osx/freebsd)
2018-04-19 19:57:05 -04:00
#ifndef _WIN32
2018-04-20 06:20:19 -04:00
#include "spdlog/sinks/syslog_sink.h"
2016-04-20 04:57:49 -04:00
void syslog_example()
{
2018-04-20 06:20:19 -04:00
std::string ident = "spdlog-example";
auto syslog_logger = spd::syslog_logger("syslog", ident, LOG_PID);
syslog_logger->warn("This is warning that will end up in syslog.");
2016-04-20 04:57:49 -04:00
}
2018-04-19 19:57:05 -04:00
#endif
2016-04-20 04:57:49 -04:00
2016-09-14 05:16:18 -04:00
// Android example
2018-04-19 19:57:05 -04:00
#if defined(__ANDROID__)
#incude "spdlog/sinks/android_sink.h"
2016-09-14 05:16:18 -04:00
void android_example()
{
2018-04-20 06:20:19 -04:00
std::string tag = "spdlog-android";
auto android_logger = spd::android_logger("android", tag);
android_logger->critical("Use \"adb shell logcat\" to view this message.");
2016-09-14 05:16:18 -04:00
}
2018-04-19 19:57:05 -04:00
#endif
2016-07-22 13:19:26 -04:00
// user defined types logging by implementing operator<<
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
};
2017-05-21 13:39:54 -04:00
#include "spdlog/fmt/ostr.h" // must be included
2016-07-22 11:06:36 -04:00
void user_defined_example()
{
2018-04-20 06:20:19 -04:00
spd::get("console")->info("user defined type: {}", my_type{14});
2016-07-22 11:06:36 -04:00
}
2016-08-04 20:56:40 -04:00
//
2018-03-09 08:26:33 -05:00
// custom error handler
2016-08-04 20:56:40 -04:00
//
void err_handler_example()
2016-08-04 21:43:20 -04:00
{
2018-04-20 06:20:19 -04:00
// can be set globaly or per logger(logger->set_error_handler(..))
spdlog::set_error_handler([](const std::string &msg) { spd::get("console")->error("*******my err handler: {}", msg); });
spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3);
// spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3);
2016-08-04 20:56:40 -04:00
}