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
|
/**
* 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 <memory>
#include <string>
#include <tuple>
#include <vector>
namespace mongo {
class BSONObj;
class BSONObjBuilder;
class Date_t;
class Client;
class OperationContext;
/**
* BSON Collector interface
*
* Provides an interface to collect BSONObjs from system providers
*/
class FTDCCollectorInterface {
FTDCCollectorInterface(const FTDCCollectorInterface&) = delete;
FTDCCollectorInterface& operator=(const FTDCCollectorInterface&) = delete;
public:
virtual ~FTDCCollectorInterface() = default;
/**
* Name of the collector
*
* Used to stamp before and after dates to measure time to collect.
*/
virtual std::string name() const = 0;
/**
* Some collectors can be optionally enabled at runtime but otherwise do not return any data.
*
* Returns true if this collector has data to collect.
*/
virtual bool hasData() const {
return true;
}
/**
* Collect a sample.
*
* If a collector fails to collect data, it should update builder with the result of the
* failure.
*/
virtual void collect(OperationContext* opCtx, BSONObjBuilder& builder) = 0;
protected:
FTDCCollectorInterface() = default;
};
/**
* Manages the set of BSON collectors
*
* Not Thread-Safe. Locking is owner's responsibility.
*/
class FTDCCollectorCollection {
FTDCCollectorCollection(const FTDCCollectorCollection&) = delete;
FTDCCollectorCollection& operator=(const FTDCCollectorCollection&) = delete;
public:
FTDCCollectorCollection() = default;
/**
* Add a metric collector to the collection.
* Must be called before collect. Cannot be called after collect is called.
*/
void add(std::unique_ptr<FTDCCollectorInterface> collector);
/**
* Collect a sample from all collectors. Called after all adding is complete.
* Returns a tuple of a sample, and the time at which collecting started.
*
* Sample schema:
* {
* "start" : Date_t, <- Time at which all collecting started
* "name" : { <- name is from name() in FTDCCollectorInterface
* "start" : Date_t, <- Time at which name() collection started
* "data" : { ... } <- data comes from collect() in FTDCCollectorInterface
* "end" : Date_t, <- Time at which name() collection ended
* },
* ...
* "end" : Date_t, <- Time at which all collecting ended
* }
*/
std::tuple<BSONObj, Date_t> collect(Client* client);
private:
// collection of collectors
std::vector<std::unique_ptr<FTDCCollectorInterface>> _collectors;
};
} // namespace mongo
|
