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
|
/**
* 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/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/platform/atomic_word.h"
#include "mongo/util/string_map.h"
#include "mongo/util/time_support.h"
namespace mongo {
class ClockSource;
/**
* CollectionIndexUsageTracker tracks index usage statistics for a collection. An index is
* considered "used" when it appears as part of a winning plan for an operation that uses the
* query system.
*
* It also tracks non-usage of indexes. I.e. it collects information about collection scans that
* occur on a collection.
*
* Indexes must be registered and deregistered on creation/destruction.
*/
class CollectionIndexUsageTracker {
CollectionIndexUsageTracker(const CollectionIndexUsageTracker&) = delete;
CollectionIndexUsageTracker& operator=(const CollectionIndexUsageTracker&) = delete;
public:
struct CollectionScanStats {
unsigned long long collectionScans{0};
unsigned long long collectionScansNonTailable{0};
};
struct IndexUsageStats {
IndexUsageStats() = default;
explicit IndexUsageStats(Date_t now, const BSONObj& key)
: trackerStartTime(now), indexKey(key.getOwned()) {}
IndexUsageStats(const IndexUsageStats& other)
: accesses(other.accesses.load()),
trackerStartTime(other.trackerStartTime),
indexKey(other.indexKey) {}
IndexUsageStats& operator=(const IndexUsageStats& other) {
accesses.store(other.accesses.load());
trackerStartTime = other.trackerStartTime;
indexKey = other.indexKey;
return *this;
}
// Number of operations that have used this index.
AtomicWord<long long> accesses;
// Date/Time that we started tracking index usage.
Date_t trackerStartTime;
// An owned copy of the associated IndexDescriptor's index key.
BSONObj indexKey;
};
/**
* Constructs a CollectionIndexUsageTracker.
*
* Does not take ownership of 'clockSource'. 'clockSource' must refer to a non-null clock
* source that is valid for the lifetime of the constructed CollectionIndexUsageTracker.
*/
explicit CollectionIndexUsageTracker(ClockSource* clockSource);
/**
* Record that an operation used index 'indexName'. Safe to be called by multiple threads
* concurrently.
*/
void recordIndexAccess(StringData indexName);
/**
* Add map entry for 'indexName' stats collection. Must be called under exclusive collection
* lock.
*/
void registerIndex(StringData indexName, const BSONObj& indexKey);
/**
* Erase statistics for index 'indexName'. Must be called under exclusive collection lock.
* Can be called even if indexName is not registered. This is possible under certain failure
* scenarios.
*/
void unregisterIndex(StringData indexName);
/**
* Get the current state of the usage statistics map. This map will only include indexes that
* exist at the time of calling. Must be called while holding the collection lock in any mode.
*/
StringMap<CollectionIndexUsageTracker::IndexUsageStats> getUsageStats() const;
/**
* Get the current state of the usage of collection scans. This struct will only include
* information about the collection scans that have occured at the time of calling.
*/
CollectionScanStats getCollectionScanStats() const;
void recordCollectionScans(unsigned long long collectionScans);
void recordCollectionScansNonTailable(unsigned long long collectionScansNonTailable);
private:
// Map from index name to usage statistics.
StringMap<CollectionIndexUsageTracker::IndexUsageStats> _indexUsageMap;
// Clock source. Used when the 'trackerStartTime' time for an IndexUsageStats object needs to
// be set.
ClockSource* _clockSource;
AtomicWord<unsigned long long> _collectionScans{0};
AtomicWord<unsigned long long> _collectionScansNonTailable{0};
};
typedef StringMap<CollectionIndexUsageTracker::IndexUsageStats> CollectionIndexUsageMap;
} // namespace mongo
|
