LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
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::class_<Log> cls(mod, "Log");
55 
56  /* Constructors */
57  cls.def(py::init<>());
58 
59  /* Members */
60  cls.attr("TRACE") = py::int_(5000);
61  cls.attr("DEBUG") = py::int_(10000);
62  cls.attr("INFO") = py::int_(20000);
63  cls.attr("WARN") = py::int_(30000);
64  cls.attr("ERROR") = py::int_(40000);
65  cls.attr("FATAL") = py::int_(50000);
66 
67  cls.def("isDebugEnabled", &Log::isDebugEnabled);
68  cls.def("isErrorEnabled", &Log::isErrorEnabled);
69  cls.def("isFatalEnabled", &Log::isFatalEnabled);
70  cls.def("isInfoEnabled", &Log::isInfoEnabled);
71  cls.def("isTraceEnabled", &Log::isTraceEnabled);
72  cls.def("isWarnEnabled", &Log::isWarnEnabled);
73  cls.def("getName", &Log::getName);
74  cls.def("setLevel", &Log::setLevel);
75  cls.def("getLevel", &Log::getLevel);
76  cls.def("getEffectiveLevel", &Log::getEffectiveLevel);
77  cls.def("isEnabledFor", &Log::isEnabledFor);
78  cls.def("getChild", &Log::getChild);
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("configure", (void (*)())Log::configure);
88  cls.def_static("configure", (void (*)(std::string const&))Log::configure);
89  cls.def_static("configure_prop", Log::configure_prop);
90  cls.def_static("getLogger", (Log(*)(Log const&))Log::getLogger);
91  cls.def_static("getLogger", (Log(*)(std::string const&))Log::getLogger);
92  cls.def_static("MDC", Log::MDC);
93  cls.def_static("MDCRemove", Log::MDCRemove);
94  cls.def_static("MDCRegisterInit", [](py::function func) {
95  auto handle = func.release(); // will leak as described in callable_wrapper
96  Log::MDCRegisterInit(std::function<void()>(callable_wrapper(handle.ptr())));
97  });
98 }
99 
100 } // log
101 } // lsst
LSST DM logging module built on log4cxx.
T c_str(T... args)
This static class includes a variety of methods for interacting with the the logging module.
Definition: Log.h:724
bool isErrorEnabled() const
Check whether the logger is enabled for the ERROR Level.
Definition: Log.h:739
static Log getDefaultLogger()
Return default logger instance, same as default constructor.
Definition: Log.h:766
static Log getLogger(Log const &logger)
Definition: Log.h:772
static void MDCRemove(std::string const &key)
Remove the value associated with KEY within the MDC.
Definition: Log.cc:288
int getLevel() const
Retrieve the logging threshold.
Definition: Log.cc:318
bool isEnabledFor(int level) const
Return whether the logging threshold of the logger is less than or equal to LEVEL.
Definition: Log.cc:345
bool isTraceEnabled() const
Check whether the logger is enabled for the TRACE Level.
Definition: Log.h:751
Log getChild(std::string const &suffix) const
Return a logger which is a descendant to this logger.
Definition: Log.cc:366
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:220
bool isInfoEnabled() const
Check whether the logger is enabled for the INFO Level.
Definition: Log.h:747
void setLevel(int level)
Set the logging threshold to LEVEL.
Definition: Log.cc:311
bool isWarnEnabled() const
Check whether the logger is enabled for the WARN Level.
Definition: Log.h:755
bool isDebugEnabled() const
Check whether the logger is enabled for the DEBUG Level.
Definition: Log.h:735
bool isFatalEnabled() const
Check whether the logger is enabled for the FATAL Level.
Definition: Log.h:743
static void configure()
Explicitly configures log4cxx and initializes logging system.
Definition: Log.cc:177
static std::string 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:274
static int MDCRegisterInit(std::function< void()> function)
Definition: Log.cc:292
std::string getName() const
Get the logger name associated with the Log object.
Definition: Log.cc:240
int getEffectiveLevel() const
Retrieve the effective logging threshold.
Definition: Log.cc:330
callable_wrapper(PyObject *callable)
Definition: log.cc:41
PYBIND11_MODULE(log, mod)
Definition: log.cc:53
unsigned lwpID()
Function which returns LWP ID on platforms which support it.
Definition: Log.cc:425
A base class for image defects.