summaryrefslogtreecommitdiff
path: root/src/mongo/db/collection_index_usage_tracker_test.cpp
blob: a532e91a152fcf8cedae375e7d0119159475653f (plain)
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
/**
 *    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.
 */

#include "mongo/platform/basic.h"

#include "mongo/db/collection_index_usage_tracker.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/jsobj.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/clock_source_mock.h"

namespace mongo {
namespace {

class CollectionIndexUsageTrackerTest : public unittest::Test {
protected:
    CollectionIndexUsageTrackerTest() : _tracker(&_globalIndexUsage, &_clockSource) {}

    /**
     * Returns an unowned pointer to the tracker owned by this test fixture.
     */
    CollectionIndexUsageTracker* getTracker() {
        return &_tracker;
    }

    /**
     * Returns an unowned pointer to the mock clock source owned by this test fixture.
     */
    ClockSourceMock* getClockSource() {
        return &_clockSource;
    }

    GlobalIndexUsageTracker* getGlobalIndexUsage() {
        return &_globalIndexUsage;
    }

private:
    GlobalIndexUsageTracker _globalIndexUsage;
    ClockSourceMock _clockSource;
    CollectionIndexUsageTracker _tracker;
};

// Test that a newly contructed tracker has an empty map.
TEST_F(CollectionIndexUsageTrackerTest, Empty) {
    ASSERT(getTracker()->getUsageStats()->empty());
}

// Test that recording of a single index hit is reflected in returned stats map.
TEST_F(CollectionIndexUsageTrackerTest, SingleHit) {
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->recordIndexAccess("foo");
    auto statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(1, statsMap->at("foo")->accesses.loadRelaxed());
}

// Test that recording of multiple index hits are reflected in stats map.
TEST_F(CollectionIndexUsageTrackerTest, MultipleHit) {
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->recordIndexAccess("foo");
    getTracker()->recordIndexAccess("foo");
    auto statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(2, statsMap->at("foo")->accesses.loadRelaxed());
}

// Test that an index is registered correctly with indexKey.
TEST_F(CollectionIndexUsageTrackerTest, IndexKey) {
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    auto statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_BSONOBJ_EQ(BSON("foo" << 1), statsMap->at("foo")->indexKey);
}

// Test that index registration generates an entry in the stats map.
TEST_F(CollectionIndexUsageTrackerTest, Register) {
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    ASSERT_EQUALS(1U, getTracker()->getUsageStats()->size());
    getTracker()->registerIndex("bar", BSON("bar" << 1), {});
    ASSERT_EQUALS(2U, getTracker()->getUsageStats()->size());
}

// Test that index deregistration results in removal of an entry from the stats map.
TEST_F(CollectionIndexUsageTrackerTest, Deregister) {
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->registerIndex("bar", BSON("bar" << 1), {});
    ASSERT_EQUALS(2U, getTracker()->getUsageStats()->size());
    getTracker()->unregisterIndex("foo");
    ASSERT_EQUALS(1U, getTracker()->getUsageStats()->size());
    getTracker()->unregisterIndex("bar");
    ASSERT_EQUALS(0U, getTracker()->getUsageStats()->size());
}

// Test that index deregistration results in reset of the usage counter.
TEST_F(CollectionIndexUsageTrackerTest, HitAfterDeregister) {
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->recordIndexAccess("foo");
    getTracker()->recordIndexAccess("foo");
    auto statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(2, statsMap->at("foo")->accesses.loadRelaxed());

    getTracker()->unregisterIndex("foo");
    statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") == statsMap->end());

    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->recordIndexAccess("foo");
    statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(1, statsMap->at("foo")->accesses.loadRelaxed());
}

// Test that index tracker start date/time is reset on index deregistration/registration.
TEST_F(CollectionIndexUsageTrackerTest, DateTimeAfterDeregister) {
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    auto statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(statsMap->at("foo")->trackerStartTime, getClockSource()->now());

    getTracker()->unregisterIndex("foo");
    statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") == statsMap->end());

    // Increment clock source so that a new index registration has different start time.
    getClockSource()->advance(Milliseconds(1));

    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(statsMap->at("foo")->trackerStartTime, getClockSource()->now());
}

// Test that the fetched stats map retains an index after the entry is concurrently removed.
TEST_F(CollectionIndexUsageTrackerTest, UsageStatsMapRemainsValidAfterIndexErasure) {
    // Set up an index in the tracker.
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->recordIndexAccess("foo");
    getTracker()->recordIndexAccess("foo");
    auto statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(2, statsMap->at("foo")->accesses.loadRelaxed());

    // Fetch the map with the index and then erase the index from the map. The previously fetched
    // map should still safely retain the index.
    auto staleStatsMap = getTracker()->getUsageStats();

    getTracker()->unregisterIndex("foo");
    statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") == statsMap->end());

    ASSERT(staleStatsMap->find("foo") != staleStatsMap->end());
    ASSERT_EQUALS(2, staleStatsMap->at("foo")->accesses.loadRelaxed());
}

// Test that a stale stats map copy's index remains unmodified after the up-to-date map removes and
// recreates the index.
TEST_F(CollectionIndexUsageTrackerTest, StaleUsageStatsMapEntryIsNotUpdatedAfterErasure) {
    // Set up an index in the tracker.
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->recordIndexAccess("foo");
    auto statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(1, statsMap->at("foo")->accesses.loadRelaxed());

    // Fetch a copy of the map with the index and then erase and recreate the index in the map with
    // a different usage count. The previously fetched copy of the map should still safely retain
    // the prior index version of the index with a different usage count.
    auto staleStatsMap = getTracker()->getUsageStats();

    getTracker()->unregisterIndex("foo");
    getTracker()->registerIndex("foo", BSON("foo" << 1), {});
    getTracker()->recordIndexAccess("foo");
    getTracker()->recordIndexAccess("foo");
    statsMap = getTracker()->getUsageStats();
    ASSERT(statsMap->find("foo") != statsMap->end());
    ASSERT_EQUALS(2, statsMap->at("foo")->accesses.loadRelaxed());

    ASSERT(staleStatsMap->find("foo") != staleStatsMap->end());
    ASSERT_EQUALS(1, staleStatsMap->at("foo")->accesses.loadRelaxed());
}

namespace {
int getFeatureUseCount(GlobalIndexUsageTracker* globalIndexUsage, std::string featureSearch) {
    int count = 0;
    globalIndexUsage->forEachFeature([&](auto feature, auto& stats) {
        if (featureSearch == feature) {
            count += stats.count.load();
        }
    });
    return count;
}

int getFeatureAccessCount(GlobalIndexUsageTracker* globalIndexUsage, std::string featureSearch) {
    int accesses = 0;
    globalIndexUsage->forEachFeature([&](auto feature, auto& stats) {
        if (featureSearch == feature) {
            accesses += stats.accesses.load();
        }
    });
    return accesses;
}
}  // namespace

TEST_F(CollectionIndexUsageTrackerTest, GlobalFeatureUsageBasic) {
    auto idSpec = BSON("key" << BSON("_id" << 1) << "unique" << true << "v" << 2);
    auto idDesc = IndexDescriptor("", idSpec);
    getTracker()->registerIndex("_id_", idSpec, IndexFeatures::make(&idDesc, false /* internal */));
    getTracker()->recordIndexAccess("_id_");

    ASSERT_EQ(1, getGlobalIndexUsage()->getCount());
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "unique"));

    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(0, getFeatureAccessCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(0, getFeatureAccessCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(0, getFeatureAccessCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(0, getFeatureAccessCount(getGlobalIndexUsage(), "unique"));

    auto spec = BSON("key" << BSON("foo" << 1) << "unique" << true << "sparse" << true << "v" << 2);
    auto desc = IndexDescriptor("", spec);
    getTracker()->registerIndex("foo", spec, IndexFeatures::make(&desc, false /* internal */));
    getTracker()->recordIndexAccess("foo");

    ASSERT_EQ(2, getGlobalIndexUsage()->getCount());
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "unique"));

    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "unique"));

    // Register an internal index and expect nothing to change.
    getTracker()->registerIndex("foo2", spec, IndexFeatures::make(&desc, true /* internal */));

    ASSERT_EQ(2, getGlobalIndexUsage()->getCount());
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "unique"));

    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "unique"));

    getTracker()->unregisterIndex("foo2");
    ASSERT_EQ(2, getGlobalIndexUsage()->getCount());
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "unique"));

    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "unique"));

    getTracker()->unregisterIndex("foo");
    ASSERT_EQ(1, getGlobalIndexUsage()->getCount());
    ASSERT_EQ(1, getFeatureUseCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "unique"));

    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "unique"));

    getTracker()->unregisterIndex("_id_");
    ASSERT_EQ(0, getGlobalIndexUsage()->getCount());
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(0, getFeatureUseCount(getGlobalIndexUsage(), "unique"));

    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "id"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "normal"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "single"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "sparse"));
    ASSERT_EQ(1, getFeatureAccessCount(getGlobalIndexUsage(), "unique"));
}

}  // namespace
}  // namespace mongo