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
|
/**
* 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 <memory>
#include <mutex>
#include <string>
#include <utility>
#include <vector>
#include "mongo/base/status.h"
#include "mongo/db/client.h"
#include "mongo/db/free_mon/free_mon_message.h"
#include "mongo/db/free_mon/free_mon_network.h"
#include "mongo/db/free_mon/free_mon_processor.h"
#include "mongo/db/service_context.h"
#include "mongo/stdx/thread.h"
#include "mongo/util/duration.h"
namespace mongo {
/**
* Manages and control Free Monitoring. This is the entry point for non-free monitoring components
* into free-monitoring.
*/
class FreeMonController {
public:
explicit FreeMonController(std::unique_ptr<FreeMonNetworkInterface> network,
bool useCrankForTest = false)
: _network(std::move(network)), _useCrankForTest(useCrankForTest) {}
/**
* Initializes free monitoring.
* Start free monitoring thread in the background.
*/
void start(RegistrationType registrationType,
std::vector<std::string>& tags,
Seconds gatherMetricsInterval);
/**
* Stops free monitoring thread.
*/
void stop();
/**
* Turn the crank of the message queue by ignoring deadlines for N messages.
*/
void turnCrankForTest(size_t countMessagesToIgnore);
/**
* Add a metric collector to collect on registration
*/
void addRegistrationCollector(std::unique_ptr<FreeMonCollectorInterface> collector);
/**
* Add a metric collector to collect periodically
*/
void addMetricsCollector(std::unique_ptr<FreeMonCollectorInterface> collector);
/**
* Get the FreeMonController from ServiceContext.
*/
static FreeMonController* get(ServiceContext* serviceContext);
/**
* Set the FreeMonController in the ServiceContext.
*/
static void set(ServiceContext* serviceContext, std::unique_ptr<FreeMonController> controller);
/**
* Start registration of mongod with remote service.
*
* Only sends one remote registration at a time.
* Returns after timeout if registrations is not complete. Registration continues though.
*/
void registerServerStartup(RegistrationType registrationType, std::vector<std::string>& tags);
/**
* Start registration of mongod with remote service.
*
* Only sends one remote registration at a time.
* Returns after timeout if registrations is not complete. Registration continues though.
* Update is synchronous with 10sec timeout
* kicks off register, and once register is done kicks off metrics upload
*/
boost::optional<Status> registerServerCommand(Milliseconds timeout);
/**
* Stop registration of mongod with remote service.
*
* As with registerServerCommand() above, but undoes registration.
* On complettion of this command, no further metrics will be transmitted.
*/
boost::optional<Status> unregisterServerCommand(Milliseconds timeout);
/**
* Populates an info blob for use by {getFreeMonitoringStatus: 1}
*/
void getStatus(OperationContext* opCtx, BSONObjBuilder* status);
/**
* Populates an info blob for use by {serverStatus: 1}
*/
void getServerStatus(OperationContext* opCtx, BSONObjBuilder* status);
/**
* Notify on upsert.
*
* Updates and inserts are treated as the same.
*/
void notifyOnUpsert(const BSONObj& doc);
/**
* Notify on document delete or drop collection.
*/
void notifyOnDelete();
/**
* Notify that we local instance has become a primary.
*/
void notifyOnTransitionToPrimary();
/**
* Notify that storage has rolled back
*/
void notifyOnRollback();
private:
void _enqueue(std::shared_ptr<FreeMonMessage> msg);
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,
};
// Controller state
State _state{State::kNotStarted};
// Mutext to protect internal state
stdx::mutex _mutex;
// Set of registration collectors
FreeMonCollectorCollection _registrationCollectors;
// Set of metric collectors
FreeMonCollectorCollection _metricCollectors;
// Network interface
std::unique_ptr<FreeMonNetworkInterface> _network;
// Background thead for agent
stdx::thread _thread;
// Crank for test
bool _useCrankForTest;
// Background agent
std::shared_ptr<FreeMonProcessor> _processor;
};
} // namespace mongo
|
