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
|
/**
* Tests that planCacheTotalSizeEstimateBytes metric is updated when entries are added or evicted
* from SBE and Classic Plan Cache entries.
*
* @tags: [
* # Needed as the setParameter for ForceClassicEngine was introduced in 5.1.
* requires_fcv_51,
* # If all chunks are moved off of a shard, it can cause the plan cache to miss commands.
* assumes_balancer_off,
* does_not_support_stepdowns,
* # TODO SERVER-67607: Test plan cache with CQF enabled.
* cqf_incompatible,
* ]
*/
(function() {
"use strict";
load("jstests/libs/sbe_util.js"); // For checkSBEEnabled.
load('jstests/libs/fixture_helpers.js'); // For FixtureHelpers.
const conn = MongoRunner.runMongod();
assert.neq(conn, null, "mongod failed to start");
const db = conn.getDB("sbe_plan_cache_size_metric");
if (!checkSBEEnabled(db, ["featureFlagSbeFull"])) {
jsTest.log("Skipping test because SBE is not fully enabled");
MongoRunner.stopMongod(conn);
return;
}
function getCacheEntriesByQueryHashKey(coll, queryHash) {
return coll.aggregate([{$planCacheStats: {}}, {$match: {queryHash}}]).toArray();
}
function getQueryHashFromExplain(explainRes) {
const hash = FixtureHelpers.isMongos(db)
? explainRes.queryPlanner.winningPlan.shards[0].queryHash
: explainRes.queryPlanner.queryHash;
assert.eq(typeof (hash), "string");
return hash;
}
function getPlanCacheSize() {
return db.serverStatus().metrics.query.planCacheTotalSizeEstimateBytes;
}
function getPlanCacheNumEntries() {
return db.serverStatus().metrics.query.planCacheTotalQueryShapes;
}
function assertQueryInPlanCache(coll, query) {
const explainResult = assert.commandWorked(coll.explain().find(query).finish());
const queryHash = getQueryHashFromExplain(explainResult, db);
const planCacheEntries = getCacheEntriesByQueryHashKey(coll, queryHash);
assert.eq(1, planCacheEntries.length, planCacheEntries);
}
const collectionName = "plan_cache_sbe";
const coll = db[collectionName];
coll.drop();
assert.commandWorked(coll.insert({a: 1, b: 1, c: 1}));
// We need some indexes so that the multi-planner is executed.
assert.commandWorked(coll.createIndex({a: 1}));
assert.commandWorked(coll.createIndex({c: 1}));
assert.commandWorked(coll.createIndex({a: 1, b: 1}));
const initialPlanCacheSize = getPlanCacheSize();
// Plan cache must be empty.
assert.eq(0, getPlanCacheNumEntries());
const sbeQuery = {
a: 1
};
const classicQuery = {
a: 1,
c: 1
};
// Step 1. Insert an entry to SBE Plan Cache.
assert.eq(1, coll.find(sbeQuery).itcount());
assertQueryInPlanCache(coll, sbeQuery);
// Plan Cache must contain exactly 1 entry.
assert.eq(1, getPlanCacheNumEntries());
// Assert metric is incremented for new cache entry.
const afterSbePlanCacheSize = getPlanCacheSize();
assert.gt(afterSbePlanCacheSize, initialPlanCacheSize);
// Step 2. Insert an entry to Classic Plan Cache.
// Force classic plan cache.
assert.commandWorked(
db.adminCommand({setParameter: 1, internalQueryFrameworkControl: "forceClassicEngine"}));
assert.eq(1, coll.find(classicQuery).itcount());
assertQueryInPlanCache(coll, classicQuery);
// Plan Cache must contain exactly 2 entries.
assert.eq(2, getPlanCacheNumEntries());
// Assert metric is incremented for new cache entry.
const afterClassicPlanCacheSize = getPlanCacheSize();
assert.gt(afterClassicPlanCacheSize, afterSbePlanCacheSize);
// Step 3. Remove the entry from Classic Plan Cache.
// Clean up Classic Plan Cache.
assert.commandWorked(db.runCommand({planCacheClear: collectionName, query: classicQuery}));
// Assert metric is decremented back to values before insering classic plan cache entry.
assert.eq(afterSbePlanCacheSize, getPlanCacheSize());
// Step 4. Remove the entry from SBE Plan Cache.
// Move back to SBE plan cache.
assert.commandWorked(
db.adminCommand({setParameter: 1, internalQueryFrameworkControl: "trySbeEngine"}));
// Clean up SBE Plan Cache
assert.commandWorked(db.runCommand({planCacheClear: collectionName, query: sbeQuery}));
// Assert metric is decremented back to initial value.
assert.eq(initialPlanCacheSize, getPlanCacheSize());
MongoRunner.stopMongod(conn);
})();
|
