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
|
/**
* 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 "mongo/db/process_health/fault_facet.h"
#include "mongo/db/process_health/fault_facets_container.h"
#include "mongo/db/process_health/fault_manager_config.h"
#include "mongo/executor/task_executor.h"
#include "mongo/util/future.h"
namespace mongo {
namespace process_health {
/**
* Liveness data and stats.
*/
struct HealthObserverLivenessStats {
// True if this observer is enabled.
bool isEnabled = false;
// true is this observer is currently running a health check.
bool currentlyRunningHealthCheck = false;
// When the last or current check started, depending if currently
// running one.
Date_t lastTimeCheckStarted = Date_t::max();
// When the last check completed (not the current one).
Date_t lastTimeCheckCompleted = Date_t::max();
// Incremented when a check is done.
int completedChecksCount = 0;
// Incremented when check completed with fault.
// This doesn't take into account critical vs non-critical.
int completedChecksWithFaultCount = 0;
};
/**
* Interface to conduct periodic health checks.
* Every instance of health observer is wired internally to update the state of the FaultManager
* when a problem is detected.
*/
class HealthObserver {
public:
virtual ~HealthObserver() = default;
/**
* Health observer of this type is unique and can only create the fault facet
* of the same type.
*
* @return FaultFacetType of this health observer.
*/
virtual FaultFacetType getType() const = 0;
/**
* Triggers health check.
* It should be safe to invoke this method arbitrary often, the implementation
* should prorate the invocations to avoid DoS.
* The implementation may or may not block for the completion of the check, this remains
* unspecified.
* Note: no methods in this class should return any check results, the proper way to
* get result is to check facets in the FaultManager.
*
* @param factory Interface to get or create the factory of facets container.
*/
virtual void periodicCheck(FaultFacetsContainerFactory& factory,
std::shared_ptr<executor::TaskExecutor> taskExecutor,
std::shared_ptr<AtomicWord<bool>> cancellationToken) = 0;
/**
* @return HealthObserverIntensity
*/
virtual HealthObserverIntensity getIntensity() const = 0;
virtual HealthObserverLivenessStats getStats() const = 0;
};
} // namespace process_health
} // namespace mongo
|
