spdlog/example/example.cpp

164 lines
5.1 KiB
C++
Raw Normal View History

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
//
//
2016-04-20 04:57:49 -04:00
#include "spdlog/spdlog.h"
#include <iostream>
#include <memory>
void async_example();
void syslog_example();
2016-09-14 05:16:18 -04:00
void android_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();
2016-04-20 04:57:49 -04:00
namespace spd = spdlog;
int main(int, char*[])
{
2016-07-22 13:19:26 -04:00
try
{
2016-10-12 16:08:44 -04:00
// Console logger with color
auto console = spd::stdout_color_mt("console");
2016-07-22 13:19:26 -04:00
console->info("Welcome to spdlog!");
2016-10-12 16:08:44 -04:00
console->error("Some error message with arg{}..", 1);
2016-09-02 10:06:00 -04:00
2016-07-22 13:19:26 -04:00
// 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");
2016-10-12 16:08:44 -04:00
2016-07-22 13:19:26 -04:00
spd::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name) function");
2016-10-12 16:08:44 -04:00
2016-07-22 13:19:26 -04:00
// 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);
2016-09-02 10:06:00 -04:00
// trigger flush if the log severity is error or higher
daily_logger->flush_on(spd::level::err);
2016-07-22 13:19:26 -04:00
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");
2016-10-12 16:08:44 -04:00
// 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
2016-07-22 13:19:26 -04:00
SPDLOG_TRACE(console, "Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}", 1, 3.23);
SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23);
2016-08-04 21:43:20 -04:00
2016-07-22 13:19:26 -04:00
// 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
2016-07-22 13:19:26 -04:00
syslog_example();
2016-09-14 05:16:18 -04:00
// android example. compile with NDK
android_example();
// Log user-defined types example
2016-07-22 13:19:26 -04:00
user_defined_example();
2016-08-04 21:43:20 -04:00
// Change default log error handler
err_handler_example();
2016-08-04 20:56:40 -04:00
2016-08-20 06:55:50 -04:00
// 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
2016-07-22 13:19:26 -04:00
spdlog::drop_all();
}
2016-08-04 21:43:20 -04:00
// Exceptions will only be thrown upon failed logger or sink construction (not during logging)
2016-07-22 13:19:26 -04:00
catch (const spd::spdlog_ex& ex)
{
2016-08-04 20:56:40 -04:00
std::cout << "Log init failed: " << ex.what() << std::endl;
return 1;
2016-08-04 21:43:20 -04:00
}
2016-04-20 04:57:49 -04:00
}
void async_example()
{
2016-07-22 13:19:26 -04:00
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");
2016-09-02 10:06:00 -04:00
2016-07-22 13:19:26 -04:00
for (int i = 0; i < 100; ++i)
2016-08-20 06:26:13 -04:00
async_file->info("Async message #{}", i);
2016-04-20 04:57:49 -04:00
}
2016-08-20 18:21:18 -04:00
//syslog example (linux/osx/freebsd)
2016-04-20 04:57:49 -04:00
void syslog_example()
{
#ifdef SPDLOG_ENABLE_SYSLOG
2016-07-22 13:19:26 -04:00
std::string ident = "spdlog-example";
auto syslog_logger = spd::syslog_logger("syslog", ident, LOG_PID);
2016-08-20 18:21:18 -04:00
syslog_logger->warn("This is warning that will end up in syslog.");
2016-04-20 04:57:49 -04:00
#endif
}
2016-09-14 05:16:18 -04:00
// Android example
void android_example()
{
#if defined(__ANDROID__)
std::string tag = "spdlog-android";
auto android_logger = spd::android_logger("android", tag);
android_logger->critical("Use \"adb shell logcat\" to view this message.");
#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
{
2016-07-22 13:19:26 -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
};
#include <spdlog/fmt/ostr.h> // must be included
void user_defined_example()
{
2016-07-22 13:19:26 -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
//
//custom error handler
//
void err_handler_example()
2016-08-04 21:43:20 -04:00
{
//can be set globaly or per logger(logger->set_error_handler(..))
spdlog::set_error_handler([](const std::string& msg)
{
std::cerr << "my err handler: " << msg << std::endl;
});
spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3);
2016-08-04 20:56:40 -04:00
}