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
|
/**
* Copyright (C) 2021-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 <ostream>
#include "mongo/db/process_health/health_monitoring_server_parameters_gen.h"
#include "mongo/platform/basic.h"
#include "mongo/util/duration.h"
namespace mongo {
namespace process_health {
/**
* Current fault state of the server in a simple actionable form.
*/
enum class FaultState {
// The manager conducts startup checks, new connections should be refused.
kStartupCheck = 0,
kOk,
// The manager detected a fault, however the fault is either not severe
// enough or is not observed for sufficiently long period of time.
kTransientFault,
// The manager detected a severe fault, which made the server unusable.
kActiveFault
};
StringBuilder& operator<<(StringBuilder& s, const FaultState& state);
std::ostream& operator<<(std::ostream& os, const FaultState& state);
/**
* Types of health observers available.
*/
enum class FaultFacetType { kSystem, kMock1, kMock2, kTestObserver, kLdap, kDns };
static const StringData FaultFacetTypeStrings[] = {
"kSystem", "kMock1", "kMock2", "kTestObserver", "kLdap", "kDns"};
FaultFacetType toFaultFacetType(HealthObserverTypeEnum type);
static const StringData FaultFacetType_serializer(const FaultFacetType value) {
return FaultFacetTypeStrings[static_cast<int>(value)];
}
inline StringBuilder& operator<<(StringBuilder& s, const FaultFacetType& type) {
return s << FaultFacetType_serializer(type);
}
inline std::ostream& operator<<(std::ostream& os, const FaultFacetType& type) {
StringBuilder sb;
sb << type;
os << sb.stringData();
return os;
}
class FaultManagerConfig {
public:
/* Maximum possible jitter added to the time between health checks */
static auto inline constexpr kPeriodicHealthCheckMaxJitter{Milliseconds{100}};
HealthObserverIntensityEnum getHealthObserverIntensity(FaultFacetType type) {
auto intensities = _getHealthObserverIntensities();
auto toObserverType = [](FaultFacetType type) -> boost::optional<HealthObserverTypeEnum> {
switch (type) {
case FaultFacetType::kLdap:
return HealthObserverTypeEnum::kLdap;
case FaultFacetType::kDns:
return HealthObserverTypeEnum::kDns;
case FaultFacetType::kTestObserver:
return HealthObserverTypeEnum::kTest;
default:
return boost::none;
}
};
auto getIntensity = [this, intensities, &toObserverType](FaultFacetType type) {
auto observerType = toObserverType(type);
if (observerType) {
auto x = intensities->_data->getValues();
if (x) {
for (auto setting : *x) {
if (setting.getType() == observerType) {
return setting.getIntensity();
}
}
}
return HealthObserverIntensityEnum::kOff;
} else {
// TODO SERVER-61944: this is for kMock1 & kMock2. Remove this branch once mock
// types are deleted.
if (_facetToIntensityMapForTest.contains(type)) {
return _facetToIntensityMapForTest.at(type);
}
return HealthObserverIntensityEnum::kCritical;
}
};
return getIntensity(type);
}
bool isHealthObserverEnabled(FaultFacetType type) {
return getHealthObserverIntensity(type) != HealthObserverIntensityEnum::kOff;
}
void setIntensityForType(FaultFacetType type, HealthObserverIntensityEnum intensity) {
_facetToIntensityMapForTest.insert({type, intensity});
}
// If the server persists in TransientFault for more than this duration
// it will move to the ActiveFault state and terminate.
Milliseconds getActiveFaultDuration() const {
return Milliseconds(Seconds(mongo::gActiveFaultDurationSecs.load()));
}
Milliseconds getPeriodicHealthCheckInterval(FaultFacetType type) const {
auto intervals = _getHealthObserverIntervals();
return Milliseconds(_getPropertyByType(type, &intervals->_data, 1000));
}
Milliseconds getPeriodicLivenessCheckInterval() const {
return Milliseconds(_getLivenessConfig()->_data->getInterval());
}
Seconds getPeriodicLivenessDeadline() const {
return Seconds(_getLivenessConfig()->_data->getDeadline());
}
/** @returns true if the periodic checks are disabled for testing purposes. This is
* always false in production.
*/
bool periodicChecksDisabledForTests() const {
return _periodicChecksDisabledForTests;
}
void disablePeriodicChecksForTests() {
_periodicChecksDisabledForTests = true;
}
private:
static HealthMonitoringIntensitiesServerParameter* _getHealthObserverIntensities() {
return ServerParameterSet::getGlobal()->get<HealthMonitoringIntensitiesServerParameter>(
"healthMonitoringIntensities");
}
static PeriodicHealthCheckIntervalsServerParameter* _getHealthObserverIntervals() {
return ServerParameterSet::getGlobal()->get<PeriodicHealthCheckIntervalsServerParameter>(
"healthMonitoringIntervals");
}
static HealthMonitoringProgressMonitorServerParameter* _getLivenessConfig() {
return ServerParameterSet::getGlobal()->get<HealthMonitoringProgressMonitorServerParameter>(
"progressMonitor");
}
template <typename T, typename R>
R _getPropertyByType(FaultFacetType type, synchronized_value<T>* data, R defaultValue) const {
// TODO: update this function with additional fault facets when they are added
boost::optional<R> result;
switch (type) {
case FaultFacetType::kLdap:
result = (*data)->getLdap();
break;
case FaultFacetType::kDns:
result = (*data)->getDns();
break;
case FaultFacetType::kTestObserver:
result = (*data)->getTest();
break;
case FaultFacetType::kSystem:
result = defaultValue;
break;
case FaultFacetType::kMock1:
result = defaultValue;
break;
case FaultFacetType::kMock2:
result = defaultValue;
break;
default:
MONGO_UNREACHABLE;
}
return *result;
}
bool _periodicChecksDisabledForTests = false;
stdx::unordered_map<FaultFacetType, HealthObserverIntensityEnum> _facetToIntensityMapForTest;
};
} // namespace process_health
} // namespace mongo
|
