src/Utilities/Logger.cpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2016-2018 CERN for the benefit of the Acts project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
0008
0009 #include "Acts/Utilities/Logger.hpp"
0010
0011 #include <algorithm>
0012 #include <cstdlib>
0013
0014 namespace Acts {
0015
0016 namespace Logging {
0017
0018 #if defined(ACTS_ENABLE_LOG_FAILURE_THRESHOLD) and \
0019     not defined(ACTS_LOG_FAILURE_THRESHOLD)
0020 namespace {
0021 Level& getFailureThresholdMutable() {
0022   static Level _level = []() {
0023     Level level = Level::MAX;
0024
0025     const char* envvar = std::getenv("ACTS_LOG_FAILURE_THRESHOLD");
0026     if (envvar == nullptr) {
0027       return level;
0028     }
0029     std::string slevel = envvar;
0030     if (slevel == "VERBOSE") {
0031       level = std::min(level, Level::VERBOSE);
0032     } else if (slevel == "DEBUG") {
0033       level = std::min(level, Level::DEBUG);
0034     } else if (slevel == "INFO") {
0035       level = std::min(level, Level::INFO);
0036     } else if (slevel == "WARNING") {
0037       level = std::min(level, Level::WARNING);
0038     } else if (slevel == "ERROR") {
0039       level = std::min(level, Level::ERROR);
0040     } else if (slevel == "FATAL") {
0041       level = std::min(level, Level::FATAL);
0042     } else {
0043       std::cerr << "ACTS_LOG_FAILURE_THRESHOLD environment variable is set to "
0044                    "unknown value: "
0045                 << slevel << std::endl;
0046     }
0047     return level;
0048   }();
0049
0050   return _level;
0051 }
0052 }  // namespace
0053
0054 Level getFailureThreshold() {
0055   return getFailureThresholdMutable();
0056 }
0057
0058 void setFailureThreshold(Level level) {
0059   getFailureThresholdMutable() = level;
0060 }
0061
0062 #else
0063
0064 void setFailureThreshold(Level /*lvl*/) {
0065   throw std::logic_error{
0066       "Compile-time log failure threshold defined (ACTS_LOG_FAILURE_THRESHOLD "
0067       "is set or ACTS_ENABLE_LOG_FAILURE_THRESHOLD is OFF), unable to "
0068       "override. See "
0069       "https://acts.readthedocs.io/en/latest/core/misc/"
0070       "logging.html#logging-thresholds"};
0071 }
0072
0073 #endif
0074
0075 namespace {
0076 class NeverFilterPolicy final : public OutputFilterPolicy {
0077  public:
0078   ~NeverFilterPolicy() override = default;
0079
0080   bool doPrint(const Level& /*lvl*/) const override { return false; }
0081
0082   Level level() const override { return Level::MAX; }
0083
0084   std::unique_ptr<OutputFilterPolicy> clone(Level /*level*/) const override {
0085     return std::make_unique<NeverFilterPolicy>();
0086   }
0087 };
0088
0089 std::unique_ptr<const Logger> makeDummyLogger() {
0090   using namespace Logging;
0091   auto output = std::make_unique<DefaultPrintPolicy>(&std::cout);
0092   auto print = std::make_unique<NeverFilterPolicy>();
0093   return std::make_unique<const Logger>(std::move(output), std::move(print));
0094 }
0095
0096 }  // namespace
0097 }  // namespace Logging
0098
0099 std::unique_ptr<const Logger> getDefaultLogger(const std::string& name,
0100                                                const Logging::Level& lvl,
0101                                                std::ostream* log_stream) {
0102   using namespace Logging;
0103   auto output = std::make_unique<LevelOutputDecorator>(
0104       std::make_unique<NamedOutputDecorator>(
0105           std::make_unique<TimedOutputDecorator>(
0106               std::make_unique<DefaultPrintPolicy>(log_stream)),
0107           name));
0108   auto print = std::make_unique<DefaultFilterPolicy>(lvl);
0109   return std::make_unique<const Logger>(std::move(output), std::move(print));
0110 }
0111
0112 const Logger& getDummyLogger() {
0113   static const std::unique_ptr<const Logger> logger =
0114       Logging::makeDummyLogger();
0115
0116   return *logger;
0117 }
0118 }  // namespace Acts