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
|
/**
* 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_LOG_H_)
#error \
"mongo/util/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_LOG_H_
#define MONGO_UTIL_LOG_H_
#include "mongo/base/status.h"
#include "mongo/bson/util/builder.h"
#include "mongo/db/server_options.h"
#include "mongo/logger/log_component.h"
#include "mongo/logger/log_severity_limiter.h"
#include "mongo/logger/logger.h"
#include "mongo/logger/logstream_builder.h"
#include "mongo/logger/redaction.h"
#include "mongo/logger/tee.h"
#include "mongo/logv2/log_component.h"
#include "mongo/logv2/log_component_settings.h"
#include "mongo/logv2/log_manager.h"
#include "mongo/util/concurrency/thread_name.h"
#include "mongo/util/errno_util.h"
#include "mongo/util/log_global_settings.h"
namespace mongo {
namespace logger {
typedef void (*ExtraLogContextFn)(BufBuilder& builder);
Status registerExtraLogContextFn(ExtraLogContextFn contextFn);
} // namespace logger
/*
* Although this is a "header" file, it is only supposed to be included in C++ files. The
* definitions of the following objects and functions (in the below anonymous namespace) will
* potentially differ by TU. Therefore these names must remain with internal linkage. This
* particular anoymous namespace in this header, therefore, is not an ODR problem but is instead a
* solution to an ODR problem which would arise.
*/
namespace {
// 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_LOG_DEFAULT_COMPONENT.
#if defined(MONGO_LOG_DEFAULT_COMPONENT)
const ::mongo::logger::LogComponent MongoLogDefaultComponent_component =
MONGO_LOG_DEFAULT_COMPONENT;
#else
#error \
"mongo/util/log.h requires MONGO_LOG_DEFAULT_COMPONENT to be defined. " \
"Please see http://www.mongodb.org/about/contributors/reference/server-logging-rules/ "
#endif // MONGO_LOG_DEFAULT_COMPONENT
using logger::LogstreamBuilderDeprecated;
using logger::Tee;
/**
* Returns a LogstreamBuilder for logging a message with LogSeverity::Severe().
*/
inline LogstreamBuilderDeprecated severe() {
return LogstreamBuilderDeprecated(logger::globalLogDomain(),
getThreadName(),
logger::LogSeverity::Severe(),
MongoLogDefaultComponent_component);
}
inline LogstreamBuilderDeprecated severe(logger::LogComponent component) {
return LogstreamBuilderDeprecated(
logger::globalLogDomain(), getThreadName(), logger::LogSeverity::Severe(), component);
}
/**
* Returns a LogstreamBuilder for logging a message with LogSeverity::Error().
*/
inline LogstreamBuilderDeprecated error() {
return LogstreamBuilderDeprecated(logger::globalLogDomain(),
getThreadName(),
logger::LogSeverity::Error(),
MongoLogDefaultComponent_component);
}
inline LogstreamBuilderDeprecated error(logger::LogComponent component) {
return LogstreamBuilderDeprecated(
logger::globalLogDomain(), getThreadName(), logger::LogSeverity::Error(), component);
}
/**
* Returns a LogstreamBuilder for logging a message with LogSeverity::Warning().
*/
inline LogstreamBuilderDeprecated warning() {
return LogstreamBuilderDeprecated(logger::globalLogDomain(),
getThreadName(),
logger::LogSeverity::Warning(),
MongoLogDefaultComponent_component);
}
inline LogstreamBuilderDeprecated warning(logger::LogComponent component) {
return LogstreamBuilderDeprecated(
logger::globalLogDomain(), getThreadName(), logger::LogSeverity::Warning(), component);
}
/**
* Returns a LogstreamBuilder for logging a message with LogSeverity::Log().
*/
inline LogstreamBuilderDeprecated log() {
return LogstreamBuilderDeprecated(logger::globalLogDomain(),
getThreadName(),
logger::LogSeverity::Log(),
MongoLogDefaultComponent_component);
}
/**
* Returns a LogstreamBuilder that does not cache its ostream in a threadlocal cache.
* Use this variant when logging from places that may not be able to access threadlocals,
* such as from within other threadlocal-managed objects, or thread_specific_ptr-managed
* objects.
*
* Once SERVER-29377 is completed, this overload can be removed.
*/
inline LogstreamBuilderDeprecated logNoCache() {
return LogstreamBuilderDeprecated(logger::globalLogDomain(),
getThreadName(),
logger::LogSeverity::Log(),
MongoLogDefaultComponent_component,
false);
}
inline LogstreamBuilderDeprecated log(logger::LogComponent component) {
return LogstreamBuilderDeprecated(
logger::globalLogDomain(), getThreadName(), logger::LogSeverity::Log(), component);
}
inline LogstreamBuilderDeprecated log(logger::LogComponent::Value componentValue) {
return LogstreamBuilderDeprecated(
logger::globalLogDomain(), getThreadName(), logger::LogSeverity::Log(), componentValue);
}
} // namespace
// this can't be in log_global_settings.h because it utilizes MongoLogDefaultComponent_component
inline bool shouldLogV1(logger::LogSeverity severity) {
if (logV2Enabled())
return logv2::LogManager::global().getGlobalSettings().shouldLog(
logComponentV1toV2(MongoLogDefaultComponent_component), logSeverityV1toV2(severity));
return mongo::shouldLogV1(MongoLogDefaultComponent_component, severity);
}
// MONGO_LOG uses log component from MongoLogDefaultComponent from current or global namespace.
#define MONGO_LOG(DLEVEL) \
if (!::mongo::shouldLogV1(MongoLogDefaultComponent_component, \
::mongo::LogstreamBuilderDeprecated::severityCast(DLEVEL))) { \
} else \
::mongo::logger::LogstreamBuilderDeprecated( \
::mongo::logger::globalLogDomain(), \
::mongo::getThreadName(), \
::mongo::LogstreamBuilderDeprecated::severityCast(DLEVEL), \
MongoLogDefaultComponent_component)
#define LOG MONGO_LOG
#define MONGO_LOG_COMPONENT(DLEVEL, COMPONENT1) \
if (!::mongo::shouldLogV1((COMPONENT1), \
::mongo::LogstreamBuilderDeprecated::severityCast(DLEVEL))) { \
} else \
::mongo::logger::LogstreamBuilderDeprecated( \
::mongo::logger::globalLogDomain(), \
::mongo::getThreadName(), \
::mongo::LogstreamBuilderDeprecated::severityCast(DLEVEL), \
(COMPONENT1))
/**
* Rotates the log files. Returns true if all logs rotate successfully.
*
* renameFiles - true means we rename files, false means we expect the file to be renamed
* externally
*
* logrotate on *nix systems expects us not to rename the file, it is expected that the program
* simply open the file again with the same name.
* We expect logrotate to rename the existing file before we rotate, and so the next open
* we do should result in a file create.
*/
bool rotateLogs(bool renameFiles);
extern Tee* const warnings; // Things put here go in serverStatus
extern Tee* const startupWarningsLog; // Things put here get reported in MMS
/**
* Write the current context (backtrace), along with the optional "msg".
*/
void logContext(const char* msg = nullptr);
} // namespace mongo
#endif // MONGO_UTIL_LOG_H_
|
