Kea 3.3.1
db_log.cc
Go to the documentation of this file.
1// Copyright (C) 2018-2026 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
8
9#include <config.h>
10
12#include <database/db_log.h>
14
15using namespace isc::log;
16
17namespace isc {
18namespace db {
19
22
51
53
55
57
58std::mutex db_logger_mutex;
59
60const MessageID&
62 try {
63 return (map_.at(id));
64 } catch (const std::out_of_range&) {
65 isc_throw(isc::Unexpected, "can't map message: " << id);
66 }
67}
68
70 if (db_logger_stack.empty()) {
71 isc_throw(isc::Unexpected, "database logger stack is empty");
72 }
73}
74
75template <>
77DB_LOG<fatal>::formatter(DbMessageID const message_id,
78 int const /* debug_level = 0 */) {
79 return isc::db::db_logger_stack.back().logger_.fatal(
80 isc::db::db_logger_stack.back().translateMessage(message_id));
81}
82
83template <>
85DB_LOG<error>::formatter(DbMessageID const message_id,
86 int const /* debug_level = 0 */) {
87 return isc::db::db_logger_stack.back().logger_.error(
88 isc::db::db_logger_stack.back().translateMessage(message_id));
89}
90
91template <>
93DB_LOG<warn>::formatter(DbMessageID const message_id,
94 int const /* debug_level = 0 */) {
95 return isc::db::db_logger_stack.back().logger_.warn(
96 isc::db::db_logger_stack.back().translateMessage(message_id));
97}
98
99template <>
101DB_LOG<info>::formatter(DbMessageID const message_id,
102 int const /* debug_level = 0 */) {
103 return isc::db::db_logger_stack.back().logger_.info(
104 isc::db::db_logger_stack.back().translateMessage(message_id));
105}
106
107template <>
109DB_LOG<debug>::formatter(DbMessageID const message_id,
110 int const debug_level /* = 0 */) {
111 return isc::db::db_logger_stack.back().logger_.debug(
112 debug_level,
113 isc::db::db_logger_stack.back().translateMessage(message_id));
114}
115
116template <>
117bool
118DB_LOG<fatal>::isEnabled(int const /* debug_level = 0 */) const {
119 return db_logger_stack.back().logger_.isFatalEnabled();
120}
121
122template <>
123bool
124DB_LOG<error>::isEnabled(int const /* debug_level = 0 */) const {
125 return db_logger_stack.back().logger_.isErrorEnabled();
126}
127
128template <>
129bool
130DB_LOG<warn>::isEnabled(int const /* debug_level = 0 */) const {
131 return db_logger_stack.back().logger_.isWarnEnabled();
132}
133
134template <>
135bool
136DB_LOG<info>::isEnabled(int const /* debug_level = 0 */) const {
137 return db_logger_stack.back().logger_.isInfoEnabled();
138}
139
140template <>
141bool
142DB_LOG<debug>::isEnabled(int const debug_level /* = 0 */) const {
143 return db_logger_stack.back().logger_.isDebugEnabled(debug_level);
144}
145
146} // namespace db
147} // namespace isc
A generic exception that is thrown when an unexpected error condition occurs.
const MessageMap & map_
The translation map.
Definition db_log.h:106
const isc::log::MessageID & translateMessage(const DbMessageID &id) const
Translate message.
Definition db_log.cc:61
std::map< DbMessageID, isc::log::MessageID > MessageMap
Translation map type.
Definition db_log.h:85
Logger Class.
Definition log/logger.h:142
isc::log::Formatter< Logger > Formatter
The formatter used to replace placeholders.
Definition log/logger.h:194
We want to reuse the database backend connection and exchange code for other uses,...
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
const isc::log::MessageID DATABASE_MYSQL_INITIAL_CONNECTION_FAIL
Definition db_messages.h:16
const int DB_DBG_TRACE_DETAIL
Database logging levels.
Definition db_log.cc:21
const isc::log::MessageID DATABASE_PGSQL_FATAL_ERROR
Definition db_messages.h:25
isc::log::Logger database_logger("database")
Common database library logger.
Definition db_log.h:46
const isc::log::MessageID DATABASE_MYSQL_COMMIT
Definition db_messages.h:13
std::list< DbLogger > DbLoggerStack
Database logger stack.
Definition db_log.h:110
const isc::log::MessageID DATABASE_MYSQL_INITIALIZE_SCHEMA
Definition db_messages.h:15
const isc::log::MessageID DATABASE_PGSQL_INITIAL_CONNECTION_FAIL
Definition db_messages.h:27
const isc::log::MessageID DATABASE_PGSQL_INITIALIZE_SCHEMA
Definition db_messages.h:26
DbMessageID
Database messages.
Definition db_log.h:51
@ DB_INVALID_ACCESS
Definition db_log.h:52
@ MYSQL_START_TRANSACTION
Definition db_log.h:74
@ MYSQL_NO_INIT_NO_ADMIN
Definition db_log.h:70
@ PGSQL_NO_INIT_NO_PASSWORD
Definition db_log.h:57
@ PGSQL_ROLLBACK_SAVEPOINT
Definition db_log.h:65
@ PGSQL_CREATE_SAVEPOINT
Definition db_log.h:64
@ PGSQL_ROLLBACK
Definition db_log.h:63
@ MYSQL_INITIALIZE_SCHEMA
Definition db_log.h:69
@ PGSQL_TCP_USER_TIMEOUT_UNSUPPORTED
Definition db_log.h:66
@ PGSQL_COMMIT
Definition db_log.h:62
@ PGSQL_NO_INIT_NO_ADMIN
Definition db_log.h:56
@ PGSQL_START_TRANSACTION
Definition db_log.h:61
@ MYSQL_NO_INIT_NO_PASSWORD
Definition db_log.h:71
@ MYSQL_INITIAL_CONNECTION_FAIL
Definition db_log.h:68
@ PGSQL_FATAL_ERROR
Definition db_log.h:60
@ MYSQL_ROLLBACK
Definition db_log.h:76
@ PGSQL_NO_INIT_READONLY
Definition db_log.h:58
@ PGSQL_INITIALIZE_SCHEMA
Definition db_log.h:55
@ MYSQL_NO_INIT_READONLY
Definition db_log.h:72
@ PGSQL_DEALLOC_ERROR
Definition db_log.h:59
@ MYSQL_FATAL_ERROR
Definition db_log.h:73
@ PGSQL_INITIAL_CONNECTION_FAIL
Definition db_log.h:54
@ MYSQL_COMMIT
Definition db_log.h:75
const isc::log::MessageID DATABASE_PGSQL_COMMIT
Definition db_messages.h:22
DbLoggerStack db_logger_stack
Global database logger stack (initialized to database logger).
Definition db_log.cc:56
const isc::log::MessageID DATABASE_MYSQL_NO_INIT_READONLY
Definition db_messages.h:19
const isc::log::MessageID DATABASE_PGSQL_CREATE_SAVEPOINT
Definition db_messages.h:23
const isc::log::MessageID DATABASE_INVALID_ACCESS
Definition db_messages.h:12
const isc::log::MessageID DATABASE_MYSQL_NO_INIT_NO_PASSWORD
Definition db_messages.h:18
const isc::log::MessageID DATABASE_PGSQL_ROLLBACK_SAVEPOINT
Definition db_messages.h:32
const isc::log::MessageID DATABASE_MYSQL_NO_INIT_NO_ADMIN
Definition db_messages.h:17
const isc::log::MessageID DATABASE_MYSQL_ROLLBACK
Definition db_messages.h:20
std::mutex db_logger_mutex
Global mutex to protect logger stack.
Definition db_log.cc:58
void checkDbLoggerStack()
Check database logger stack.
Definition db_log.cc:69
const isc::log::MessageID DATABASE_PGSQL_DEALLOC_ERROR
Definition db_messages.h:24
const DbLogger::MessageMap db_message_map
Map of translated messages.
Definition db_log.cc:24
const isc::log::MessageID DATABASE_PGSQL_NO_INIT_READONLY
Definition db_messages.h:30
DbLogger db_logger_translator(database_logger, db_message_map)
Database logger translator.
Definition db_log.h:220
const isc::log::MessageID DATABASE_PGSQL_START_TRANSACTION
Definition db_messages.h:33
const isc::log::MessageID DATABASE_PGSQL_NO_INIT_NO_ADMIN
Definition db_messages.h:28
const isc::log::MessageID DATABASE_PGSQL_TCP_USER_TIMEOUT_UNSUPPORTED
Definition db_messages.h:34
const isc::log::MessageID DATABASE_PGSQL_ROLLBACK
Definition db_messages.h:31
const isc::log::MessageID DATABASE_MYSQL_FATAL_ERROR
Definition db_messages.h:14
const isc::log::MessageID DATABASE_PGSQL_NO_INIT_NO_PASSWORD
Definition db_messages.h:29
const isc::log::MessageID DATABASE_MYSQL_START_TRANSACTION
Definition db_messages.h:21
const char * MessageID
const int DBGLVL_TRACE_DETAIL
Trace detailed operations.
Defines the logger used by the top-level component of kea-lfc.