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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
|
/**
* 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 <cstdint>
#include <cstdlib>
#include <string>
#include <vector>
#include "mongo/db/index/multikey_paths.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/query/stage_types.h"
#include "mongo/util/time_support.h"
namespace mongo {
/**
* The interface all specific-to-stage stats provide.
*/
struct SpecificStats {
virtual ~SpecificStats() {}
/**
* Make a deep copy.
*/
virtual SpecificStats* clone() const = 0;
};
// Every stage has CommonStats.
struct CommonStats {
CommonStats(const char* type)
: stageTypeStr(type),
works(0),
yields(0),
unyields(0),
advanced(0),
needTime(0),
needYield(0),
executionTimeMillis(0),
failed(false),
isEOF(false) {}
// String giving the type of the stage. Not owned.
const char* stageTypeStr;
// Count calls into the stage.
size_t works;
size_t yields;
size_t unyields;
// How many times was this state the return value of work(...)?
size_t advanced;
size_t needTime;
size_t needYield;
// BSON representation of a MatchExpression affixed to this node. If there
// is no filter affixed, then 'filter' should be an empty BSONObj.
BSONObj filter;
// Time elapsed while working inside this stage.
long long executionTimeMillis;
// TODO: have some way of tracking WSM sizes (or really any series of #s). We can measure
// the size of our inputs and the size of our outputs. We can do a lot with the WS here.
// TODO: once we've picked a plan, collect different (or additional) stats for display to
// the user, eg. time_t totalTimeSpent;
// TODO: keep track of the total yield time / fetch time done for a plan.
bool failed;
bool isEOF;
private:
// Default constructor is illegal.
CommonStats();
};
// The universal container for a stage's stats.
struct PlanStageStats {
PlanStageStats(const CommonStats& c, StageType t) : stageType(t), common(c) {}
/**
* Make a deep copy.
*/
PlanStageStats* clone() const {
PlanStageStats* stats = new PlanStageStats(common, stageType);
if (specific.get()) {
stats->specific.reset(specific->clone());
}
for (size_t i = 0; i < children.size(); ++i) {
invariant(children[i]);
stats->children.emplace_back(children[i]->clone());
}
return stats;
}
// See query/stage_type.h
StageType stageType;
// Stats exported by implementing the PlanStage interface.
CommonStats common;
// Per-stage place to stash additional information
std::unique_ptr<SpecificStats> specific;
// The stats of the node's children.
std::vector<std::unique_ptr<PlanStageStats>> children;
private:
PlanStageStats(const PlanStageStats&) = delete;
PlanStageStats& operator=(const PlanStageStats&) = delete;
};
struct AndHashStats : public SpecificStats {
AndHashStats() = default;
SpecificStats* clone() const final {
AndHashStats* specific = new AndHashStats(*this);
return specific;
}
// How many entries are in the map after each child?
// child 'i' produced children[i].common.advanced RecordIds, of which mapAfterChild[i] were
// intersections.
std::vector<size_t> mapAfterChild;
// mapAfterChild[mapAfterChild.size() - 1] WSMswere match tested.
// commonstats.advanced is how many passed.
// What's our current memory usage?
size_t memUsage = 0u;
// What's our memory limit?
size_t memLimit = 0u;
};
struct AndSortedStats : public SpecificStats {
AndSortedStats() = default;
SpecificStats* clone() const final {
AndSortedStats* specific = new AndSortedStats(*this);
return specific;
}
// How many results from each child did not pass the AND?
std::vector<size_t> failedAnd;
};
struct CachedPlanStats : public SpecificStats {
CachedPlanStats() : replanned(false) {}
SpecificStats* clone() const final {
return new CachedPlanStats(*this);
}
bool replanned;
};
struct CollectionScanStats : public SpecificStats {
CollectionScanStats() : docsTested(0), direction(1) {}
SpecificStats* clone() const final {
CollectionScanStats* specific = new CollectionScanStats(*this);
return specific;
}
// How many documents did we check against our filter?
size_t docsTested;
// >0 if we're traversing the collection forwards. <0 if we're traversing it
// backwards.
int direction;
// If present, indicates that the collection scan will stop and return EOF the first time it
// sees a document that does not pass the filter and has a "ts" Timestamp field greater than
// 'maxTs'.
boost::optional<Timestamp> maxTs;
};
struct CountStats : public SpecificStats {
CountStats() : nCounted(0), nSkipped(0) {}
SpecificStats* clone() const final {
CountStats* specific = new CountStats(*this);
return specific;
}
// The result of the count.
long long nCounted;
// The number of results we skipped over.
long long nSkipped;
};
struct CountScanStats : public SpecificStats {
CountScanStats()
: indexVersion(0),
isMultiKey(false),
isPartial(false),
isSparse(false),
isUnique(false),
keysExamined(0) {}
SpecificStats* clone() const final {
CountScanStats* specific = new CountScanStats(*this);
// BSON objects have to be explicitly copied.
specific->keyPattern = keyPattern.getOwned();
specific->collation = collation.getOwned();
specific->startKey = startKey.getOwned();
specific->endKey = endKey.getOwned();
return specific;
}
std::string indexName;
BSONObj keyPattern;
BSONObj collation;
// The starting/ending key(s) of the index scan.
// startKey and endKey contain the fields of keyPattern, with values
// that match the corresponding index bounds.
BSONObj startKey;
BSONObj endKey;
// Whether or not those keys are inclusive or exclusive bounds.
bool startKeyInclusive;
bool endKeyInclusive;
int indexVersion;
// Set to true if the index used for the count scan is multikey.
bool isMultiKey;
// Represents which prefixes of the indexed field(s) cause the index to be multikey.
MultikeyPaths multiKeyPaths;
bool isPartial;
bool isSparse;
bool isUnique;
size_t keysExamined;
};
struct DeleteStats : public SpecificStats {
DeleteStats() = default;
SpecificStats* clone() const final {
return new DeleteStats(*this);
}
size_t docsDeleted = 0u;
};
struct DistinctScanStats : public SpecificStats {
SpecificStats* clone() const final {
DistinctScanStats* specific = new DistinctScanStats(*this);
// BSON objects have to be explicitly copied.
specific->keyPattern = keyPattern.getOwned();
specific->collation = collation.getOwned();
specific->indexBounds = indexBounds.getOwned();
return specific;
}
// How many keys did we look at while distinct-ing?
size_t keysExamined = 0;
BSONObj keyPattern;
BSONObj collation;
// Properties of the index used for the distinct scan.
std::string indexName;
int indexVersion = 0;
// Set to true if the index used for the distinct scan is multikey.
bool isMultiKey = false;
// Represents which prefixes of the indexed field(s) cause the index to be multikey.
MultikeyPaths multiKeyPaths;
bool isPartial = false;
bool isSparse = false;
bool isUnique = false;
// >1 if we're traversing the index forwards and <1 if we're traversing it backwards.
int direction = 1;
// A BSON representation of the distinct scan's index bounds.
BSONObj indexBounds;
};
struct EnsureSortedStats : public SpecificStats {
EnsureSortedStats() : nDropped(0) {}
SpecificStats* clone() const final {
EnsureSortedStats* specific = new EnsureSortedStats(*this);
return specific;
}
// The number of out-of-order results that were dropped.
long long nDropped;
};
struct FetchStats : public SpecificStats {
FetchStats() = default;
SpecificStats* clone() const final {
FetchStats* specific = new FetchStats(*this);
return specific;
}
// Have we seen anything that already had an object?
size_t alreadyHasObj = 0u;
// The total number of full documents touched by the fetch stage.
size_t docsExamined = 0u;
};
struct IDHackStats : public SpecificStats {
IDHackStats() : keysExamined(0), docsExamined(0) {}
SpecificStats* clone() const final {
IDHackStats* specific = new IDHackStats(*this);
return specific;
}
std::string indexName;
// Number of entries retrieved from the index while executing the idhack.
size_t keysExamined;
// Number of documents retrieved from the collection while executing the idhack.
size_t docsExamined;
};
struct IndexScanStats : public SpecificStats {
IndexScanStats()
: indexVersion(0),
direction(1),
isMultiKey(false),
isPartial(false),
isSparse(false),
isUnique(false),
dupsTested(0),
dupsDropped(0),
keysExamined(0),
seeks(0) {}
SpecificStats* clone() const final {
IndexScanStats* specific = new IndexScanStats(*this);
// BSON objects have to be explicitly copied.
specific->keyPattern = keyPattern.getOwned();
specific->collation = collation.getOwned();
specific->indexBounds = indexBounds.getOwned();
return specific;
}
// Index type being used.
std::string indexType;
// name of the index being used
std::string indexName;
BSONObj keyPattern;
BSONObj collation;
int indexVersion;
// A BSON (opaque, ie. hands off other than toString() it) representation of the bounds
// used.
BSONObj indexBounds;
// >1 if we're traversing the index along with its order. <1 if we're traversing it
// against the order.
int direction;
// index properties
// Whether this index is over a field that contain array values.
bool isMultiKey;
// Represents which prefixes of the indexed field(s) cause the index to be multikey.
MultikeyPaths multiKeyPaths;
bool isPartial;
bool isSparse;
bool isUnique;
size_t dupsTested;
size_t dupsDropped;
// Number of entries retrieved from the index during the scan.
size_t keysExamined;
// Number of times the index cursor is re-positioned during the execution of the scan.
size_t seeks;
};
struct LimitStats : public SpecificStats {
LimitStats() : limit(0) {}
SpecificStats* clone() const final {
LimitStats* specific = new LimitStats(*this);
return specific;
}
size_t limit;
};
struct MockStats : public SpecificStats {
MockStats() {}
SpecificStats* clone() const final {
return new MockStats(*this);
}
};
struct MultiPlanStats : public SpecificStats {
MultiPlanStats() {}
SpecificStats* clone() const final {
return new MultiPlanStats(*this);
}
};
struct OrStats : public SpecificStats {
OrStats() = default;
SpecificStats* clone() const final {
OrStats* specific = new OrStats(*this);
return specific;
}
size_t dupsTested = 0u;
size_t dupsDropped = 0u;
};
struct ProjectionStats : public SpecificStats {
ProjectionStats() {}
SpecificStats* clone() const final {
ProjectionStats* specific = new ProjectionStats(*this);
return specific;
}
// Object specifying the projection transformation to apply.
BSONObj projObj;
};
struct SortStats : public SpecificStats {
SortStats() = default;
SpecificStats* clone() const final {
SortStats* specific = new SortStats(*this);
return specific;
}
// What's our current memory usage?
size_t memUsage = 0u;
// What's our memory limit?
size_t memLimit = 0u;
// The number of results to return from the sort.
size_t limit = 0u;
// The pattern according to which we are sorting.
BSONObj sortPattern;
};
struct MergeSortStats : public SpecificStats {
MergeSortStats() = default;
SpecificStats* clone() const final {
MergeSortStats* specific = new MergeSortStats(*this);
return specific;
}
size_t dupsTested = 0u;
size_t dupsDropped = 0u;
// The pattern according to which we are sorting.
BSONObj sortPattern;
};
struct ShardingFilterStats : public SpecificStats {
ShardingFilterStats() : chunkSkips(0) {}
SpecificStats* clone() const final {
ShardingFilterStats* specific = new ShardingFilterStats(*this);
return specific;
}
size_t chunkSkips;
};
struct SkipStats : public SpecificStats {
SkipStats() : skip(0) {}
SpecificStats* clone() const final {
SkipStats* specific = new SkipStats(*this);
return specific;
}
size_t skip;
};
struct IntervalStats {
// Number of results found in the covering of this interval.
long long numResultsBuffered = 0;
// Number of documents in this interval returned to the parent stage.
long long numResultsReturned = 0;
// Min distance of this interval - always inclusive.
double minDistanceAllowed = -1;
// Max distance of this interval - inclusive iff inclusiveMaxDistanceAllowed.
double maxDistanceAllowed = -1;
// True only in the last interval.
bool inclusiveMaxDistanceAllowed = false;
};
struct NearStats : public SpecificStats {
NearStats() : indexVersion(0) {}
SpecificStats* clone() const final {
return new NearStats(*this);
}
std::vector<IntervalStats> intervalStats;
std::string indexName;
// btree index version, not geo index version
int indexVersion;
BSONObj keyPattern;
};
struct UpdateStats : public SpecificStats {
UpdateStats() : nMatched(0), nModified(0), isModUpdate(false), inserted(false) {}
SpecificStats* clone() const final {
return new UpdateStats(*this);
}
// The number of documents which match the query part of the update.
size_t nMatched;
// The number of documents modified by this update.
size_t nModified;
// True iff this is a $mod update.
bool isModUpdate;
// Is this an {upsert: true} update that did an insert?
bool inserted;
// The object that was inserted. This is an empty document if no insert was performed.
BSONObj objInserted;
};
struct TextStats : public SpecificStats {
TextStats() : parsedTextQuery(), textIndexVersion(0) {}
SpecificStats* clone() const final {
TextStats* specific = new TextStats(*this);
return specific;
}
std::string indexName;
// Human-readable form of the FTSQuery associated with the text stage.
BSONObj parsedTextQuery;
int textIndexVersion;
// Index keys that precede the "text" index key.
BSONObj indexPrefix;
};
struct TextMatchStats : public SpecificStats {
TextMatchStats() : docsRejected(0) {}
SpecificStats* clone() const final {
TextMatchStats* specific = new TextMatchStats(*this);
return specific;
}
size_t docsRejected;
};
struct TextOrStats : public SpecificStats {
TextOrStats() : fetches(0) {}
SpecificStats* clone() const final {
TextOrStats* specific = new TextOrStats(*this);
return specific;
}
size_t fetches;
};
struct TrialStats : public SpecificStats {
SpecificStats* clone() const final {
TrialStats* specific = new TrialStats(*this);
return specific;
}
size_t trialPeriodMaxWorks = 0;
double successThreshold = 0;
size_t trialWorks = 0;
size_t trialAdvanced = 0;
bool trialCompleted = false;
bool trialSucceeded = false;
};
} // namespace mongo
|