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
|
/**
* 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 <memory>
#include <ostream>
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/process_health/fault_manager_config.h"
namespace mongo {
namespace process_health {
/**
* Immutable class representing current status of an ongoing fault tracked by facet.
*/
class HealthCheckStatus {
public:
static constexpr double kResolvedSeverity = 0;
// The range for active fault is inclusive: [ 1, Inf ).
static constexpr double kActiveFaultSeverity = 1.0;
// We chose to subtract a small 'epsilon' value from 1.0 to
// avoid rounding problems and be sure that severity of 1.0 is guaranteed to be an active fault.
static constexpr double kActiveFaultSeverityEpsilon = 0.000001;
using Severity = double;
HealthCheckStatus(FaultFacetType type, Severity severity, StringData description)
: _type(type), _severity(severity), _description(description) {}
// Constructs a resolved status (no fault detected).
explicit HealthCheckStatus(FaultFacetType type)
: _type(type), _severity(0), _description("resolved"_sd) {}
explicit HealthCheckStatus(HealthObserverTypeEnum type)
: _type(toFaultFacetType(type)), _severity(0), _description("resolved"_sd) {}
HealthCheckStatus(const HealthCheckStatus&) = default;
HealthCheckStatus& operator=(const HealthCheckStatus&) = default;
HealthCheckStatus(HealthCheckStatus&&) = default;
HealthCheckStatus& operator=(HealthCheckStatus&&) = default;
/**
* @return FaultFacetType of this status.
*/
FaultFacetType getType() const {
return _type;
}
/**
* The fault severity value if any.
*
* @return Current fault severity
*/
Severity getSeverity() const {
return _severity;
}
StringData getShortDescription() const {
return _description;
}
void appendDescription(BSONObjBuilder* builder) const;
BSONObj toBSON() const;
std::string toString() const;
// Helpers for severity levels.
static bool isResolved(double severity) {
return severity <= kResolvedSeverity;
}
static bool isTransientFault(double severity) {
return severity > kResolvedSeverity && severity < kActiveFaultSeverity;
}
static bool isActiveFault(double severity) {
// Range is inclusive.
return severity >= 1.0;
}
bool isActiveFault() const {
return isActiveFault(getSeverity());
}
private:
friend std::ostream& operator<<(std::ostream&, const HealthCheckStatus&);
friend StringBuilder& operator<<(StringBuilder& s, const HealthCheckStatus& hcs);
FaultFacetType _type;
double _severity;
std::string _description;
};
inline void HealthCheckStatus::appendDescription(BSONObjBuilder* builder) const {
builder->append("type", _type);
builder->append("description", _description);
builder->append("severity", _severity);
}
inline StringBuilder& operator<<(StringBuilder& s, const HealthCheckStatus& hcs) {
BSONObjBuilder bob;
hcs.appendDescription(&bob);
return s << bob.obj();
}
inline std::ostream& operator<<(std::ostream& os, const HealthCheckStatus& hcs) {
BSONObjBuilder bob;
hcs.appendDescription(&bob);
return os << bob.obj();
}
inline BSONObj HealthCheckStatus::toBSON() const {
BSONObjBuilder bob;
appendDescription(&bob);
return bob.obj();
}
inline std::string HealthCheckStatus::toString() const {
BSONObjBuilder bob;
appendDescription(&bob);
return bob.obj().toString();
}
} // namespace process_health
} // namespace mongo
|
