lsst.log g9d27549199+9e5e24d318
PyLogAppender.h
1/*
2 * This file is part of log.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#ifndef LSST_LOG_PYLOGAPPENDER_H
25#define LSST_LOG_PYLOGAPPENDER_H
26
27// Python header has to be first to avoid compilation warnings
28#include "Python.h"
29
30#include <cstdint>
31#include <map>
32#include <mutex>
33#include <string>
34
35// Base class header
36#include "log4cxx/appenderskeleton.h"
37
38#include "log4cxx/helpers/object.h"
39#include "PyObjectPtr.h"
40
41namespace lsst::log::detail {
42
43// This needs to be here for all LOG4CXX macros to work
44using namespace log4cxx;
45
58class PyLogAppender : public AppenderSkeleton {
59public:
60
61 DECLARE_LOG4CXX_OBJECT(PyLogAppender)
62 BEGIN_LOG4CXX_CAST_MAP()
63 LOG4CXX_CAST_ENTRY(PyLogAppender)
64 LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
65 END_LOG4CXX_CAST_MAP()
66
67 // Make an instance
69
70 // we do not support copying
71 PyLogAppender(const PyLogAppender&) = delete;
72 PyLogAppender& operator=(const PyLogAppender&) = delete;
73
77 void append(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p) override;
78
82 void close() override;
83
89 bool requiresLayout() const override;
90
94 void setOption(const LogString &option, const LogString &value) override;
95
96private:
97
98 // cache entry type
99 struct LRUEntry {
100 PyObjectPtr logger;
101 uint32_t age = 0;
102 };
103
104 using LRUCache = std::map<std::string, LRUEntry>;
105
106 PyObjectPtr _getLogger; // logging.getLogger() method
107 PyObjectPtr _mdc_class; // lsst.log.MDCDict class
108 std::mutex _cache_mutex;
109 uint32_t _lru_age = 0;
110 LRUCache _cache; // LRU cache for loggers
111};
112
113} // namespace lsst::log::detail
114
115#endif // LSST_LOG_PYLOGAPPENDER_H
Definition: PyLogAppender.h:58
void close() override
Definition: PyLogAppender.cc:247
void append(const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) override
Definition: PyLogAppender.cc:100
void setOption(const LogString &option, const LogString &value) override
Definition: PyLogAppender.cc:254
bool requiresLayout() const override
Definition: PyLogAppender.cc:250
Definition: PyObjectPtr.h:37