aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/vespa/searchcore/proton/common/statusreport.h
blob: 196e792ed2a17c67a1db79781c4b250d2ba20a09 (plain) (blame)
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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include <vespa/vespalib/stllike/string.h>
#include <cmath>
#include <limits>
#include <memory>
#include <vector>

namespace proton {

/**
 * A StatusReport describes the status of a search component.
 */
class StatusReport {
public:
    using UP = std::unique_ptr<StatusReport>;
    using SP = std::shared_ptr<StatusReport>;
    using List = std::vector<SP>;

    enum State {
        DOWN = 0,
        PARTIAL,
        UPOK
    };

    struct Params {
        vespalib::string _component;
        State _state;
        vespalib::string _internalState;
        vespalib::string _internalConfigState;
        float _progress;
        vespalib::string _message;

        Params(const vespalib::string &component);
        ~Params();
        Params &state(State value) {
            _state = value;
            return *this;
        }
        Params &internalState(const vespalib::string &value) {
            _internalState = value;
            return *this;
        }
        Params &internalConfigState(const vespalib::string &value) {
            _internalConfigState = value;
            return *this;
        }
        Params &progress(float value) {
            _progress = value;
            return *this;
        }
        Params &message(const vespalib::string &value) {
            _message = value;
            return *this;
        }
    };

private:
    vespalib::string _component;
    State _state;
    vespalib::string _internalState;
    vespalib::string _internalConfigState;
    float _progress;
    vespalib::string _message;

public:
    StatusReport(const Params &params);
    ~StatusReport();

    static StatusReport::UP create(const Params &params) {
        return std::make_unique<StatusReport>(params);
    }

    const vespalib::string &getComponent() const {
        return _component;
    }

    State getState() const {
        return _state;
    }

    const vespalib::string &getInternalState() const {
        return _internalState;
    }

    const vespalib::string &getInternalConfigState() const {
        return _internalConfigState;
    }

    bool hasProgress() const {
        return !std::isnan(_progress);
    }

    float getProgress() const {
        return _progress;
    }

    const vespalib::string &getMessage() const {
        return _message;
    }

    vespalib::string getInternalStatesStr() const {
        vespalib::string retval = "state=" + _internalState;
        if (!_internalConfigState.empty()) {
            retval = retval + " configstate=" + _internalConfigState;
        }
        return retval;
    }

};

/**
 * A StatusProducer is able to produce a list of StatusReport objects
 * when needed.
 **/
struct StatusProducer {
    virtual StatusReport::List getStatusReports() const = 0;
    virtual ~StatusProducer() {}
};

} // namespace proton