summaryrefslogtreecommitdiff
path: root/src/mongo/db/process_health/progress_monitor.h
blob: 9b7e1f79b4ecd99cf52e5eb974ca299ee34f52cc (plain)
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
/**
 *    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 <functional>
#include <string>
#include <thread>

#include "mongo/db/service_context.h"
#include "mongo/stdx/thread.h"

namespace mongo {
namespace process_health {

class FaultManager;

/**
 *  Tracks that the health checks are invoked regularly and have progress.
 */
class ProgressMonitor {
public:
    ProgressMonitor(FaultManager* faultManager,
                    ServiceContext* svcCtx,
                    std::function<void(std::string cause)> crashCb);

    // Signals that the monitoring can stop and blocks until the thread is joined.
    // Invoked to signal that the task executor is joined.
    void join();

    // Checks that the health checks are invoked and are not stuck forever. Invokes the callback
    // after timeout configured by options.
    void progressMonitorCheck(std::function<void(std::string cause)> crashCb);

private:
    // Checks that the periodic health checks actually make progress.
    void _progressMonitorLoop();

    FaultManager* const _faultManager;
    ServiceContext* const _svcCtx;
    // Callback used to crash the server.
    const std::function<void(std::string cause)> _crashCb;
    // This flag is set after the _taskExecutor join() returns, thus
    // we know no more health checks are still running.
    AtomicWord<bool> _terminate{false};
    stdx::thread _progressMonitorThread;
};

}  // namespace process_health
}  // namespace mongo