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
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/ftdc/ftdc_server.h"
#include <boost/filesystem.hpp>
#include <fstream>
#include <memory>
#include "mongo/base/status.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/commands.h"
#include "mongo/db/ftdc/collector.h"
#include "mongo/db/ftdc/config.h"
#include "mongo/db/ftdc/controller.h"
#include "mongo/db/ftdc/ftdc_server_gen.h"
#include "mongo/db/ftdc/ftdc_system_stats.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/mirror_maestro.h"
#include "mongo/db/service_context.h"
#include "mongo/util/synchronized_value.h"
namespace mongo {
namespace {
const auto getFTDCController = ServiceContext::declareDecoration<std::unique_ptr<FTDCController>>();
FTDCController* getGlobalFTDCController() {
if (!hasGlobalServiceContext()) {
return nullptr;
}
return getFTDCController(getGlobalServiceContext()).get();
}
/**
* Expose diagnosticDataCollectionDirectoryPath set parameter to specify the MongoD and MongoS FTDC
* path.
*/
synchronized_value<boost::filesystem::path> ftdcDirectoryPathParameter;
} // namespace
FTDCStartupParams ftdcStartupParams;
void DiagnosticDataCollectionDirectoryPathServerParameter::append(OperationContext* opCtx,
BSONObjBuilder& b,
const std::string& name) {
b.append(name, ftdcDirectoryPathParameter->generic_string());
}
Status DiagnosticDataCollectionDirectoryPathServerParameter::setFromString(const std::string& str) {
if (hasGlobalServiceContext()) {
FTDCController* controller = FTDCController::get(getGlobalServiceContext());
if (controller) {
Status s = controller->setDirectory(str);
if (!s.isOK()) {
return s;
}
}
}
ftdcDirectoryPathParameter = str;
return Status::OK();
}
boost::filesystem::path getFTDCDirectoryPathParameter() {
return ftdcDirectoryPathParameter.get();
}
Status onUpdateFTDCEnabled(const bool value) {
auto controller = getGlobalFTDCController();
if (controller) {
return controller->setEnabled(value);
}
return Status::OK();
}
Status onUpdateFTDCPeriod(const std::int32_t potentialNewValue) {
auto controller = getGlobalFTDCController();
if (controller) {
controller->setPeriod(Milliseconds(potentialNewValue));
}
return Status::OK();
}
Status onUpdateFTDCDirectorySize(const std::int32_t potentialNewValue) {
if (potentialNewValue < ftdcStartupParams.maxFileSizeMB.load()) {
return Status(
ErrorCodes::BadValue,
str::stream()
<< "diagnosticDataCollectionDirectorySizeMB must be greater than or equal to '"
<< ftdcStartupParams.maxFileSizeMB.load()
<< "' which is the current value of diagnosticDataCollectionFileSizeMB.");
}
auto controller = getGlobalFTDCController();
if (controller) {
controller->setMaxDirectorySizeBytes(potentialNewValue * 1024 * 1024);
}
return Status::OK();
}
Status onUpdateFTDCFileSize(const std::int32_t potentialNewValue) {
if (potentialNewValue > ftdcStartupParams.maxDirectorySizeMB.load()) {
return Status(
ErrorCodes::BadValue,
str::stream()
<< "diagnosticDataCollectionFileSizeMB must be less than or equal to '"
<< ftdcStartupParams.maxDirectorySizeMB.load()
<< "' which is the current value of diagnosticDataCollectionDirectorySizeMB.");
}
auto controller = getGlobalFTDCController();
if (controller) {
controller->setMaxFileSizeBytes(potentialNewValue * 1024 * 1024);
}
return Status::OK();
}
Status onUpdateFTDCSamplesPerChunk(const std::int32_t potentialNewValue) {
auto controller = getGlobalFTDCController();
if (controller) {
controller->setMaxSamplesPerArchiveMetricChunk(potentialNewValue);
}
return Status::OK();
}
Status onUpdateFTDCPerInterimUpdate(const std::int32_t potentialNewValue) {
auto controller = getGlobalFTDCController();
if (controller) {
controller->setMaxSamplesPerInterimMetricChunk(potentialNewValue);
}
return Status::OK();
}
FTDCSimpleInternalCommandCollector::FTDCSimpleInternalCommandCollector(StringData command,
StringData name,
StringData ns,
BSONObj cmdObj)
: _name(name.toString()), _request(OpMsgRequest::fromDBAndBody(ns, std::move(cmdObj))) {
invariant(command == _request.getCommandName());
invariant(CommandHelpers::findCommand(command)); // Fail early if it doesn't exist.
}
void FTDCSimpleInternalCommandCollector::collect(OperationContext* opCtx, BSONObjBuilder& builder) {
auto result = CommandHelpers::runCommandDirectly(opCtx, _request);
builder.appendElements(result);
}
std::string FTDCSimpleInternalCommandCollector::name() const {
return _name;
}
/**
* A FTDC Collector for serverStatus
*/
class FTDCServerStatusCommandCollector : public FTDCCollectorInterface {
private:
constexpr static StringData kName = "serverStatus"_sd;
constexpr static StringData kCommand = "serverStatus"_sd;
public:
FTDCServerStatusCommandCollector() {}
void collect(OperationContext* opCtx, BSONObjBuilder& builder) final {
// CmdServerStatus
// The "sharding" section is filtered out because at this time it only consists of strings
// in migration status. This section triggers too many schema changes in the serverStatus
// which hurt ftdc compression efficiency, because its output varies depending on the list
// of active migrations.
// "timing" is filtered out because it triggers frequent schema changes.
// "defaultRWConcern" is excluded because it changes rarely and instead included in rotation
// "mirroredReads" is included to append the number of mirror-able operations observed and
// mirrored by this process in FTDC collections.
BSONObjBuilder commandBuilder;
commandBuilder.append(kCommand, 1);
commandBuilder.append("sharding", false);
commandBuilder.append("timing", false);
commandBuilder.append("defaultRWConcern", false);
commandBuilder.append(MirrorMaestro::kServerStatusSectionName, true);
// Exclude 'serverStatus.transactions.lastCommittedTransactions' because it triggers
// frequent schema changes.
commandBuilder.append("transactions", BSON("includeLastCommitted" << false));
if (gDiagnosticDataCollectionEnableLatencyHistograms.load()) {
BSONObjBuilder subObjBuilder(commandBuilder.subobjStart("opLatencies"));
subObjBuilder.append("histograms", true);
subObjBuilder.append("slowBuckets", true);
}
if (gDiagnosticDataCollectionVerboseTCMalloc.load()) {
commandBuilder.append("tcmalloc", 2);
}
commandBuilder.done();
auto request = OpMsgRequest::fromDBAndBody("", commandBuilder.obj());
auto result = CommandHelpers::runCommandDirectly(opCtx, request);
builder.appendElements(result);
}
std::string name() const final {
return kName.toString();
}
};
// Register the FTDC system
// Note: This must be run before the server parameters are parsed during startup
// so that the FTDCController is initialized.
//
void startFTDC(boost::filesystem::path& path,
FTDCStartMode startupMode,
RegisterCollectorsFunction registerCollectors) {
FTDCConfig config;
config.period = Milliseconds(ftdcStartupParams.periodMillis.load());
// Only enable FTDC if our caller says to enable FTDC, MongoS may not have a valid path to write
// files to so update the diagnosticDataCollectionEnabled set parameter to reflect that.
ftdcStartupParams.enabled.store(startupMode == FTDCStartMode::kStart &&
ftdcStartupParams.enabled.load());
config.enabled = ftdcStartupParams.enabled.load();
config.maxFileSizeBytes = ftdcStartupParams.maxFileSizeMB.load() * 1024 * 1024;
config.maxDirectorySizeBytes = ftdcStartupParams.maxDirectorySizeMB.load() * 1024 * 1024;
config.maxSamplesPerArchiveMetricChunk =
ftdcStartupParams.maxSamplesPerArchiveMetricChunk.load();
config.maxSamplesPerInterimMetricChunk =
ftdcStartupParams.maxSamplesPerInterimMetricChunk.load();
ftdcDirectoryPathParameter = path;
auto controller = std::make_unique<FTDCController>(path, config);
// Install periodic collectors
// These are collected on the period interval in FTDCConfig.
// NOTE: For each command here, there must be an equivalent privilege check in
// GetDiagnosticDataCommand
controller->addPeriodicCollector(std::make_unique<FTDCServerStatusCommandCollector>());
registerCollectors(controller.get());
// Install System Metric Collector as a periodic collector
installSystemMetricsCollector(controller.get());
// Install file rotation collectors
// These are collected on each file rotation.
// CmdBuildInfo
controller->addOnRotateCollector(std::make_unique<FTDCSimpleInternalCommandCollector>(
"buildInfo", "buildInfo", "", BSON("buildInfo" << 1)));
// CmdGetCmdLineOpts
controller->addOnRotateCollector(std::make_unique<FTDCSimpleInternalCommandCollector>(
"getCmdLineOpts", "getCmdLineOpts", "", BSON("getCmdLineOpts" << 1)));
// HostInfoCmd
controller->addOnRotateCollector(std::make_unique<FTDCSimpleInternalCommandCollector>(
"hostInfo", "hostInfo", "", BSON("hostInfo" << 1)));
// Install the new controller
auto& staticFTDC = getFTDCController(getGlobalServiceContext());
staticFTDC = std::move(controller);
staticFTDC->start();
}
void stopFTDC() {
auto controller = getGlobalFTDCController();
if (controller) {
controller->stop();
}
}
FTDCController* FTDCController::get(ServiceContext* serviceContext) {
return getFTDCController(serviceContext).get();
}
} // namespace mongo
|