LSST Applications g0aad566f14+98bdd3b178,g0dd44d6229+e0c2448475,g2079a07aa2+86d27d4dc4,g2305ad1205+28192cebb5,g2bbee38e9b+047b288a59,g337abbeb29+047b288a59,g33d1c0ed96+047b288a59,g3a166c0a6a+047b288a59,g3d1719c13e+98bdd3b178,g487adcacf7+08349b74a1,g4be5004598+98bdd3b178,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+742623b69a,g63cd9335cc+585e252eca,g858d7b2824+98bdd3b178,g88963caddf+0cb8e002cc,g88c60e1ba4+10d1129650,g99cad8db69+26979ce5a5,g9ddcbc5298+9a081db1e4,ga1e77700b3+a912195c07,gae0086650b+585e252eca,gb0e22166c9+60f28cb32d,gb1fda7adca+90d62c6f66,gb3a676b8dc+b4feba26a1,gb4b16eec92+950562e714,gba4ed39666+c2a2e4ac27,gbb8dafda3b+2fe9a6a885,gc120e1dc64+0553034b2f,gc28159a63d+047b288a59,gc3e9b769f7+f8a3f20ab6,gcf0d15dbbd+e0c2448475,gdaeeff99f8+f9a426f77a,gdb0af172c8+f61b8374e1,ge79ae78c31+047b288a59,w.2024.20
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
27namespace py = pybind11;
28
29namespace lsst {
30namespace 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
39
41public:
42 explicit callable_wrapper(PyObject* callable) : _callable(callable) { Py_XINCREF(_callable); }
43 void operator()() {
44 // make sure we own GIL before doing Python call
45 auto state = PyGILState_Ensure();
46 PyObject_CallObject(_callable, nullptr);
47 PyGILState_Release(state);
48 }
49
50private:
51 PyObject* _callable;
52};
53
54PYBIND11_MODULE(log, mod) {
55 py::class_<Log> cls(mod, "Log");
56
57 /* Constructors */
58 cls.def(py::init<>());
59
60 /* Members */
61 cls.attr("TRACE") = py::int_(5000);
62 cls.attr("DEBUG") = py::int_(10000);
63 cls.attr("INFO") = py::int_(20000);
64 cls.attr("WARN") = py::int_(30000);
65 cls.attr("ERROR") = py::int_(40000);
66 cls.attr("FATAL") = py::int_(50000);
67
68 cls.def("isDebugEnabled", &Log::isDebugEnabled);
69 cls.def("isErrorEnabled", &Log::isErrorEnabled);
70 cls.def("isFatalEnabled", &Log::isFatalEnabled);
71 cls.def("isInfoEnabled", &Log::isInfoEnabled);
72 cls.def("isTraceEnabled", &Log::isTraceEnabled);
73 cls.def("isWarnEnabled", &Log::isWarnEnabled);
74 cls.def("getName", &Log::getName);
75 cls.def("setLevel", &Log::setLevel);
76 cls.def("getLevel", &Log::getLevel);
77 cls.def("getEffectiveLevel", &Log::getEffectiveLevel);
78 cls.def("isEnabledFor", &Log::isEnabledFor);
79 cls.def("getChild", &Log::getChild);
80 cls.def("logMsg", [](Log &log, int level, std::string const &filename, std::string const &funcname,
81 unsigned int lineno, std::string const &msg) {
82 log.logMsg(log4cxx::Level::toLevel(level),
83 log4cxx::spi::LocationInfo(filename.c_str(), log4cxx::spi::LocationInfo::calcShortFileName(filename.c_str()), funcname.c_str(), lineno),
84 msg);
85 });
86 cls.def("lwpID", [](Log const& log) -> unsigned { return lsst::log::lwpID(); });
87
88 cls.def_static("getDefaultLogger", Log::getDefaultLogger);
89 cls.def_static("configure", (void (*)())Log::configure);
90 cls.def_static("configure", (void (*)(std::string const&))Log::configure);
91 cls.def_static("configure_prop", Log::configure_prop);
92 cls.def_static("getLogger", (Log(*)(Log const&))Log::getLogger);
93 cls.def_static("getLogger", (Log(*)(std::string const&))Log::getLogger);
94 cls.def_static("MDC", Log::MDC);
95 cls.def_static("MDCRemove", Log::MDCRemove);
96 cls.def_static("MDCRegisterInit", [](py::function func) {
97 auto handle = func.release(); // will leak as described in callable_wrapper
99 });
100}
101
102} // log
103} // 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:42
PYBIND11_MODULE(log, mod)
Definition log.cc:54
unsigned lwpID()
Function which returns LWP ID on platforms which support it.
Definition Log.cc:425