log.hh

/*
 * This file is open source software, licensed to you under the terms
 * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership.  You may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
/*
 * Copyright (C) 2015 Cloudius Systems, Ltd.
 */
#pragma once
 
#include <seastar/core/sstring.hh>
#include <seastar/util/backtrace.hh>
#include <seastar/util/log-impl.hh>
#include <seastar/core/lowres_clock.hh>
#include <seastar/util/std-compat.hh>
#include <seastar/util/modules.hh>
 
#ifndef SEASTAR_MODULE
#include <concepts>
#include <unordered_map>
#include <exception>
#include <iosfwd>
#include <atomic>
#include <mutex>
#include <type_traits>
#include <fmt/core.h>
#include <fmt/format.h>
#endif
 
 
namespace seastar {
 
SEASTAR_MODULE_EXPORT_BEGIN
 
enum class log_level {
    error,
    warn,
    info,
    debug,
    trace,
};
 
std::ostream& operator<<(std::ostream& out, log_level level);
std::istream& operator>>(std::istream& in, log_level& level);
 
SEASTAR_MODULE_EXPORT_END
}
 
template <>
struct fmt::formatter<seastar::log_level> {
    constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); }
    auto format(seastar::log_level level, fmt::format_context& ctx) const -> decltype(ctx.out());
};
 
namespace seastar {
SEASTAR_MODULE_EXPORT_BEGIN
class logger;
class logger_registry;
 
class logger {
    sstring _name;
    std::atomic<log_level> _level = { log_level::info };
    static std::ostream* _out;
    static std::atomic<bool> _ostream;
    static std::atomic<bool> _syslog;
    static unsigned _shard_field_width;
#ifdef SEASTAR_BUILD_SHARED_LIBS
    static thread_local bool silent;
#else
    static inline thread_local bool silent = false;
#endif
 
public:
    class log_writer {
    public:
        virtual ~log_writer() = default;
        virtual internal::log_buf::inserter_iterator operator()(internal::log_buf::inserter_iterator) = 0;
    };
    template <typename Func>
    requires requires (Func fn, internal::log_buf::inserter_iterator it) {
        it = fn(it);
    }
    class lambda_log_writer : public log_writer {
        Func _func;
    public:
        lambda_log_writer(Func&& func) : _func(std::forward<Func>(func)) { }
        virtual ~lambda_log_writer() override = default;
        virtual internal::log_buf::inserter_iterator operator()(internal::log_buf::inserter_iterator it) override { return _func(it); }
    };
 
#ifdef SEASTAR_LOGGER_COMPILE_TIME_FMT
    template<typename... Args>
    struct format_info {
        template<
            typename S,
            std::enable_if_t<std::is_convertible_v<const S&, std::string_view>, int> = 0>
        FMT_CONSTEVAL inline format_info(const S& format,
                           compat::source_location loc = compat::source_location::current()) noexcept
            : format(format)
            , loc(loc)
        {}
        inline format_info(fmt::format_string<Args...> s,
                           compat::source_location loc = compat::source_location::current()) noexcept
            : format(s)
            , loc(loc)
        {}
#if FMT_VERSION >= 100000
        using runtime_format_string_t = fmt::runtime_format_string<char>;
#else
        using runtime_format_string_t = fmt::basic_runtime<char>;
#endif
        inline format_info(runtime_format_string_t s,
                           compat::source_location loc = compat::source_location::current()) noexcept
            : format(s)
            , loc(loc)
        {}
        FMT_CONSTEVAL format_info() noexcept
            : format_info("")
        {}
        fmt::format_string<Args...> format;
        compat::source_location loc;
    };
#ifdef __cpp_lib_type_identity
    template <typename T>
    using type_identity_t = typename std::type_identity<T>::type;
#else
    template <typename T> struct type_identity { using type = T; };
    template <typename T> using type_identity_t = typename type_identity<T>::type;
#endif
    template <typename... Args>
    using format_info_t = format_info<type_identity_t<Args>...>;
#else  // SEASTAR_LOGGER_COMPILE_TIME_FMT
    struct format_info {
        format_info(const char* format, compat::source_location loc = compat::source_location::current()) noexcept
            : format(format)
            , loc(loc)
        {}
        format_info(std::string_view format, compat::source_location loc = compat::source_location::current()) noexcept
            : format(format)
            , loc(loc)
        {}
        format_info(compat::source_location loc = compat::source_location::current()) noexcept
            : format()
            , loc(loc)
        {}
        std::string_view format;
        compat::source_location loc;
    };
    // to reduce the number of #ifdefs, let's be compatible with the templated
    // format_info
    template <typename...>
    using format_info_t = format_info;
#endif // SEASTAR_LOGGER_COMPILE_TIME_FMT
 
private:
 
