1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
// #pragma once is not used in this header.
// This header attempts to enforce the rule that no logging should be done in
// an inline function defined in a header.
// To enforce this "no logging in header" rule, we use #include guards with a validating #else
// clause.
// Also, this header relies on a preprocessor macro to determine the default component for the
// unconditional logging functions severe(), error(), warning() and log(). Disallowing multiple
// inclusion of log.h will ensure that the default component will be set correctly.
#if defined(MONGO_UTIL_LOGV2_H_)
#error \
"mongo/logv2/log.h cannot be included multiple times. " \
"This may occur when log.h is included in a header. " \
"Please check your #include's."
#else // MONGO_UTIL_LOGV2_H_
#define MONGO_UTIL_LOGV2_H_
#include "mongo/base/status.h"
#include "mongo/bson/util/builder.h"
#include "mongo/logger/log_version_util.h"
#include "mongo/logv2/log_component.h"
#include "mongo/logv2/log_component_settings.h"
#include "mongo/logv2/log_debug.h"
#include "mongo/logv2/log_detail.h"
#include "mongo/logv2/log_domain.h"
#include "mongo/logv2/log_options.h"
#include "mongo/logv2/log_severity.h"
#include "mongo/logv2/redaction.h"
#include "mongo/util/errno_util.h"
#if defined(MONGO_LOG_DEFAULT_COMPONENT)
#include "mongo/logger/log_version_util.h"
#endif
namespace {
#if defined(MONGO_LOGV2_DEFAULT_COMPONENT)
const ::mongo::logv2::LogComponent MongoLogV2DefaultComponent_component =
MONGO_LOGV2_DEFAULT_COMPONENT;
// Provide log component in global scope so that MONGO_LOG will always have a valid component.
// Global log component will be kDefault unless overridden by MONGO_LOGV2_DEFAULT_COMPONENT.
#elif defined(MONGO_LOG_DEFAULT_COMPONENT)
const ::mongo::logv2::LogComponent MongoLogV2DefaultComponent_component =
::mongo::logComponentV1toV2(MONGO_LOG_DEFAULT_COMPONENT);
#else
#error \
"mongo/logv2/log.h requires MONGO_LOGV2_DEFAULT_COMPONENT to be defined. " \
"Please see http://www.mongodb.org/about/contributors/reference/server-logging-rules/ "
#endif // MONGO_LOGV2_DEFAULT_COMPONENT
} // namespace
// The logging macros below are documented in detail under src/mongo/logv2/README.md
namespace mongo {
// Internal helper to be able to create LogOptions with two arguments from other macros
#define MAKE_OPTIONS_ARG2(ARG0, ARG1) \
::mongo::logv2::LogOptions { \
ARG0, ARG1 \
}
// Internal helper to perform the logging where it requires the MESSAGE to be a compile time string.
#define LOGV2_IMPL(ID, SEVERITY, OPTIONS, FMTSTR_MESSAGE, ...) \
::mongo::logv2::detail::doLog(ID, SEVERITY, OPTIONS, FMT_STRING(FMTSTR_MESSAGE), ##__VA_ARGS__)
/**
* Log with default severity and component.
*
* This macro acts like a function with 4 overloads:
* LOGV2(ID, FMTSTR_MESSAGE, ATTRIBUTES...)
* LOGV2(ID, FMTSTR_MESSAGE, DYNAMIC_ATTRIBUTES)
* LOGV2(ID, FMTSTR_MESSAGE, MESSAGE, ATTRIBUTES...)
* LOGV2(ID, FMTSTR_MESSAGE, MESSAGE, DYNAMIC_ATTRIBUTES)
*
* ID is a unique signed int32 in the same number space as other error codes.
* FMTSTR_MESSAGE is a compile time string constant. Regular "string" is preferred.
* This string may contain libfmt replacement fields.
* MESSAGE is an optional compile time string constant of message without libfmt replacement fields
* ATTRIBUTES zero more more static attributes created with "name"_attr=value expressions
* DYNAMIC_ATTRIBUTES single argument DynamicAttributes object
* no attributes may be passed with "name"_attr=value when this is used
*/
#define LOGV2(ID, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Log(), \
::mongo::logv2::LogOptions{MongoLogV2DefaultComponent_component}, \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with default severity and custom options.
*
* OPTIONS is an expression that is used to construct a LogOptions.
* See LogOptions for available parameters when performing custom logging
*
* See LOGV2() for documentation of the other parameters
*/
#define LOGV2_OPTIONS(ID, OPTIONS, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Log(), \
::mongo::logv2::LogOptions::ensureValidComponent( \
OPTIONS, MongoLogV2DefaultComponent_component), \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with info severity.
*
* See LOGV2() for documentation of the parameters
*/
#define LOGV2_INFO(ID, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Info(), \
::mongo::logv2::LogOptions{MongoLogV2DefaultComponent_component}, \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with info severity and custom options.
*
* See LOGV2_OPTIONS() for documentation of the parameters
*/
#define LOGV2_INFO_OPTIONS(ID, OPTIONS, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Info(), \
::mongo::logv2::LogOptions::ensureValidComponent( \
OPTIONS, MongoLogV2DefaultComponent_component), \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with warning severity.
*
* See LOGV2() for documentation of the parameters
*/
#define LOGV2_WARNING(ID, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Warning(), \
::mongo::logv2::LogOptions{MongoLogV2DefaultComponent_component}, \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with warning severity and custom options.
*
* See LOGV2_OPTIONS() for documentation of the parameters
*/
#define LOGV2_WARNING_OPTIONS(ID, OPTIONS, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Warning(), \
::mongo::logv2::LogOptions::ensureValidComponent( \
OPTIONS, MongoLogV2DefaultComponent_component), \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with error severity.
*
* See LOGV2() for documentation of the parameters
*/
#define LOGV2_ERROR(ID, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Error(), \
::mongo::logv2::LogOptions{MongoLogV2DefaultComponent_component}, \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with error severity and custom options.
*
* See LOGV2_OPTIONS() for documentation of the parameters
*/
#define LOGV2_ERROR_OPTIONS(ID, OPTIONS, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Error(), \
::mongo::logv2::LogOptions::ensureValidComponent( \
OPTIONS, MongoLogV2DefaultComponent_component), \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with fatal severity. fassertFailed(ID) will be performed after writing the log
*
* See LOGV2() for documentation of the parameters
*/
#define LOGV2_FATAL(ID, FMTSTR_MESSAGE, ...) \
do { \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Severe(), \
::mongo::logv2::LogOptions{MongoLogV2DefaultComponent_component}, \
FMTSTR_MESSAGE, \
##__VA_ARGS__); \
fassertFailed(ID); \
} while (false)
/**
* Log with fatal severity. fassertFailedNoTrace(ID) will be performed after writing the log
*
* See LOGV2() for documentation of the parameters
*/
#define LOGV2_FATAL_NOTRACE(ID, FMTSTR_MESSAGE, ...) \
do { \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Severe(), \
MAKE_OPTIONS_ARG2(MongoLogV2DefaultComponent_component, \
::mongo::logv2::FatalMode::kAssertNoTrace), \
FMTSTR_MESSAGE, \
##__VA_ARGS__); \
fassertFailedNoTrace(ID); \
} while (false)
/**
* Log with fatal severity. Execution continues after log.
*
* See LOGV2() for documentation of the parameters
*/
#define LOGV2_FATAL_CONTINUE(ID, FMTSTR_MESSAGE, ...) \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Severe(), \
MAKE_OPTIONS_ARG2(MongoLogV2DefaultComponent_component, \
::mongo::logv2::FatalMode::kContinue), \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
/**
* Log with fatal severity and custom options.
*
* Will perform fassert after logging depending on the fatalMode() setting in OPTIONS
*
* See LOGV2_OPTIONS() for documentation of the parameters
*/
#define LOGV2_FATAL_OPTIONS(ID, OPTIONS, FMTSTR_MESSAGE, ...) \
do { \
auto optionsMacroLocal_ = ::mongo::logv2::LogOptions::ensureValidComponent( \
OPTIONS, MongoLogV2DefaultComponent_component); \
LOGV2_IMPL(ID, \
::mongo::logv2::LogSeverity::Severe(), \
optionsMacroLocal_, \
FMTSTR_MESSAGE, \
##__VA_ARGS__); \
switch (optionsMacroLocal_.fatalMode()) { \
case ::mongo::logv2::FatalMode::kAssert: \
fassertFailed(ID); \
case ::mongo::logv2::FatalMode::kAssertNoTrace: \
fassertFailedNoTrace(ID); \
case ::mongo::logv2::FatalMode::kContinue: \
break; \
}; \
} while (false)
/**
* Log with debug level severity and custom options.
*
* DLEVEL is an integer representing the debug level. Valid range is [1, 5]
*
* See LOGV2_OPTIONS() for documentation of the other parameters
*/
#define LOGV2_DEBUG_OPTIONS(ID, DLEVEL, OPTIONS, FMTSTR_MESSAGE, ...) \
do { \
auto severityMacroLocal_ = ::mongo::logv2::LogSeverity::Debug(DLEVEL); \
auto optionsMacroLocal_ = ::mongo::logv2::LogOptions::ensureValidComponent( \
OPTIONS, MongoLogV2DefaultComponent_component); \
if (::mongo::logv2::LogManager::global().getGlobalSettings().shouldLog( \
optionsMacroLocal_.component(), severityMacroLocal_)) { \
LOGV2_IMPL( \
ID, severityMacroLocal_, optionsMacroLocal_, FMTSTR_MESSAGE, ##__VA_ARGS__); \
} \
} while (false)
/**
* Log with debug level severity.
*
* DLEVEL is an integer representing the debug level. Valid range is [1, 5]
*
* See LOGV2() for documentation of the other parameters
*/
#define LOGV2_DEBUG(ID, DLEVEL, FMTSTR_MESSAGE, ...) \
LOGV2_DEBUG_OPTIONS(ID, \
DLEVEL, \
::mongo::logv2::LogOptions{MongoLogV2DefaultComponent_component}, \
FMTSTR_MESSAGE, \
##__VA_ARGS__)
inline bool shouldLog(logv2::LogSeverity severity) {
return logv2::LogManager::global().getGlobalSettings().shouldLog(
MongoLogV2DefaultComponent_component, severity);
}
inline bool shouldLog(logv2::LogComponent logComponent, logv2::LogSeverity severity) {
return logv2::LogManager::global().getGlobalSettings().shouldLog(logComponent, severity);
}
} // namespace mongo
#endif // MONGO_UTIL_LOGV2_H_
|
