Kea  2.3.8
db_log.h
Go to the documentation of this file.
1 // Copyright (C) 2018-2023 Internet Systems Consortium, Inc. ("ISC")
2 //
3 // This Source Code Form is subject to the terms of the Mozilla Public
4 // License, v. 2.0. If a copy of the MPL was not distributed with this
5 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
6 
7 #ifndef DB_LOG_H
8 #define DB_LOG_H
9 
10 #include <log/macros.h>
11 
12 #include <map>
13 #include <mutex>
14 #include <list>
15 
26 
27 namespace isc {
28 namespace db {
29 
36 
41 extern const int DB_DBG_TRACE_DETAIL;
42 
44 
47 
53 
62 
67 };
69 
72 class DbLogger {
73 public:
75  typedef std::map<DbMessageID, isc::log::MessageID> MessageMap;
76 
82  : logger_(logger), map_(map) {
83  }
84 
90  const isc::log::MessageID& translateMessage(const DbMessageID& id) const;
91 
94 
96  const MessageMap& map_;
97 };
98 
100 typedef std::list<DbLogger> DbLoggerStack;
101 
104 
106 extern std::mutex db_logger_mutex;
107 
111 void checkDbLoggerStack();
112 
120 };
121 
123 template <log_type_t log_type>
124 struct DB_LOG {
127  DB_LOG(DbMessageID const message_id, int const debug_level = 0) {
128  std::lock_guard<std::mutex> lock(isc::db::db_logger_mutex);
130  if (isEnabled()) {
131  formatter_ = formatter(message_id, debug_level);
132  }
133  }
134 
141  template <typename T, typename... Args>
142  DB_LOG& arg(T first, Args... args) {
143  formatter_.arg(first);
144  return arg(args...);
145  }
146 
152  DB_LOG& arg() {
153  return *this;
154  }
155 
156 private:
164  formatter(DbMessageID const message_id, int const debug_level = 0);
165 
171  bool isEnabled(int const debug_level = 0) const;
172 
174  isc::log::Logger::Formatter formatter_;
175 };
176 
179 struct DB_LOG_FATAL : DB_LOG<fatal> {
180  DB_LOG_FATAL(DbMessageID const message_id) : DB_LOG(message_id) {
181  }
182 };
183 
184 struct DB_LOG_ERROR : DB_LOG<error> {
185  DB_LOG_ERROR(DbMessageID const message_id) : DB_LOG(message_id) {
186  }
187 };
188 
189 struct DB_LOG_WARN : DB_LOG<warn> {
190  DB_LOG_WARN(DbMessageID const message_id) : DB_LOG(message_id) {
191  }
192 };
193 
194 struct DB_LOG_INFO : DB_LOG<info> {
195  DB_LOG_INFO(DbMessageID const message_id) : DB_LOG(message_id) {
196  }
197 };
198 
199 struct DB_LOG_DEBUG : DB_LOG<debug> {
200  DB_LOG_DEBUG(int const debug_level, DbMessageID const message_id)
201  : DB_LOG(message_id, debug_level) {
202  }
203 };
205 
208 
211 
212 } // namespace db
213 } // namespace isc
214 
215 #endif // DB_LOG_H
Database logger class.
Definition: db_log.h:72
DbLogger(isc::log::Logger &logger, const MessageMap &map)
Constructor.
Definition: db_log.h:81
const MessageMap & map_
The translation map.
Definition: db_log.h:96
const isc::log::MessageID & translateMessage(const DbMessageID &id) const
Translate message.
Definition: db_log.cc:51
std::map< DbMessageID, isc::log::MessageID > MessageMap
Translation map type.
Definition: db_log.h:75
isc::log::Logger & logger_
The logger.
Definition: db_log.h:93
The log message formatter.
Formatter & arg(const Arg &value)
Replaces another placeholder.
Logger Class.
Definition: log/logger.h:142
isc::log::Logger logger("asiodns")
Use the ASIO logger.
const int DB_DBG_TRACE_DETAIL
Database logging levels.
Definition: db_log.cc:21
isc::log::Logger database_logger("database")
Common database library logger.
Definition: db_log.h:46
std::list< DbLogger > DbLoggerStack
Database logger stack.
Definition: db_log.h:100
DbMessageID
Database messages.
Definition: db_log.h:51
@ DB_INVALID_ACCESS
Definition: db_log.h:52
@ MYSQL_START_TRANSACTION
Definition: db_log.h:64
@ PGSQL_ROLLBACK_SAVEPOINT
Definition: db_log.h:60
@ PGSQL_CREATE_SAVEPOINT
Definition: db_log.h:59
@ PGSQL_ROLLBACK
Definition: db_log.h:58
@ PGSQL_TCP_USER_TIMEOUT_UNSUPPORTED
Definition: db_log.h:61
@ PGSQL_COMMIT
Definition: db_log.h:57
@ PGSQL_START_TRANSACTION
Definition: db_log.h:56
@ PGSQL_FATAL_ERROR
Definition: db_log.h:55
@ MYSQL_ROLLBACK
Definition: db_log.h:66
@ PGSQL_DEALLOC_ERROR
Definition: db_log.h:54
@ MYSQL_FATAL_ERROR
Definition: db_log.h:63
@ MYSQL_COMMIT
Definition: db_log.h:65
DbLoggerStack db_logger_stack
Global database logger stack (initialized to database logger)
Definition: db_log.cc:46
log_type_t
log type enumerations for use in DB_LOG specializations
Definition: db_log.h:114
@ fatal
Definition: db_log.h:115
@ info
Definition: db_log.h:118
@ debug
Definition: db_log.h:119
@ error
Definition: db_log.h:116
@ warn
Definition: db_log.h:117
std::mutex db_logger_mutex
Global mutex to protect logger stack.
Definition: db_log.cc:48
void checkDbLoggerStack()
Check database logger stack.
Definition: db_log.cc:59
const DbLogger::MessageMap db_message_map
Map of translated messages.
Definition: db_log.cc:24
DbLogger db_logger_translator(database_logger, db_message_map)
Database logger translator.
Definition: db_log.h:210
const char * MessageID
Definition: message_types.h:15
Defines the logger used by the top-level component of kea-lfc.
DB_LOG_DEBUG(int const debug_level, DbMessageID const message_id)
Definition: db_log.h:200
DB_LOG_ERROR(DbMessageID const message_id)
Definition: db_log.h:185
all DB_LOG specializations
Definition: db_log.h:179
DB_LOG_FATAL(DbMessageID const message_id)
Definition: db_log.h:180
DB_LOG_INFO(DbMessageID const message_id)
Definition: db_log.h:195
DB_LOG_WARN(DbMessageID const message_id)
Definition: db_log.h:190
DB_LOG_* logic.
Definition: db_log.h:124
DB_LOG & arg(T first, Args... args)
Pass parameters to replace logger placeholders.
Definition: db_log.h:142
DB_LOG & arg()
The last invocation of the arg() which is without parameters.
Definition: db_log.h:152
DB_LOG(DbMessageID const message_id, int const debug_level=0)
To preserve the old way of logging, this constructor facilitates initiating the DB_LOG_* chain call.
Definition: db_log.h:127