    // We can't use an std::function<> as it potentially allocates.
    void do_log(log_level level, log_writer& writer);
    void failed_to_log(std::exception_ptr ex,
                       fmt::string_view fmt,
                       compat::source_location loc) noexcept;
 
    class silencer {
    public:
        silencer() noexcept {
            silent = true;
        }
 
        ~silencer() {
            silent = false;
        }
    };
 
public:
    class rate_limit {
        friend class logger;
 
        using clock = lowres_clock;
 
    private:
        clock::duration _interval;
        clock::time_point _next;
        uint64_t _dropped_messages = 0;
 
    private:
        bool check();
        bool has_dropped_messages() const { return bool(_dropped_messages); }
        uint64_t get_and_reset_dropped_messages() {
            return std::exchange(_dropped_messages, 0);
        }
 
    public:
        explicit rate_limit(std::chrono::milliseconds interval);
    };
 
public:
    explicit logger(sstring name);
    logger(logger&& x);
    ~logger();
 
    bool is_shard_zero() noexcept;
 
    bool is_enabled(log_level level) const noexcept {
        return __builtin_expect(level <= _level.load(std::memory_order_relaxed), false) && !silent;
    }
 
    template <typename... Args>
    void log(log_level level, format_info_t<Args...> fmt, Args&&... args) noexcept {
        if (is_enabled(level)) {
            try {
                lambda_log_writer writer([&] (internal::log_buf::inserter_iterator it) {
#ifdef SEASTAR_LOGGER_COMPILE_TIME_FMT
                    return fmt::format_to(it, fmt.format, std::forward<Args>(args)...);
#else
                    return fmt::format_to(it, fmt::runtime(fmt.format), std::forward<Args>(args)...);
#endif
                });
                do_log(level, writer);
            } catch (...) {
                failed_to_log(std::current_exception(), fmt::string_view(fmt.format), fmt.loc);
            }
        }
    }
 
    template <typename... Args>
    void log(log_level level, rate_limit& rl, format_info_t<Args...> fmt, Args&&... args) noexcept {
        if (is_enabled(level) && rl.check()) {
            try {
                lambda_log_writer writer([&] (internal::log_buf::inserter_iterator it) {
                    if (rl.has_dropped_messages()) {
                        it = fmt::format_to(it, "(rate limiting dropped {} similar messages) ", rl.get_and_reset_dropped_messages());
                    }
                    return fmt::format_to(it, fmt::runtime(fmt.format), std::forward<Args>(args)...);
                });
                do_log(level, writer);
            } catch (...) {
                failed_to_log(std::current_exception(), fmt::string_view(fmt.format), fmt.loc);
            }
        }
    }
 
    void log(log_level level, rate_limit& rl, log_writer& writer, format_info_t<> fmt = {}) noexcept {
        if (is_enabled(level) && rl.check()) {
            try {
                lambda_log_writer writer_wrapper([&] (internal::log_buf::inserter_iterator it) {
                    if (rl.has_dropped_messages()) {
                        it = fmt::format_to(it, "(rate limiting dropped {} similar messages) ", rl.get_and_reset_dropped_messages());
                    }
                    return writer(it);
                });
                do_log(level, writer_wrapper);
            } catch (...) {
                failed_to_log(std::current_exception(), "", fmt.loc);
            }
        }
    }
 
