diff --git a/example/example.cpp b/example/example.cpp index f5689c64..ebcdc35a 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -18,231 +18,18 @@ void user_defined_example(); void err_handler_example(); void syslog_example(); -#include "spdlog/spdlog.h" +#include +#include +#include +#include -int main(int, char *[]) +int main(int args, char *argv[]) { - 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"); + spdlog::cfg::init_from_env(); + spdlog::cfg::init_from_argv(args, argv); + spdlog::debug("HELLO DEBUG"); + spdlog::info("HELLO INFO"); - // 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 - spdlog::set_level(spdlog::level::info); - - // Backtrace support - // Loggers can store in a ring buffer all messages (including debug/trace) for later inspection. - // When needed, call dump_backtrace() to see what happened: - spdlog::enable_backtrace(10); // create ring buffer with capacity of 10 messages - for (int i = 0; i < 100; i++) - { - spdlog::debug("Backtrace message {}", i); // not logged.. - } - // e.g. if some error happened: - spdlog::dump_backtrace(); // log them now! - - try - { - stdout_logger_example(); - basic_example(); - rotating_example(); - daily_example(); - async_example(); - binary_example(); - multi_sink_example(); - user_defined_example(); - err_handler_example(); - trace_example(); - - // Flush all *registered* loggers using a worker thread every 3 seconds. - // note: registered loggers *must* be thread safe for this to work correctly! - spdlog::flush_every(std::chrono::seconds(3)); - - // Apply some function on all registered loggers - spdlog::apply_all([&](std::shared_ptr l) { l->info("End of example."); }); - - // Release all spdlog resources, and drop all loggers in the registry. - // This is optional (only mandatory if using windows + async log). - spdlog::shutdown(); - } - - // Exceptions will only be thrown upon failed logger or sink construction (not during logging). - catch (const spdlog::spdlog_ex &ex) - { - std::printf("Log initialization failed: %s\n", ex.what()); - return 1; - } -} - -#include "spdlog/sinks/stdout_color_sinks.h" -// or #include "spdlog/sinks/stdout_sinks.h" if no colors needed. -void stdout_logger_example() -{ - // Create color multi threaded logger. - auto console = spdlog::stdout_color_mt("console"); - // or for stderr: - // auto console = spdlog::stderr_color_mt("error-logger"); -} - -#include "spdlog/sinks/basic_file_sink.h" -void basic_example() -{ - // Create basic file logger (not rotated). - auto my_logger = spdlog::basic_logger_mt("file_logger", "logs/basic-log.txt"); -} - -#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); -} - -#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); -} - -// Load log levels from SPDLOG_LEVEL environment variable if exists. -// -// set global level to debug: -// export SPDLOG_LEVEL=debug -// -// turn off all logging except for logger1: -// export SPDLOG_LEVEL="off,logger1=debug" -#include "spdlog/cfg/env.h" -void env_example() -{ - spdlog::env::load_levels(); - spdlog::warn("env_sample. enabled with export SPDLOG_LEVEL=warn"); -} - -#include "spdlog/async.h" -void async_example() -{ - // 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. - auto async_file = spdlog::basic_logger_mt("async_file_logger", "logs/async_log.txt"); - // alternatively: - // auto async_file = spdlog::create_async("async_file_logger", "logs/async_log.txt"); - - for (int i = 1; i < 101; ++i) - { - async_file->info("Async message #{}", i); - } -} - -// Log binary data as hex. -// Many types of std::container 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::vector buf(80); - for (int i = 0; i < 80; i++) - { - buf.push_back(static_cast(i & 0xff)); - } - 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)); -} - -// Compile time log levels. -// define SPDLOG_ACTIVE_LEVEL to required level (e.g. SPDLOG_LEVEL_TRACE) -void trace_example() -{ - // trace from default logger - SPDLOG_TRACE("Some trace message.. {} ,{}", 1, 3.23); - // debug from default logger - SPDLOG_DEBUG("Some debug message.. {} ,{}", 1, 3.23); - - // trace from logger object - auto logger = spdlog::get("file_logger"); - SPDLOG_LOGGER_TRACE(logger, "another trace message"); -} - -// A logger with multiple sinks (stdout and file) - each with a different format and log level. -void multi_sink_example() -{ - auto console_sink = std::make_shared(); - console_sink->set_level(spdlog::level::warn); - console_sink->set_pattern("[multi_sink_example] [%^%l%$] %v"); - - auto file_sink = std::make_shared("logs/multisink.txt", true); - file_sink->set_level(spdlog::level::trace); - - 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"); -} - -// User defined types logging by implementing operator<< -#include "spdlog/fmt/ostr.h" // must be included -struct my_type -{ - int i; - template - friend OStream &operator<<(OStream &os, const my_type &c) - { - return os << "[my_type i=" << c.i << "]"; - } -}; - -void user_defined_example() -{ - spdlog::info("user defined type: {}", my_type{14}); -} - -// Custom error handler. Will be triggered on log failure. -void err_handler_example() -{ - // can be set globally or per logger(logger->set_error_handler(..)) - spdlog::set_error_handler([](const std::string &msg) { printf("*** Custom log error handler: %s ***\n", msg.c_str()); }); -} - -// 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); - syslog_logger->warn("This is warning that will end up in syslog."); -} -#endif - -// Android example. -#if defined(__ANDROID__) -#include "spdlog/sinks/android_sink.h" -void android_example() -{ - std::string tag = "spdlog-android"; - auto android_logger = spdlog::android_logger_mt("android", tag); - android_logger->critical("Use \"adb shell logcat\" to view this message."); -} - -#endif + auto l1 = spdlog::stderr_color_st("l1"); + l1->trace("L1 TRACE"); +} \ No newline at end of file diff --git a/include/spdlog/cfg/argv_loader.h b/include/spdlog/cfg/argv_loader.h new file mode 100644 index 00000000..51ee9773 --- /dev/null +++ b/include/spdlog/cfg/argv_loader.h @@ -0,0 +1,47 @@ +// Copyright(c) 2015-present, Gabi Melman & spdlog contributors. +// Distributed under the MIT License (http://opensource.org/licenses/MIT) + +#pragma once +#include +#include + +// +// Init levels and patterns from env variables SPDLOG_LEVEL +// Inspired from Rust's "env_logger" crate (https://crates.io/crates/env_logger). +// Note - fallback to "info" level on unrecognized levels +// +// Examples: +// +// set global level to debug: +// export SPDLOG_LEVEL=debug +// +// turn off all logging except for logger1: +// export SPDLOG_LEVEL="off,logger1=debug" +// +// turn off all logging except for logger1 and logger2: +// export SPDLOG_LEVEL="off,logger1=debug,logger2=info" + +namespace spdlog { +namespace cfg { +// search for SPDLOG_LEVEL= in the args and use it to init the levels +void init_from_argv(int args, char *argv[]) +{ + if (args < 2) + { + return; + } + const std::string spdlog_level_prefix = "SPDLOG_LEVEL="; + for (int i = 0; i < args; i++) + { + std::string arg = argv[i]; + if (arg.find(spdlog_level_prefix) == 0) + { + auto cfg_string = arg.substr(spdlog_level_prefix.size()); + auto levels = text_loader::load_levels(cfg_string); + spdlog::details::registry::instance().set_levels(levels); + return; + } + } +} +} // namespace cfg +} // namespace spdlog diff --git a/include/spdlog/cfg/env.h b/include/spdlog/cfg/env.h index 9a74f999..5ef86f99 100644 --- a/include/spdlog/cfg/env.h +++ b/include/spdlog/cfg/env.h @@ -2,10 +2,8 @@ // Distributed under the MIT License (http://opensource.org/licenses/MIT) #pragma once - -#include -#include -#include +#include +#include // // Init levels and patterns from env variables SPDLOG_LEVEL @@ -24,11 +22,12 @@ // export SPDLOG_LEVEL="off,logger1=debug,logger2=info" namespace spdlog { -namespace env { -void load_levels(); -} // namespace env +namespace cfg { +void init_from_env() +{ + auto cfg = details::os::getenv("SPDLOG_LEVEL"); + auto levels = text_loader::load_levels(cfg); + spdlog::details::registry::instance().set_levels(levels); +} +} // namespace cfg } // namespace spdlog - -#ifdef SPDLOG_HEADER_ONLY -#include "env-inl.h" -#endif // SPDLOG_HEADER_ONLY diff --git a/include/spdlog/cfg/env-inl.h b/include/spdlog/cfg/text_loader-inl.h similarity index 92% rename from include/spdlog/cfg/env-inl.h rename to include/spdlog/cfg/text_loader-inl.h index cb61aa41..de586a17 100644 --- a/include/spdlog/cfg/env-inl.h +++ b/include/spdlog/cfg/text_loader-inl.h @@ -4,7 +4,7 @@ #pragma once #ifndef SPDLOG_HEADER_ONLY -#include +#include #endif #include @@ -16,7 +16,8 @@ #include namespace spdlog { -namespace env { +namespace cfg { +namespace text_loader { using name_val_pair = std::pair; @@ -106,11 +107,11 @@ inline details::registry::logger_levels extract_levels_(const std::string &input return rv; } -SPDLOG_INLINE void load_levels() +SPDLOG_INLINE details::registry::logger_levels load_levels(const std::string &cfg) { - auto levels = extract_levels_(details::os::getenv("SPDLOG_LEVEL")); - spdlog::details::registry::instance().set_levels(levels); + return extract_levels_(cfg); } -} // namespace env +} // namespace text_loader +} // namespace cfg } // namespace spdlog diff --git a/include/spdlog/cfg/text_loader.h b/include/spdlog/cfg/text_loader.h new file mode 100644 index 00000000..ade7eb25 --- /dev/null +++ b/include/spdlog/cfg/text_loader.h @@ -0,0 +1,37 @@ +// Copyright(c) 2015-present, Gabi Melman & spdlog contributors. +// Distributed under the MIT License (http://opensource.org/licenses/MIT) + +#pragma once + +#include +#include +#include + +// +// Init levels and patterns from env variables SPDLOG_LEVEL +// Inspired from Rust's "env_logger" crate (https://crates.io/crates/env_logger). +// Note - fallback to "info" level on unrecognized levels +// +// Examples: +// +// set global level to debug: +// export SPDLOG_LEVEL=debug +// +// turn off all logging except for logger1: +// export SPDLOG_LEVEL="off,logger1=debug" +// +// turn off all logging except for logger1 and logger2: +// export SPDLOG_LEVEL="off,logger1=debug,logger2=info" + +namespace spdlog { +namespace cfg { +namespace text_loader { +details::registry::logger_levels load_levels(const std::string &cfg); +} + +} // namespace cfg +} // namespace spdlog + +#ifdef SPDLOG_HEADER_ONLY +#include "text_loader-inl.h" +#endif // SPDLOG_HEADER_ONLY diff --git a/src/spdlog.cpp b/src/spdlog.cpp index 150b2b65..9882768c 100644 --- a/src/spdlog.cpp +++ b/src/spdlog.cpp @@ -17,7 +17,7 @@ #include "spdlog/sinks/sink-inl.h" #include "spdlog/sinks/base_sink-inl.h" #include "spdlog/details/null_mutex.h" -#include "spdlog/cfg/env-inl.h" +#include "spdlog/cfg/text_loader-inl.h" #include