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
|
/**
* 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, kLdap, kDns };
class FaultManagerConfig {
public:
static auto inline constexpr kPeriodicHealthCheckInterval{Milliseconds(50)};
HealthObserverIntensityEnum getHealthObserverIntensity(FaultFacetType type) {
auto intensities = getHealthObserverIntensities();
switch (type) {
case FaultFacetType::kLdap:
return intensities->_data->getLdap();
case FaultFacetType::kDns:
return intensities->_data->getDns();
// TODO: update this function with additional fault facets when they are added
case FaultFacetType::kSystem:
return HealthObserverIntensityEnum::kCritical;
case FaultFacetType::kMock1:
if (_facetToIntensityMapForTest.contains(type)) {
return _facetToIntensityMapForTest.at(type);
}
return HealthObserverIntensityEnum::kCritical;
case FaultFacetType::kMock2:
return HealthObserverIntensityEnum::kCritical;
default:
MONGO_UNREACHABLE;
}
}
bool isHealthObserverEnabled(FaultFacetType type) {
return getHealthObserverIntensity(type) != HealthObserverIntensityEnum::kOff;
}
void setIntensityForType(FaultFacetType type, HealthObserverIntensityEnum intensity) {
_facetToIntensityMapForTest.insert({type, intensity});
}
Milliseconds getActiveFaultDuration() const {
return _activeFaultDuration;
}
Milliseconds getPeriodicHealthCheckInterval() const {
return kPeriodicHealthCheckInterval;
}
Milliseconds getPeriodicLivenessCheckInterval() const {
return Milliseconds(50);
}
Seconds getPeriodicLivenessDeadline() const {
return Seconds(300);
}
/** @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;
}
void setActiveFaultDurationForTests(Milliseconds duration) {
_activeFaultDuration = duration;
}
protected:
// If the server persists in TransientFault for more than this duration
// it will move to the ActiveFault state and terminate.
static inline const auto kActiveFaultDuration = Seconds(120);
private:
static HealthMonitoringIntensitiesServerParameter* getHealthObserverIntensities() {
return ServerParameterSet::getGlobal()->get<HealthMonitoringIntensitiesServerParameter>(
"healthMonitoring");
}
bool _periodicChecksDisabledForTests = false;
Milliseconds _activeFaultDuration = kActiveFaultDuration;
stdx::unordered_map<FaultFacetType, HealthObserverIntensityEnum> _facetToIntensityMapForTest;
};
} // namespace process_health
} // namespace mongo
|
