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
|
/**
* Copyright (C) 2018-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/commands.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/stats/counters.h"
#include "mongo/platform/atomic_word.h"
#include <string>
namespace mongo {
class ServerStatusSection {
public:
ServerStatusSection(const std::string& sectionName);
virtual ~ServerStatusSection() = default;
const std::string& getSectionName() const {
return _sectionName;
}
/**
* if this returns true, if the user doesn't mention this section
* it will be included in the result
* if they do : 1, it will be included
* if they do : 0, it will not
*
* examples (section 'foo')
* includeByDefault returning true
* foo : 0 = not included
* foo : 1 = included
* foo missing = included
* includeByDefault returning false
* foo : 0 = not included
* foo : 1 = included
* foo missing = false
*/
virtual bool includeByDefault() const = 0;
/**
* Perform authorization checks required to show this status section.
* TODO: Remove this empty default implementation and implement for every section.
*/
virtual Status checkAuthForOperation(OperationContext* opCtx) const {
return Status::OK();
}
/**
* actually generate the result
*
* You should either implement this function or appendSection below, but not both. In
* most cases you should just implement this function.
*
* @param configElement the element from the actual command related to this section
* so if the section is 'foo', this is cmdObj['foo']
*/
virtual BSONObj generateSection(OperationContext* opCtx,
const BSONElement& configElement) const {
return BSONObj{};
};
/**
* This is what gets called by the serverStatus command to append the section to the
* command result.
*
* If you are just implementing a normal ServerStatusSection, then you don't need to
* implement this.
*
* If you are doing something a bit more complicated, you can implement this and have
* full control over what gets included in the command result.
*/
virtual void appendSection(OperationContext* opCtx,
const BSONElement& configElement,
BSONObjBuilder* result) const {
const auto ret = generateSection(opCtx, configElement);
if (ret.isEmpty())
return;
result->append(getSectionName(), ret);
}
private:
const std::string _sectionName;
};
/**
* Class the keeps a map of all registered status sections
*/
class ServerStatusSectionRegistry {
public:
using SectionMap = std::map<std::string, ServerStatusSection*>;
static ServerStatusSectionRegistry* get();
/**
* Add a status section to the map. Called by ServerStatusSection constructor
*/
void addSection(ServerStatusSection* section);
SectionMap::const_iterator begin();
SectionMap::const_iterator end();
private:
AtomicWord<bool> _runCalled{false};
SectionMap _sections;
};
class OpCounterServerStatusSection : public ServerStatusSection {
public:
OpCounterServerStatusSection(const std::string& sectionName, OpCounters* counters);
bool includeByDefault() const override {
return true;
}
BSONObj generateSection(OperationContext* opCtx,
const BSONElement& configElement) const override;
private:
const OpCounters* _counters;
};
} // namespace mongo
|