    template <typename... Args>
    void error(format_info_t<Args...> fmt, Args&&... args) noexcept {
        log(log_level::error, std::move(fmt), std::forward<Args>(args)...);
    }
    template <typename... Args>
    void warn(format_info_t<Args...> fmt, Args&&... args) noexcept {
        log(log_level::warn, std::move(fmt), std::forward<Args>(args)...);
    }
    template <typename... Args>
    void info(format_info_t<Args...> fmt, Args&&... args) noexcept {
        log(log_level::info, std::move(fmt), std::forward<Args>(args)...);
    }
    template <typename... Args>
    void info0(format_info_t<Args...> fmt, Args&&... args) noexcept {
        if (is_shard_zero()) {
            log(log_level::info, std::move(fmt), std::forward<Args>(args)...);
        }
    }
    template <typename... Args>
    void debug(format_info_t<Args...> fmt, Args&&... args) noexcept {
        log(log_level::debug, std::move(fmt), std::forward<Args>(args)...);
    }
    template <typename... Args>
    void trace(format_info_t<Args...> fmt, Args&&... args) noexcept {
        log(log_level::trace, std::move(fmt), std::forward<Args>(args)...);
    }
 
    const sstring& name() const noexcept {
        return _name;
    }
 
    log_level level() const noexcept {
        return _level.load(std::memory_order_relaxed);
    }
 
    void set_level(log_level level) noexcept {
        _level.store(level, std::memory_order_relaxed);
    }
 
    static void set_ostream(std::ostream& out) noexcept;
 
    static void set_ostream_enabled(bool enabled) noexcept;
 
    static void set_syslog_enabled(bool enabled) noexcept;
 
    static void set_shard_field_width(unsigned width) noexcept;
 
    static void set_with_color(bool enabled) noexcept;
};
 
class logger_registry {
    mutable std::mutex _mutex;
    std::unordered_map<sstring, logger*> _loggers;
public:
    void set_all_loggers_level(log_level level);
 
    log_level get_logger_level(sstring name) const;
 
    void set_logger_level(sstring name, log_level level);
 
    std::vector<sstring> get_all_logger_names();
 
    void register_logger(logger* l);
    void unregister_logger(logger* l);
    void moved(logger* from, logger* to);
};
 
logger_registry& global_logger_registry();
 
enum class logger_timestamp_style {
    none,
    boot,
    real,
};
 
enum class logger_ostream_type {
    none,
    cout = 1,
    cerr = 2,
};
 
struct logging_settings final {
    std::unordered_map<sstring, log_level> logger_levels;
    log_level default_level;
    bool stdout_enabled;
    bool syslog_enabled;
    bool with_color;
    logger_timestamp_style stdout_timestamp_style = logger_timestamp_style::real;
    logger_ostream_type logger_ostream = logger_ostream_type::cerr;
};
 
void apply_logging_settings(const logging_settings&);
 
SEASTAR_MODULE_EXPORT_END
 
 
extern thread_local uint64_t logging_failures;
 
sstring pretty_type_name(const std::type_info&);
 
sstring level_name(log_level level);
 
template <typename T>
class logger_for : public logger {
public:
    logger_for() : logger(pretty_type_name(typeid(T))) {}
};
 
} // end seastar namespace
 
// Pretty-printer for exceptions to be logged, e.g., std::current_exception().
namespace std {
std::ostream& operator<<(std::ostream&, const std::exception_ptr&);
std::ostream& operator<<(std::ostream&, const std::exception&);
std::ostream& operator<<(std::ostream&, const std::system_error&);
}
 
#if FMT_VERSION >= 90000
template <> struct fmt::formatter<std::exception_ptr> : fmt::ostream_formatter {};
template <> struct fmt::formatter<std::exception> : fmt::ostream_formatter {};
template <> struct fmt::formatter<std::system_error> : fmt::ostream_formatter {};
#endif