Logger.cpp

Go to the documentation of this file.

/*
 * SNode.C - A Slim Toolkit for Network Communication
 * Copyright (C) Volker Christian <me@vchrist.at>
 *               2020, 2021, 2022, 2023, 2024, 2025, 2026
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
/*
 * MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include "log/Logger.h"
 
#include <string>
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
INITIALIZE_EASYLOGGINGPP
 
namespace logger {
 
    void Logger::init() {
        el::Configurations conf = *el::Loggers::defaultConfigurations();
 
        conf.setGlobally(el::ConfigurationType::Enabled, "true");
        conf.setGlobally(el::ConfigurationType::Format, "%datetime{%Y-%M-%d %H:%m:%s} %tick %level %msg");
        conf.setGlobally(el::ConfigurationType::ToFile, "false");
        conf.setGlobally(el::ConfigurationType::ToStandardOutput, "true");
        conf.setGlobally(el::ConfigurationType::SubsecondPrecision, "2");
        conf.setGlobally(el::ConfigurationType::PerformanceTracking, "false");
        conf.setGlobally(el::ConfigurationType::MaxLogFileSize, "2097152");
        conf.setGlobally(el::ConfigurationType::LogFlushThreshold, "0");
        conf.set(el::Level::Verbose, el::ConfigurationType::Format, "%datetime{%Y-%M-%d %H:%m:%s} %tick %msg");
 
        el::Loggers::addFlag(el::LoggingFlag::DisableApplicationAbortOnFatalLog);
        el::Loggers::addFlag(el::LoggingFlag::DisablePerformanceTrackingCheckpointComparison);
        el::Loggers::addFlag(el::LoggingFlag::ColoredTerminalOutput);
        el::Loggers::removeFlag(el::LoggingFlag::AllowVerboseIfModuleNotSpecified);
 
        el::Loggers::setDefaultConfigurations(conf, true);
 
        setDisableColor(::isatty(::fileno(stdout)) == 0);
 
        setVerboseLevel(0);
        setLogLevel(0);
    }
 
    void Logger::setCustomFormatSpec(const char* format, const el::FormatSpecifierValueResolver& resolver) {
        el::Helpers::installCustomFormatSpecifier(el::CustomFormatSpecifier(format, resolver));
    }
 
    void Logger::setDisableColor(bool disableColorLog) {
        if (disableColorLog) {
            el::Loggers::removeFlag(el::LoggingFlag::ColoredTerminalOutput);
        } else {
            el::Loggers::addFlag(el::LoggingFlag::ColoredTerminalOutput);
        }
 
        Logger::disableColorLog = disableColorLog;
    }
 
    bool Logger::getDisableColor() {
        return disableColorLog;
    }
 
    // Application logging should be done with VLOG(loglevel)
    // Framework logging should use one of the following levels
    void Logger::setLogLevel(int level) {
        el::Configurations conf = *el::Loggers::defaultConfigurations();
 
        conf.set(el::Level::Trace, el::ConfigurationType::Enabled, "false");   // trace method/function calling
        conf.set(el::Level::Debug, el::ConfigurationType::Enabled, "false");   // typical assert messages - but we can go on
        conf.set(el::Level::Info, el::ConfigurationType::Enabled, "false");    // additional infos - what 's going on
        conf.set(el::Level::Warning, el::ConfigurationType::Enabled, "false"); // not that serious but mentioning
        conf.set(el::Level::Error, el::ConfigurationType::Enabled, "false");   // serious errors - but we can go on
        conf.set(el::Level::Fatal, el::ConfigurationType::Enabled, "false");   // asserts - stop - we can not go on
 
        switch (level) {
            case 6:
                conf.set(el::Level::Trace, el::ConfigurationType::Enabled, "true");
                [[fallthrough]];
            case 5:
                conf.set(el::Level::Debug, el::ConfigurationType::Enabled, "true");
                [[fallthrough]];
            case 4:
                conf.set(el::Level::Info, el::ConfigurationType::Enabled, "true");
                [[fallthrough]];
            case 3:
                conf.set(el::Level::Warning, el::ConfigurationType::Enabled, "true");
                [[fallthrough]];
            case 2:
                conf.set(el::Level::Error, el::ConfigurationType::Enabled, "true");
                [[fallthrough]];
            case 1:
                conf.set(el::Level::Fatal, el::ConfigurationType::Enabled, "true");
                [[fallthrough]];
            case 0:
                [[fallthrough]];
            default:;
        }
 
        el::Loggers::setDefaultConfigurations(conf, true);
    }
 
    void Logger::setVerboseLevel(int level) {
        if (level >= 0) {
            el::Loggers::setVerboseLevel(static_cast<el::base::type::VerboseLevel>(level));
        }
    }
 
    void Logger::logToFile(const std::string& logFile) {
        el::Configurations conf = *el::Loggers::defaultConfigurations();
 
        conf.setGlobally(el::ConfigurationType::Filename, logFile);
        conf.setGlobally(el::ConfigurationType::ToFile, "true");
 
        el::Loggers::setDefaultConfigurations(conf, true);
    }
 
    void Logger::setQuiet(bool quiet) {
        el::Configurations conf = *el::Loggers::defaultConfigurations();
 
        conf.setGlobally(el::ConfigurationType::ToStandardOutput, quiet ? "false" : "true");
 
        el::Loggers::setDefaultConfigurations(conf, true);
    }
 
    bool Logger::disableColorLog = false;
 
} // namespace logger
 
std::ostream& Color::operator<<(std::ostream& os, const Code& code) {
    return os << (!logger::Logger::disableColorLog ? ("\033[" + std::to_string(static_cast<int>(code)) + "m") : "");
}
 
std::string Color::operator+(const std::string& string, const Code& code) {
    return string + (!logger::Logger::disableColorLog ? ("\033[" + std::to_string(static_cast<int>(code)) + "m") : "");
}
 
std::string Color::operator+(const Code& code, const std::string& string) {
    return (!logger::Logger::disableColorLog ? ("\033[" + std::to_string(static_cast<int>(code)) + "m") : "") + string;
}