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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
/**
* Copyright (C) 2016 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 <map>
#include <memory>
#include <pdh.h>
#include <pdhmsg.h>
#include <string>
#include <unordered_map>
#include <vector>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/base/status_with.h"
#include "mongo/base/string_data.h"
#include "mongo/stdx/memory.h"
namespace mongo {
class BSONObjBuilder;
/**
* PerfCounterCollection contains a set of counters for PerfCounterCollector to collect. This class
* supports adding counters with wildcards. It also optionally supports grouping counters by
* instance name.
*/
class PerfCounterCollection {
MONGO_DISALLOW_COPYING(PerfCounterCollection);
friend class PerfCounterCollector;
public:
PerfCounterCollection() = default;
PerfCounterCollection(PerfCounterCollection&&) = default;
PerfCounterCollection& operator=(PerfCounterCollection&&) = default;
/**
* Add vector of counters grouped under 'name'.
*
* group name - the name of the BSON document to add these counters into.
* paths - a vector of counter paths. These may contain wildcards.
*
* Errors if groupName duplicates an existing group or if paths has duplicate keys. Does not
* validate if the counters exist.
*
* Output document:
* For the following counters in "cpu":
* "\System\Processes"
* "\Processor(_Total)\% Idle Time"
*
* {
* "cpu" : {
* "\System\Processes" : 42,
* "\Processor\% Idle Time" : 12,
* "\Processor\% Idle Time Base" : 53,
* }
* }
*/
Status addCountersGroup(StringData groupName, const std::vector<StringData>& paths);
/**
* Add vector of counters grouped under 'name', and grouped by instance name.
*
* group name - the name of the BSON document to add these counters into.
* paths - a vector of counter paths. These may contain wildcards. The '_Total' instance is
* automatically filtered since it can be computed by summing other instances.
*
* Errors if groupName duplicates an existing group or if paths has duplicate keys. Does not
* validate if the counters exist.
*
* Output document:
* For the following counters in "disks":
* "\PhysicalDisk(*)\% Disk Write Time"
*
* {
* "disks" : {
* "0 C:" : {
* "\PhysicalDisk\% Disk Write Time": 42,
* "\PhysicalDisk\% Disk Write Time Base": 32,
* },
* "1 D:" : {
* "\PhysicalDisk\% Disk Write Time": 43,
* "\PhysicalDisk\% Disk Write Time Base": 37,
* }
* }
* }
*/
Status addCountersGroupedByInstanceName(StringData groupName,
const std::vector<StringData>& paths);
private:
/**
* Check for duplicate group and counters.
*/
StatusWith<std::vector<std::string>> checkCounters(StringData groupName,
const std::vector<StringData>& paths);
private:
// Vector of counters which are not sub-grouped by instance name.
std::unordered_map<std::string, std::vector<std::string>> _counters;
// Vector of counters sub grouped by instance name.
std::unordered_map<std::string, std::vector<std::string>> _nestedCounters;
};
/**
* PerfCounterCollector collects a series of counters from a Performance Data Helper (PDH) Query and
* output the raw counter values to BSONObjBuilder.
*/
class PerfCounterCollector {
MONGO_DISALLOW_COPYING(PerfCounterCollector);
public:
~PerfCounterCollector();
PerfCounterCollector(PerfCounterCollector&&) = default;
/**
* Create a PerfCounterCollector to collect the performance counters in the specified
* PerfCounterCollection.
*/
static StatusWith<std::unique_ptr<PerfCounterCollector>> create(PerfCounterCollection builder);
/**
* Collect the counters from PDH, and output their raw values into builder.
*
* For each counters, if the counter is a delta, rate, or fraction counter, the second value is
* output under the name "<counter> Base". Also, a single field is output called "timebase" if
* any counter depends on system ticks per second.
*/
Status collect(BSONObjBuilder* builder);
private:
/**
* Describes a counter by querying PDH, and contains the necessary information to retrieve a
* counter from PDH.
*/
struct CounterInfo {
/**
* The name of the first value for a counter. This is output as:
* "\<Object Name>\<Counter Name>".
*/
std::string firstName;
/**
* The name of the second value of a counter if the counter is a delta, rate, or fraction
* counter. This is output as: "\<Object Name>\<Counter Name> Base".
*/
std::string secondName;
/**
* True if the counter is a delta, rate, or fraction counter, and its value should be output
* in the output BSON document.
*/
bool hasSecondValue;
/**
* Instance name of the counter. Empty if the counter has no instance name.
*/
std::string instanceName;
/**
* Counter Type. See PERF_* constants in winperf.h.
* https://technet.microsoft.com/en-us/library/cc785636(v=ws.10).aspx
*/
uint32_t type;
/**
* Handle of counter to collect from.
*/
PDH_HCOUNTER handle;
};
/**
* A set of counters that are part of "name" in the final bson document.
*/
struct CounterGroup {
/**
* Name of the counter group.
*/
std::string name;
/**
* Vector of counters in this group.
*/
std::vector<CounterInfo> counters;
};
/**
* A set of counters that are part of "name" and "instanceName" in the final bson document.
*/
struct NestedCounterGroup {
/**
* Name of the counter group.
*/
std::string name;
/**
* A map of instance name to vector of counters to collect for each instance name.
* Ordered Map to ensure output is well-ordered.
*/
std::map<std::string, std::vector<CounterInfo>> counters;
};
private:
PerfCounterCollector() = default;
/**
* Open the PDH Query.
*/
Status open();
/**
* Add the specified counter group to the PDH Query.
*/
Status addCountersGroup(StringData groupName, const std::vector<std::string>& paths);
/**
* Add the specified counter group to the PDH Query grouped by instance name.
*/
Status addCountersGroupedByInstanceName(StringData groupName,
const std::vector<std::string>& paths);
/**
* Add a counter to the PDH query and get a description of it.
*/
StatusWith<CounterInfo> addCounter(StringData path);
/**
* Add a set of counters to the PDH query, and get descriptions of them.
*/
StatusWith<std::vector<CounterInfo>> addCounters(StringData path);
/**
* Collect a vector of counters and output them to builder.
*/
Status collectCounters(const std::vector<CounterInfo>& counters, BSONObjBuilder* builder);
/**
* Check if any of the counters we want depends on system ticks per second as a time base.
*/
void checkForTicksTimeBase();
private:
// PDH Query
HQUERY _query{INVALID_HANDLE_VALUE};
// Typically: CPU & Memory counters
std::vector<CounterGroup> _counters;
// Typically: Disks counters
std::vector<NestedCounterGroup> _nestedCounters;
// A counter that uses ticks as a timebase
const CounterInfo* _timeBaseTicksCounter{nullptr};
};
} // namespace mongo
|