spdlog_log_sink.h

Go to the documentation of this file.

/*
 * Copyright 2023 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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.
 */
#pragma once
 
#include <memory>
#include <string>
#include <string_view>
#include <utility>
 
#include <spdlog/common.h>
#include <spdlog/logger.h>
 
#include "msgpack_rpc/common/msgpack_rpc_exception.h"
#include "msgpack_rpc/common/status_code.h"
#include "msgpack_rpc/logging/i_log_sink.h"
#include "msgpack_rpc/logging/log_level.h"
#include "msgpack_rpc/logging/source_location_view.h"
 
namespace msgpack_rpc::logging::impl::spdlog_backend {

[[nodiscard]] inline spdlog::level::level_enum convert_log_level(
    LogLevel level) {
    using spdlog::level::level_enum;
    switch (level) {
    case LogLevel::TRACE:
        return level_enum::trace;
    case LogLevel::DEBUG:
        return level_enum::debug;
    case LogLevel::INFO:
        return level_enum::info;
    case LogLevel::WARN:
        return level_enum::warn;
    case LogLevel::ERROR:
        return level_enum::err;
    case LogLevel::CRITICAL:
        return level_enum::critical;
    }
    return level_enum::trace;
}

class SpdlogLogSink final : public ILogSink {
public:
    explicit SpdlogLogSink(std::shared_ptr<spdlog::logger> logger)
        : logger_(std::move(logger)) {
        if (!logger_) {
            throw MsgpackRPCException(StatusCode::INVALID_ARGUMENT,
                "Null logger was given to SpdlogLogSink class.");
        }
 
        // Log level is checked in Logger class.
        logger_->set_level(spdlog::level::trace);
    }

    void write(SourceLocationView location, LogLevel level,
        std::string_view body) override {
        logger_->log(
            spdlog::source_loc(location.file_path().data(),
                static_cast<int>(location.line()), location.function().data()),
            convert_log_level(level), body);
        logger_->flush();  // TODO configuration
    }
 
private:
    std::shared_ptr<spdlog::logger> logger_;
};

inline void configure_spdlog_logger_format_for_consoles(
    const std::shared_ptr<spdlog::logger>& logger) {
    logger->set_pattern("[%Y-%m-%d %H:%M:%S.%f] [%^%l%$] %v (%s:%#, %!)");
}

inline void configure_spdlog_logger_format_for_files(
    const std::shared_ptr<spdlog::logger>& logger) {
    logger->set_pattern("[%Y-%m-%d %H:%M:%S.%f] [%l] %v (%@, %!)");
}
 
}  // namespace msgpack_rpc::logging::impl::spdlog_backend