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
|
/**
* 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
#include <boost/filesystem/path.hpp>
#include <cstdint>
#include <memory>
#include "mongo/db/ftdc/collector.h"
#include "mongo/db/ftdc/config.h"
#include "mongo/db/ftdc/file_manager.h"
#include "mongo/db/jsobj.h"
#include "mongo/stdx/condition_variable.h"
#include "mongo/stdx/mutex.h"
#include "mongo/stdx/thread.h"
namespace mongo {
class ServiceContext;
/**
* Responsible for periodic collection of samples, writing them to disk,
* and rotation.
*
* Exposes an methods to response to configuration changes in a thread-safe manner.
*/
class FTDCController {
FTDCController(const FTDCController&) = delete;
FTDCController& operator=(const FTDCController&) = delete;
public:
FTDCController(const boost::filesystem::path path, FTDCConfig config)
: _path(path), _config(std::move(config)), _configTemp(_config) {}
~FTDCController() = default;
/*
* Set whether the controller is enabled, and collects data.
*
* Returns ErrorCodes::FTDCPathNotSet if no log path has been specified for FTDC. This occurs
* in MongoS in some situations since MongoS is not required to have a storage directory like
* MongoD does.
*/
Status setEnabled(bool enabled);
/**
* Set the period for data collection.
*/
void setPeriod(Milliseconds millis);
/**
* Set the maximum directory size in bytes.
*/
void setMaxDirectorySizeBytes(std::uint64_t size);
/**
* Set the maximum file size in bytes.
*/
void setMaxFileSizeBytes(std::uint64_t size);
/**
* Set the maximum number of samples to store in a metric chunk. Larger numbers enable better
* compression at the cost of allowing more data to be lost in the event of a crash.
*/
void setMaxSamplesPerArchiveMetricChunk(size_t size);
/**
* Set the maximum number of samples to store in a interim chunk to minimize the number of
* samples not stored in the archive log in the event of a crash.
*
* Smaller numbers will create unnecessary I/O.
*/
void setMaxSamplesPerInterimMetricChunk(size_t size);
/*
* Set the path to store FTDC files if not already set.
*
* Returns ErrorCodes::FTDCPathAlreadySet if the path has already been set.
*/
Status setDirectory(const boost::filesystem::path& path);
/**
* Add a metric collector to collect periodically. i.e., serverStatus
*/
void addPeriodicCollector(std::unique_ptr<FTDCCollectorInterface> collector);
/**
* Add a collector to collect on server start, and file rotation. i.e. hostInfo
*
* This is for machine configuration settings, not metrics.
*/
void addOnRotateCollector(std::unique_ptr<FTDCCollectorInterface> collector);
/**
* Start the controller.
*
* Spawns a new thread.
*/
void start();
/**
* Stop the controller.
*
* Does not require start to be called to support early exit by mongod.
*/
void stop();
/**
* Get the FTDCController from ServiceContext.
*/
static FTDCController* get(ServiceContext* serviceContext);
/**
* Get a reference to most recent document from the periodic collectors.
*/
BSONObj getMostRecentPeriodicDocument();
private:
/**
* Do periodic statistics collection, and all other work on the background thread.
*/
void doLoop();
private:
/**
* Private enum to track state.
*
* +-----------------------------------------------------------+
* | v
* +-------------+ +----------+ +----------------+ +-------+
* | kNotStarted | --> | kStarted | --> | kStopRequested | --> | kDone |
* +-------------+ +----------+ +----------------+ +-------+
*/
enum class State {
/**
* Initial state. Either start() or stop() can be called next.
*/
kNotStarted,
/**
* start() has been called. stop() should be called next.
*/
kStarted,
/**
* stop() has been called, and the background thread is in progress of shutting down
*/
kStopRequested,
/**
* Controller has been stopped.
*/
kDone,
};
// state
State _state{State::kNotStarted};
// Directory to store files
boost::filesystem::path _path;
// Mutex to protect the condvar, configuration changes, and most recent periodic document.
stdx::mutex _mutex;
stdx::condition_variable _condvar;
// Config settings that are used by controller, file manager, and all other classes.
// Copied from _configTemp periodically to get a consistent snapshot.
FTDCConfig _config;
// Config settings that are manipulated by setters via setParameter.
FTDCConfig _configTemp;
// Set of periodic collectors
FTDCCollectorCollection _periodicCollectors;
// Last seen sample document from periodic collectors
// Owned
BSONObj _mostRecentPeriodicDocument;
// Set of file rotation collectors
FTDCCollectorCollection _rotateCollectors;
// File manager that manages file rotation, and logging
std::unique_ptr<FTDCFileManager> _mgr;
// Background collection and writing thread
stdx::thread _thread;
};
} // namespace mongo
|
