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
|
/**
* Tests that the query engine used is recorded correctly in the logs, system.profile, and
* serverStatus.
*/
(function() {
"use strict";
// For 'getLatestProfilerEntry()'.
load("jstests/libs/profiler.js");
const conn = MongoRunner.runMongod({});
assert.neq(null, conn, "mongod was unable to start up");
const db = conn.getDB(jsTestName());
assert.commandWorked(db.dropDatabase());
const coll = db.collection;
// Set logLevel to 1 so that all queries will be logged.
assert.commandWorked(db.setLogLevel(1));
// Set profiling level to profile all queries.
assert.commandWorked(db.setProfilingLevel(2));
// Set up the collection.
assert.commandWorked(coll.insertMany([
{_id: 0, a: 1, b: 1, c: 1},
{_id: 1, a: 2, b: 1, c: 2},
{_id: 2, a: 3, b: 1, c: 3},
{_id: 3, a: 4, b: 2, c: 4}
]));
const engine = {
find: {sbe: "sbe", classic: "classic"},
aggregate: {
sbeHybrid: "sbeHybrid",
classicHybrid: "classicHybrid",
sbeOnly: "sbeOnly",
classicOnly: "classicOnly"
}
};
// Ensure the slow query log contains the correct information about the queryExecutionEngine used.
function verifySlowQueryLog(expectedComment, execEngine) {
const logId = 51803;
const expectedLog = {};
expectedLog.command = {};
expectedLog.command.comment = expectedComment;
if (execEngine) {
expectedLog.queryExecutionEngine = execEngine;
}
assert(checkLog.checkContainsWithCountJson(db, logId, expectedLog, 1, null, true),
"failed to find [" + tojson(expectedLog) + "] in the slow query log");
}
// Ensure the profile filter contains the correct information about the queryExecutionEngine used.
function verifyProfiler(expectedComment, execEngine) {
const profileEntryFilter = {ns: "query_engine_stats.collection"};
const profileObj = getLatestProfilerEntry(db, profileEntryFilter);
try {
assert.eq(profileObj.command.comment, expectedComment);
if (execEngine) {
assert.eq(profileObj.queryExecutionEngine, execEngine);
}
} catch (e) {
print('failed to find [{ "queryExecutionEngine" : "' + execEngine + '", { "comment" : "' +
expectedComment + '"} }] in the latest profiler entry.');
throw (e);
}
}
// Create an object with the correct queryExecutionEngine counter values after the specified type of
// query.
function generateExpectedCounters(execEngine) {
let counters = db.serverStatus().metrics.query.queryExecutionEngine;
assert(counters, "counters did not exist");
let expected = Object.assign(counters);
switch (execEngine) {
case engine.find.sbe:
expected.find.sbe = NumberLong(expected.find.sbe + 1);
break;
case engine.find.classic:
expected.find.classic = NumberLong(expected.find.classic + 1);
break;
case engine.aggregate.sbeOnly:
expected.aggregate.sbeOnly = NumberLong(expected.aggregate.sbeOnly + 1);
break;
case engine.aggregate.classicOnly:
expected.aggregate.classicOnly = NumberLong(expected.aggregate.classicOnly + 1);
break;
case engine.aggregate.sbeHybrid:
expected.aggregate.sbeHybrid = NumberLong(expected.aggregate.sbeHybrid + 1);
break;
case engine.aggregate.classicHybrid:
expected.aggregate.classicHybrid = NumberLong(expected.aggregate.classicHybrid + 1);
break;
}
return expected;
}
// Compare the values of the queryExecutionEngine counters to an object that represents the expected
// values.
function compareQueryEngineCounters(expectedCounters) {
let counters = db.serverStatus().metrics.query.queryExecutionEngine;
assert.docEq(counters, expectedCounters);
}
// Start with SBE off.
assert.commandWorked(
db.adminCommand({setParameter: 1, internalQueryEnableSlotBasedExecutionEngine: false}));
// Run a find command.
let expectedCounters = generateExpectedCounters(engine.find.classic);
let queryComment = "findSbeOff";
assert.eq(coll.find({a: 3}).comment(queryComment).itcount(), 1);
verifySlowQueryLog(queryComment, engine.find.classic);
compareQueryEngineCounters(expectedCounters);
verifyProfiler(queryComment, engine.find.classic);
// Run an aggregation that doesn't use DocumentSource.
expectedCounters = generateExpectedCounters(engine.aggregate.classicOnly);
queryComment = "aggSbeOff";
assert.eq(coll.aggregate([{$match: {b: 1, c: 3}}], {comment: queryComment}).itcount(), 1);
verifySlowQueryLog(queryComment, engine.find.classic);
compareQueryEngineCounters(expectedCounters);
verifyProfiler(queryComment, engine.find.classic);
// Run an aggregation that uses DocumentSource.
expectedCounters = generateExpectedCounters(engine.aggregate.classicHybrid);
queryComment = "docSourceSbeOff";
assert.eq(coll.aggregate(
[
{$_internalInhibitOptimization: {}},
{$group: {_id: "$a", acc: {$sum: "$b"}}},
{$match: {acc: 42}}
],
{comment: queryComment})
.itcount(),
0);
verifySlowQueryLog(queryComment, engine.find.classic);
compareQueryEngineCounters(expectedCounters);
verifyProfiler(queryComment, engine.find.classic);
// Turn SBE on.
assert.commandWorked(
db.adminCommand({setParameter: 1, internalQueryEnableSlotBasedExecutionEngine: true}));
// Run a find command.
expectedCounters = generateExpectedCounters(engine.find.sbe);
queryComment = "findSbeOn";
assert.eq(coll.find({a: 3}).comment(queryComment).itcount(), 1);
verifySlowQueryLog(queryComment, engine.find.sbe);
compareQueryEngineCounters(expectedCounters);
verifyProfiler(queryComment, engine.find.sbe);
// Run an aggregation that doesn't use DocumentSource.
expectedCounters = generateExpectedCounters(engine.aggregate.sbeOnly);
queryComment = "aggSbeOn";
assert.eq(coll.aggregate([{$match: {b: 1, c: 3}}], {comment: queryComment}).itcount(), 1);
verifySlowQueryLog(queryComment, engine.find.sbe);
compareQueryEngineCounters(expectedCounters);
verifyProfiler(queryComment, engine.find.sbe);
// Run an aggregation that uses DocumentSource.
expectedCounters = generateExpectedCounters(engine.aggregate.sbeHybrid);
queryComment = "docSourceSbeOn";
assert.eq(coll.aggregate(
[
{$_internalInhibitOptimization: {}},
{$group: {_id: "$a", acc: {$sum: "$b"}}},
{$match: {acc: 42}}
],
{comment: queryComment})
.itcount(),
0);
verifySlowQueryLog(queryComment, engine.find.sbe);
compareQueryEngineCounters(expectedCounters);
verifyProfiler(queryComment, engine.find.sbe);
MongoRunner.stopMongod(conn);
})();
|
