lsst.log  13.0-2-g15de9a1+4
 All Classes Namespaces Files Functions Variables Macros Pages
log.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2016 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #include "pybind11/pybind11.h"
24 
25 #include "lsst/log/Log.h"
26 
27 namespace py = pybind11;
28 
29 namespace lsst {
30 namespace log {
31 
32 // Wrapper for Python callable object to make sure that we have GIL
33 // when we call Python. Note that we are leaking Python callable,
34 // as C++ callables may be (and actually are in our particular case)
35 // outliving Python interpreter and attempt to delete Python object
36 // will result in crash.
37 //
38 // See DM-9708
40 public:
41  callable_wrapper(PyObject* callable) : _callable(callable) { Py_XINCREF(_callable); }
42  void operator()() {
43  // make sure we own GIL before doing Python call
44  auto state = PyGILState_Ensure();
45  PyObject_CallObject(_callable, nullptr);
46  PyGILState_Release(state);
47  }
48 
49 private:
50  PyObject* _callable;
51 };
52 
54  py::module mod("log");
55 
56  py::class_<Log> cls(mod, "Log");
57 
58  /* Constructors */
59  cls.def(py::init<>());
60 
61  /* Members */
62  cls.attr("TRACE") = py::int_(5000);
63  cls.attr("DEBUG") = py::int_(10000);
64  cls.attr("INFO") = py::int_(20000);
65  cls.attr("WARN") = py::int_(30000);
66  cls.attr("ERROR") = py::int_(40000);
67  cls.attr("FATAL") = py::int_(50000);
68 
69  cls.def("isDebugEnabled", &Log::isDebugEnabled);
70  cls.def("isErrorEnabled", &Log::isErrorEnabled);
71  cls.def("isFatalEnabled", &Log::isFatalEnabled);
72  cls.def("isInfoEnabled", &Log::isInfoEnabled);
73  cls.def("isTraceEnabled", &Log::isTraceEnabled);
74  cls.def("isWarnEnabled", &Log::isWarnEnabled);
75  cls.def("getName", &Log::getName);
76  cls.def("setLevel", &Log::setLevel);
77  cls.def("getLevel", &Log::getLevel);
78  cls.def("isEnabledFor", &Log::isEnabledFor);
79  cls.def("logMsg", [](Log& log, int level, std::string const& filename, std::string const& funcname,
80  unsigned int lineno, std::string const& msg) {
81  log.logMsg(log4cxx::Level::toLevel(level),
82  log4cxx::spi::LocationInfo(filename.c_str(), funcname.c_str(), lineno), msg.c_str());
83  });
84  cls.def("lwpID", [](Log const& log) -> unsigned { return lsst::log::lwpID(); });
85 
86  cls.def_static("getDefaultLogger", Log::getDefaultLogger);
87  cls.def_static("getDefaultLoggerName", Log::getDefaultLoggerName);
88  cls.def_static("configure", (void (*)())Log::configure);
89  cls.def_static("configure", (void (*)(std::string const&))Log::configure);
90  cls.def_static("configure_prop", Log::configure_prop);
91  cls.def_static("getLogger", (Log(*)(Log const&))Log::getLogger);
92  cls.def_static("getLogger", (Log(*)(std::string const&))Log::getLogger);
93  cls.def_static("pushContext", Log::pushContext);
94  cls.def_static("popContext", Log::popContext);
95  cls.def_static("MDC", Log::MDC);
96  cls.def_static("MDCRemove", Log::MDCRemove);
97  cls.def_static("MDCRegisterInit", [](py::function func) {
98  auto handle = func.release(); // will leak as described in callable_wrapper
99  Log::MDCRegisterInit(std::function<void()>(callable_wrapper(handle.ptr())));
100  });
101 
102  return mod.ptr();
103 }
104 
105 } // log
106 } // lsst
static Log getDefaultLogger()
Return default logger instance, same as default constructor.
Definition: Log.h:765
bool isDebugEnabled() const
Check whether the logger is enabled for the DEBUG Level.
Definition: Log.h:737
static void configure()
Explicitly configures log4cxx and initializes logging system.
Definition: Log.cc:173
static std::string getDefaultLoggerName()
Get the current default logger name.
Definition: Log.cc:231
void logMsg(log4cxx::LevelPtr level, log4cxx::spi::LocationInfo const &location, std::string const &msg)
Method used by LOGS_INFO and similar macros to process a log message.
Definition: Log.cc:389
callable_wrapper(PyObject *callable)
Definition: log.cc:41
bool isFatalEnabled() const
Check whether the logger is enabled for the FATAL Level.
Definition: Log.h:745
This static class includes a variety of methods for interacting with the the logging module...
Definition: Log.h:723
bool isEnabledFor(int level) const
Return whether the logging threshold of the logger is less than or equal to LEVEL.
Definition: Log.cc:364
bool isErrorEnabled() const
Check whether the logger is enabled for the ERROR Level.
Definition: Log.h:741
static void MDC(std::string const &key, std::string const &value)
Places a KEY/VALUE pair in the Mapped Diagnostic Context (MDC) for the current thread.
Definition: Log.cc:311
LSST DM logging module built on log4cxx.
static void MDCRemove(std::string const &key)
Remove the value associated with KEY within the MDC.
Definition: Log.cc:319
bool isTraceEnabled() const
Check whether the logger is enabled for the TRACE Level.
Definition: Log.h:753
int getLevel() const
Retrieve the logging threshold.
Definition: Log.cc:349
void setLevel(int level)
Set the logging threshold to LEVEL.
Definition: Log.cc:342
PYBIND11_PLUGIN(log)
Definition: log.cc:53
bool isWarnEnabled() const
Check whether the logger is enabled for the WARN Level.
Definition: Log.h:757
static Log getLogger(Log const &logger)
Definition: Log.h:772
unsigned lwpID()
Function which returns LWP ID on platforms which support it.
Definition: Log.cc:414
std::string getName() const
Get the logger name associated with the Log object.
Definition: Log.cc:238
static void configure_prop(std::string const &properties)
Configures log4cxx using a string containing the list of properties, equivalent to configuring from a...
Definition: Log.cc:213
bool isInfoEnabled() const
Check whether the logger is enabled for the INFO Level.
Definition: Log.h:749
static void popContext()
Pops the last pushed name off the global hierarchical default logger name.
Definition: Log.cc:293
static void pushContext(std::string const &name)
Pushes NAME onto the global hierarchical default logger name.
Definition: Log.cc:266
static int MDCRegisterInit(std::function< void()> function)
Definition: Log.cc:323