/
curop.cpp
1825 lines (1566 loc) · 70 KB
/
curop.cpp
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
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* 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.
*/
// CHECK_LOG_REDACTION
#include "mongo/db/curop.h"
#include "mongo/util/duration.h"
#include <iomanip>
#include "mongo/bson/mutable/document.h"
#include "mongo/config.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/client.h"
#include "mongo/db/commands.h"
#include "mongo/db/commands/server_status_metric.h"
#include "mongo/db/concurrency/d_concurrency.h"
#include "mongo/db/json.h"
#include "mongo/db/prepare_conflict_tracker.h"
#include "mongo/db/profile_filter.h"
#include "mongo/db/query/getmore_command_gen.h"
#include "mongo/db/query/plan_summary_stats.h"
#include "mongo/db/query/telemetry.h"
#include "mongo/db/stats/timer_stats.h"
#include "mongo/db/storage/storage_engine_feature_flags_gen.h"
#include "mongo/logv2/log.h"
#include "mongo/rpc/metadata/client_metadata.h"
#include "mongo/rpc/metadata/impersonated_user_metadata.h"
#include "mongo/transport/service_executor.h"
#include "mongo/util/hex.h"
#include "mongo/util/log_with_sampling.h"
#include "mongo/util/namespace_string_util.h"
#include "mongo/util/net/socket_utils.h"
#include "mongo/util/str.h"
#include "mongo/util/system_tick_source.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kDefault
namespace mongo {
namespace {
auto& oplogGetMoreStats = makeServerStatusMetric<TimerStats>("repl.network.oplogGetMoresProcessed");
BSONObj serializeDollarDbInOpDescription(boost::optional<TenantId> tenantId,
const BSONObj& cmdObj) {
auto db = cmdObj["$db"];
if (!db) {
return cmdObj;
}
auto dbName = DatabaseNameUtil::deserialize(tenantId, db.String());
auto newCmdObj =
cmdObj.addField(BSON("$db" << DatabaseNameUtil::serialize(dbName)).firstElement());
return newCmdObj;
}
} // namespace
/**
* This type decorates a Client object with a stack of active CurOp objects.
*
* It encapsulates the nesting logic for curops attached to a Client, along with
* the notion that there is always a root CurOp attached to a Client.
*
* The stack itself is represented in the _parent pointers of the CurOp class.
*/
class CurOp::CurOpStack {
CurOpStack(const CurOpStack&) = delete;
CurOpStack& operator=(const CurOpStack&) = delete;
public:
CurOpStack() : _base(nullptr, this) {}
/**
* Returns the top of the CurOp stack.
*/
CurOp* top() const {
return _top;
}
/**
* Adds "curOp" to the top of the CurOp stack for a client. Called by CurOp's constructor.
*/
void push(OperationContext* opCtx, CurOp* curOp) {
invariant(opCtx);
if (_opCtx) {
invariant(_opCtx == opCtx);
} else {
_opCtx = opCtx;
}
stdx::lock_guard<Client> lk(*_opCtx->getClient());
push_nolock(curOp);
}
void push_nolock(CurOp* curOp) {
invariant(!curOp->_parent);
curOp->_parent = _top;
_top = curOp;
}
/**
* Pops the top off the CurOp stack for a Client. Called by CurOp's destructor.
*/
CurOp* pop() {
// It is not necessary to lock when popping the final item off of the curop stack. This
// is because the item at the base of the stack is owned by the stack itself, and is not
// popped until the stack is being destroyed. By the time the stack is being destroyed,
// no other threads can be observing the Client that owns the stack, because it has been
// removed from its ServiceContext's set of owned clients. Further, because the last
// item is popped in the destructor of the stack, and that destructor runs during
// destruction of the owning client, it is not safe to access other member variables of
// the client during the final pop.
const bool shouldLock = _top->_parent;
if (shouldLock) {
invariant(_opCtx);
_opCtx->getClient()->lock();
}
invariant(_top);
CurOp* retval = _top;
_top = _top->_parent;
if (shouldLock) {
_opCtx->getClient()->unlock();
}
return retval;
}
private:
OperationContext* _opCtx = nullptr;
// Top of the stack of CurOps for a Client.
CurOp* _top = nullptr;
// The bottom-most CurOp for a client.
const CurOp _base;
};
const OperationContext::Decoration<CurOp::CurOpStack> CurOp::_curopStack =
OperationContext::declareDecoration<CurOp::CurOpStack>();
CurOp* CurOp::get(const OperationContext* opCtx) {
return get(*opCtx);
}
CurOp* CurOp::get(const OperationContext& opCtx) {
return _curopStack(opCtx).top();
}
void CurOp::reportCurrentOpForClient(OperationContext* opCtx,
Client* client,
bool truncateOps,
bool backtraceMode,
BSONObjBuilder* infoBuilder) {
invariant(client);
OperationContext* clientOpCtx = client->getOperationContext();
infoBuilder->append("type", "op");
const std::string hostName = getHostNameCachedAndPort();
infoBuilder->append("host", hostName);
client->reportState(*infoBuilder);
if (auto clientMetadata = ClientMetadata::get(client)) {
auto appName = clientMetadata->getApplicationName();
if (!appName.empty()) {
infoBuilder->append("appName", appName);
}
auto clientMetadataDocument = clientMetadata->getDocument();
infoBuilder->append("clientMetadata", clientMetadataDocument);
}
// Fill out the rest of the BSONObj with opCtx specific details.
infoBuilder->appendBool("active", client->hasAnyActiveCurrentOp());
infoBuilder->append("currentOpTime",
opCtx->getServiceContext()->getPreciseClockSource()->now().toString());
auto authSession = AuthorizationSession::get(client);
// Depending on whether the authenticated user is the same user which ran the command,
// this might be "effectiveUsers" or "runBy".
const auto serializeAuthenticatedUsers = [&](StringData name) {
if (authSession->isAuthenticated()) {
BSONArrayBuilder users(infoBuilder->subarrayStart(name));
authSession->getAuthenticatedUserName()->serializeToBSON(&users);
}
};
auto maybeImpersonationData = rpc::getImpersonatedUserMetadata(clientOpCtx);
if (maybeImpersonationData) {
BSONArrayBuilder users(infoBuilder->subarrayStart("effectiveUsers"));
if (maybeImpersonationData->getUser()) {
maybeImpersonationData->getUser()->serializeToBSON(&users);
} else if (maybeImpersonationData->getUsers()) {
for (const auto& user : maybeImpersonationData->getUsers().get()) {
user.serializeToBSON(&users);
}
}
users.doneFast();
serializeAuthenticatedUsers("runBy"_sd);
} else {
serializeAuthenticatedUsers("effectiveUsers"_sd);
}
if (const auto seCtx = transport::ServiceExecutorContext::get(client)) {
infoBuilder->append("threaded"_sd, seCtx->useDedicatedThread());
}
if (clientOpCtx) {
infoBuilder->append("opid", static_cast<int>(clientOpCtx->getOpID()));
if (auto opKey = clientOpCtx->getOperationKey()) {
opKey->appendToBuilder(infoBuilder, "operationKey");
}
if (clientOpCtx->isKillPending()) {
infoBuilder->append("killPending", true);
}
if (auto lsid = clientOpCtx->getLogicalSessionId()) {
BSONObjBuilder lsidBuilder(infoBuilder->subobjStart("lsid"));
lsid->serialize(&lsidBuilder);
}
CurOp::get(clientOpCtx)->reportState(clientOpCtx, infoBuilder, truncateOps);
}
#ifndef MONGO_CONFIG_USE_RAW_LATCHES
if (auto diagnostic = DiagnosticInfo::get(*client)) {
BSONObjBuilder waitingForLatchBuilder(infoBuilder->subobjStart("waitingForLatch"));
waitingForLatchBuilder.append("timestamp", diagnostic->getTimestamp());
waitingForLatchBuilder.append("captureName", diagnostic->getCaptureName());
if (backtraceMode) {
BSONArrayBuilder backtraceBuilder(waitingForLatchBuilder.subarrayStart("backtrace"));
/** This branch becomes useful again with SERVER-44091
for (const auto& frame : diagnostic->makeStackTrace().frames) {
BSONObjBuilder backtraceObj(backtraceBuilder.subobjStart());
backtraceObj.append("addr", unsignedHex(frame.instructionOffset));
backtraceObj.append("path", frame.objectPath);
}
*/
}
}
#endif
}
bool CurOp::currentOpBelongsToTenant(Client* client, TenantId tenantId) {
invariant(client);
OperationContext* clientOpCtx = client->getOperationContext();
if (!clientOpCtx || (CurOp::get(clientOpCtx))->getNSS().tenantId() != tenantId) {
return false;
}
return true;
}
void CurOp::setOpDescription_inlock(const BSONObj& opDescription) {
_opDescription = serializeDollarDbInOpDescription(_nss.tenantId(), opDescription);
}
void CurOp::setGenericCursor_inlock(GenericCursor gc) {
_genericCursor = std::move(gc);
}
void CurOp::_finishInit(OperationContext* opCtx, CurOpStack* stack) {
_stack = stack;
_tickSource = globalSystemTickSource();
if (opCtx) {
_stack->push(opCtx, this);
} else {
_stack->push_nolock(this);
}
}
CurOp::CurOp(OperationContext* opCtx) {
// If this is a sub-operation, we store the snapshot of lock stats as the base lock stats of the
// current operation.
if (_parent != nullptr)
_lockStatsBase = opCtx->lockState()->getLockerInfo(boost::none)->stats;
// Add the CurOp object onto the stack of active CurOp objects.
_finishInit(opCtx, &_curopStack(opCtx));
}
CurOp::CurOp(OperationContext* opCtx, CurOpStack* stack) {
_finishInit(opCtx, stack);
}
CurOp::~CurOp() {
if (parent() != nullptr)
parent()->yielded(_numYields.load());
invariant(this == _stack->pop());
}
void CurOp::setGenericOpRequestDetails(OperationContext* opCtx,
NamespaceString nss,
const Command* command,
BSONObj cmdObj,
NetworkOp op) {
// Set the _isCommand flags based on network op only. For legacy writes on mongoS, we resolve
// them to OpMsgRequests and then pass them into the Commands path, so having a valid Command*
// here does not guarantee that the op was issued from the client using a command protocol.
const bool isCommand = (op == dbMsg || (op == dbQuery && nss.isCommand()));
auto logicalOp = (command ? command->getLogicalOp() : networkOpToLogicalOp(op));
stdx::lock_guard<Client> clientLock(*opCtx->getClient());
_isCommand = _debug.iscommand = isCommand;
_logicalOp = _debug.logicalOp = logicalOp;
_networkOp = _debug.networkOp = op;
_opDescription = serializeDollarDbInOpDescription(nss.tenantId(), cmdObj);
_command = command;
_nss = std::move(nss);
}
void CurOp::setMessage_inlock(StringData message) {
if (_progressMeter.isActive()) {
LOGV2_ERROR(20527,
"Changing message from {old} to {new}",
"Updating message",
"old"_attr = redact(_message),
"new"_attr = redact(message));
verify(!_progressMeter.isActive());
}
_message = message.toString(); // copy
}
ProgressMeter& CurOp::setProgress_inlock(StringData message,
unsigned long long progressMeterTotal,
int secondsBetween) {
setMessage_inlock(message);
_progressMeter.reset(progressMeterTotal, secondsBetween);
_progressMeter.setName(message);
return _progressMeter;
}
void CurOp::setNS_inlock(NamespaceString nss) {
_nss = std::move(nss);
}
void CurOp::setNS_inlock(const DatabaseName& dbName) {
_nss = NamespaceString(dbName);
}
TickSource::Tick CurOp::startTime(OperationContext* opCtx) {
auto start = _start.load();
if (start != 0) {
return start;
}
// Start the CPU timer if this system supports it.
if (auto cpuTimers = OperationCPUTimers::get(opCtx)) {
_cpuTimer = cpuTimers->makeTimer();
_cpuTimer->start();
}
// The '_start' value is initialized to 0 and gets assigned on demand the first time it gets
// accessed. The above thread ownership requirement ensures that there will never be concurrent
// calls to this '_start' assignment, but we use compare-exchange anyway as an additional check
// that writes to '_start' never race.
TickSource::Tick unassignedStart = 0;
invariant(_start.compare_exchange_strong(unassignedStart, _tickSource->getTicks()));
return _start.load();
}
void CurOp::done() {
_end = _tickSource->getTicks();
if (_cpuTimer) {
_debug.cpuTime = _cpuTimer->getElapsed();
}
}
Microseconds CurOp::computeElapsedTimeTotal(TickSource::Tick startTime,
TickSource::Tick endTime) const {
invariant(startTime != 0);
if (!endTime) {
// This operation is ongoing.
return _tickSource->ticksTo<Microseconds>(_tickSource->getTicks() - startTime);
}
return _tickSource->ticksTo<Microseconds>(endTime - startTime);
}
void CurOp::enter_inlock(OperationContext* opCtx, NamespaceString nss, int dbProfileLevel) {
ensureStarted(opCtx);
_nss = std::move(nss);
raiseDbProfileLevel(dbProfileLevel);
}
void CurOp::enter_inlock(OperationContext* opCtx, const DatabaseName& dbName, int dbProfileLevel) {
enter_inlock(opCtx, NamespaceString(dbName), dbProfileLevel);
}
void CurOp::raiseDbProfileLevel(int dbProfileLevel) {
_dbprofile = std::max(dbProfileLevel, _dbprofile);
}
static constexpr size_t appendMaxElementSize = 50 * 1024;
bool CurOp::completeAndLogOperation(OperationContext* opCtx,
logv2::LogComponent component,
std::shared_ptr<const ProfileFilter> filter,
boost::optional<size_t> responseLength,
boost::optional<long long> slowMsOverride,
bool forceLog) {
const long long slowMs = slowMsOverride.value_or(serverGlobalParams.slowMS.load());
// Record the size of the response returned to the client, if applicable.
if (responseLength) {
_debug.responseLength = *responseLength;
}
// Obtain the total execution time of this operation.
done();
_debug.executionTime = duration_cast<Microseconds>(elapsedTimeExcludingPauses());
const auto executionTimeMillis = durationCount<Milliseconds>(_debug.executionTime);
telemetry::collectTelemetry(opCtx, CurOp::get(opCtx)->debug());
if (_debug.isReplOplogGetMore) {
oplogGetMoreStats.recordMillis(executionTimeMillis);
}
bool shouldLogSlowOp, shouldProfileAtLevel1;
if (filter) {
bool passesFilter = filter->matches(opCtx, _debug, *this);
shouldLogSlowOp = passesFilter;
shouldProfileAtLevel1 = passesFilter;
} else {
// Log the operation if it is eligible according to the current slowMS and sampleRate
// settings.
bool shouldSample;
std::tie(shouldLogSlowOp, shouldSample) = shouldLogSlowOpWithSampling(
opCtx, component, Milliseconds(executionTimeMillis), Milliseconds(slowMs));
shouldProfileAtLevel1 = shouldLogSlowOp && shouldSample;
}
if (forceLog || shouldLogSlowOp) {
auto lockerInfo = opCtx->lockState()->getLockerInfo(_lockStatsBase);
if (_debug.storageStats == nullptr && opCtx->lockState()->wasGlobalLockTaken() &&
opCtx->getServiceContext()->getStorageEngine()) {
// Do not fetch operation statistics again if we have already got them (for instance,
// as a part of stashing the transaction).
// Take a lock before calling into the storage engine to prevent racing against a
// shutdown. Any operation that used a storage engine would have at-least held a
// global lock at one point, hence we limit our lock acquisition to such operations.
// We can get here and our lock acquisition be timed out or interrupted, log a
// message if that happens.
try {
// Retrieving storage stats should not be blocked by oplog application.
ShouldNotConflictWithSecondaryBatchApplicationBlock shouldNotConflictBlock(
opCtx->lockState());
Lock::GlobalLock lk(opCtx,
MODE_IS,
Date_t::now() + Milliseconds(500),
Lock::InterruptBehavior::kThrow);
_debug.storageStats =
opCtx->recoveryUnit()->computeOperationStatisticsSinceLastCall();
} catch (const DBException& ex) {
LOGV2_WARNING_OPTIONS(20526,
{component},
"Failed to gather storage statistics for slow operation",
"opId"_attr = opCtx->getOpID(),
"error"_attr = redact(ex));
}
}
// Gets the time spent blocked on prepare conflicts.
auto prepareConflictDurationMicros =
PrepareConflictTracker::get(opCtx).getPrepareConflictDuration();
_debug.prepareConflictDurationMillis =
duration_cast<Milliseconds>(prepareConflictDurationMicros);
auto operationMetricsPtr = [&]() -> ResourceConsumption::OperationMetrics* {
auto& metricsCollector = ResourceConsumption::MetricsCollector::get(opCtx);
if (metricsCollector.hasCollectedMetrics()) {
return &metricsCollector.getMetrics();
}
return nullptr;
}();
logv2::DynamicAttributes attr;
_debug.report(
opCtx, (lockerInfo ? &lockerInfo->stats : nullptr), operationMetricsPtr, &attr);
// TODO SERVER-67020 Ensure the ns in attr has the tenantId as the db prefix
LOGV2_OPTIONS(51803, {component}, "Slow query", attr);
_checkForFailpointsAfterCommandLogged();
}
// Return 'true' if this operation should also be added to the profiler.
if (_dbprofile >= 2)
return true;
if (_dbprofile <= 0)
return false;
return shouldProfileAtLevel1;
}
std::string CurOp::getNS() const {
return NamespaceStringUtil::serialize(_nss);
}
// Failpoints after commands are logged.
constexpr auto kPrepareTransactionCmdName = "prepareTransaction"_sd;
MONGO_FAIL_POINT_DEFINE(waitForPrepareTransactionCommandLogged);
constexpr auto kHelloCmdName = "hello"_sd;
MONGO_FAIL_POINT_DEFINE(waitForHelloCommandLogged);
constexpr auto kIsMasterCmdName = "isMaster"_sd;
MONGO_FAIL_POINT_DEFINE(waitForIsMasterCommandLogged);
void CurOp::_checkForFailpointsAfterCommandLogged() {
if (!isCommand() || !getCommand()) {
return;
}
auto cmdName = getCommand()->getName();
if (cmdName == kPrepareTransactionCmdName) {
if (MONGO_unlikely(waitForPrepareTransactionCommandLogged.shouldFail())) {
LOGV2(31481, "waitForPrepareTransactionCommandLogged failpoint enabled");
}
} else if (cmdName == kHelloCmdName) {
if (MONGO_unlikely(waitForHelloCommandLogged.shouldFail())) {
LOGV2(31482, "waitForHelloCommandLogged failpoint enabled");
}
} else if (cmdName == kIsMasterCmdName) {
if (MONGO_unlikely(waitForIsMasterCommandLogged.shouldFail())) {
LOGV2(31483, "waitForIsMasterCommandLogged failpoint enabled");
}
}
}
Command::ReadWriteType CurOp::getReadWriteType() const {
if (_command) {
return _command->getReadWriteType();
}
switch (_logicalOp) {
case LogicalOp::opGetMore:
case LogicalOp::opQuery:
return Command::ReadWriteType::kRead;
case LogicalOp::opUpdate:
case LogicalOp::opInsert:
case LogicalOp::opDelete:
return Command::ReadWriteType::kWrite;
default:
return Command::ReadWriteType::kCommand;
}
}
namespace {
BSONObj appendCommentField(OperationContext* opCtx, const BSONObj& cmdObj) {
return opCtx->getComment() && !cmdObj["comment"] ? cmdObj.addField(*opCtx->getComment())
: cmdObj;
}
/**
* Appends {<name>: obj} to the provided builder. If obj is greater than maxSize, appends a string
* summary of obj as { <name>: { $truncated: "obj" } }. If a comment parameter is present, add it to
* the truncation object.
*/
void appendAsObjOrString(StringData name,
const BSONObj& obj,
const boost::optional<size_t> maxSize,
BSONObjBuilder* builder) {
if (!maxSize || static_cast<size_t>(obj.objsize()) <= *maxSize) {
builder->append(name, obj);
} else {
// Generate an abbreviated serialization for the object, by passing false as the "full"
// argument to obj.toString(). Remove "comment" field from the object, if present, since
// this will be promoted to a top-level field in the output.
std::string objToString =
(obj.hasField("comment") ? obj.removeField("comment") : obj).toString();
if (objToString.size() > *maxSize) {
// objToString is still too long, so we append to the builder a truncated form
// of objToString concatenated with "...". Instead of creating a new string
// temporary, mutate objToString to do this (we know that we can mutate
// characters in objToString up to and including objToString[maxSize]).
objToString[*maxSize - 3] = '.';
objToString[*maxSize - 2] = '.';
objToString[*maxSize - 1] = '.';
LOGV2_INFO(4760300,
"Gathering currentOp information, operation of size {size} exceeds the size "
"limit of {limit} and will be truncated.",
"size"_attr = objToString.size(),
"limit"_attr = *maxSize);
}
StringData truncation = StringData(objToString).substr(0, *maxSize);
// Append the truncated representation of the object to the builder. If a comment parameter
// is present, write it to the object alongside the truncated op. This object will appear as
// {$truncated: "{find: \"collection\", filter: {x: 1, ...", comment: "comment text" }
BSONObjBuilder truncatedBuilder(builder->subobjStart(name));
truncatedBuilder.append("$truncated", truncation);
if (auto comment = obj["comment"]) {
truncatedBuilder.append(comment);
}
truncatedBuilder.doneFast();
}
}
} // namespace
BSONObj CurOp::truncateAndSerializeGenericCursor(GenericCursor* cursor,
boost::optional<size_t> maxQuerySize) {
// This creates a new builder to truncate the object that will go into the curOp output. In
// order to make sure the object is not too large but not truncate the comment, we only
// truncate the originatingCommand and not the entire cursor.
if (maxQuerySize) {
BSONObjBuilder tempObj;
appendAsObjOrString(
"truncatedObj", cursor->getOriginatingCommand().value(), maxQuerySize, &tempObj);
auto originatingCommand = tempObj.done().getObjectField("truncatedObj");
cursor->setOriginatingCommand(originatingCommand.getOwned());
}
// lsid, ns, and planSummary exist in the top level curop object, so they need to be temporarily
// removed from the cursor object to avoid duplicating information.
auto lsid = cursor->getLsid();
auto ns = cursor->getNs();
auto originalPlanSummary(cursor->getPlanSummary() ? boost::optional<std::string>(
cursor->getPlanSummary()->toString())
: boost::none);
cursor->setLsid(boost::none);
cursor->setNs(boost::none);
cursor->setPlanSummary(boost::none);
auto serialized = cursor->toBSON();
cursor->setLsid(lsid);
cursor->setNs(ns);
if (originalPlanSummary) {
cursor->setPlanSummary(StringData(*originalPlanSummary));
}
return serialized;
}
void CurOp::reportState(OperationContext* opCtx, BSONObjBuilder* builder, bool truncateOps) {
auto start = _start.load();
if (start) {
auto end = _end.load();
auto elapsedTimeTotal = computeElapsedTimeTotal(start, end);
builder->append("secs_running", durationCount<Seconds>(elapsedTimeTotal));
builder->append("microsecs_running", durationCount<Microseconds>(elapsedTimeTotal));
}
builder->append("op", logicalOpToString(_logicalOp));
builder->append("ns", NamespaceStringUtil::serialize(_nss));
// When the currentOp command is run, it returns a single response object containing all current
// operations; this request will fail if the response exceeds the 16MB document limit. By
// contrast, the $currentOp aggregation stage does not have this restriction. If 'truncateOps'
// is true, limit the size of each op to 1000 bytes. Otherwise, do not truncate.
const boost::optional<size_t> maxQuerySize{truncateOps, 1000};
appendAsObjOrString(
"command", appendCommentField(opCtx, _opDescription), maxQuerySize, builder);
switch (_debug.queryFramework) {
case PlanExecutor::QueryFramework::kClassicOnly:
case PlanExecutor::QueryFramework::kClassicHybrid:
builder->append("queryFramework", "classic");
break;
case PlanExecutor::QueryFramework::kSBEOnly:
case PlanExecutor::QueryFramework::kSBEHybrid:
builder->append("queryFramework", "sbe");
break;
case PlanExecutor::QueryFramework::kCQF:
builder->append("queryFramework", "cqf");
break;
case PlanExecutor::QueryFramework::kUnknown:
break;
}
if (!_planSummary.empty()) {
builder->append("planSummary", _planSummary);
}
if (_genericCursor) {
builder->append("cursor",
truncateAndSerializeGenericCursor(&(*_genericCursor), maxQuerySize));
}
if (!_message.empty()) {
if (_progressMeter.isActive()) {
StringBuilder buf;
buf << _message << " " << _progressMeter.toString();
builder->append("msg", buf.str());
BSONObjBuilder sub(builder->subobjStart("progress"));
sub.appendNumber("done", (long long)_progressMeter.done());
sub.appendNumber("total", (long long)_progressMeter.total());
sub.done();
} else {
builder->append("msg", _message);
}
}
if (!_failPointMessage.empty()) {
builder->append("failpointMsg", _failPointMessage);
}
if (auto n = _debug.additiveMetrics.prepareReadConflicts.load(); n > 0) {
builder->append("prepareReadConflicts", n);
}
if (auto n = _debug.additiveMetrics.writeConflicts.load(); n > 0) {
builder->append("writeConflicts", n);
}
if (auto n = _debug.additiveMetrics.temporarilyUnavailableErrors.load(); n > 0) {
builder->append("temporarilyUnavailableErrors", n);
}
builder->append("numYields", _numYields.load());
if (_debug.dataThroughputLastSecond) {
builder->append("dataThroughputLastSecond", *_debug.dataThroughputLastSecond);
}
if (_debug.dataThroughputAverage) {
builder->append("dataThroughputAverage", *_debug.dataThroughputAverage);
}
if (feature_flags::gFeatureFlagDeprioritizeLowPriorityOperations.isEnabledAndIgnoreFCV()) {
auto admissionPriority = opCtx->lockState()->getAdmissionPriority();
if (admissionPriority < AdmissionContext::Priority::kNormal) {
builder->append("admissionPriority", toString(admissionPriority));
}
}
if (auto start = _waitForWriteConcernStart.load(); start > 0) {
auto end = _waitForWriteConcernEnd.load();
auto elapsedTimeTotal =
duration_cast<Microseconds>(debug().waitForWriteConcernDurationMillis);
elapsedTimeTotal += computeElapsedTimeTotal(start, end);
builder->append("waitForWriteConcernDurationMillis",
durationCount<Milliseconds>(elapsedTimeTotal));
}
}
namespace {
StringData getProtoString(int op) {
if (op == dbMsg) {
return "op_msg";
} else if (op == dbQuery) {
return "op_query";
}
MONGO_UNREACHABLE;
}
} // namespace
#define OPDEBUG_TOSTRING_HELP(x) \
if (x >= 0) \
s << " " #x ":" << (x)
#define OPDEBUG_TOSTRING_HELP_BOOL(x) \
if (x) \
s << " " #x ":" << (x)
#define OPDEBUG_TOSTRING_HELP_ATOMIC(x, y) \
if (auto __y = y.load(); __y > 0) \
s << " " x ":" << (__y)
#define OPDEBUG_TOSTRING_HELP_OPTIONAL(x, y) \
if (y) \
s << " " x ":" << (*y)
#define OPDEBUG_TOATTR_HELP(x) \
if (x >= 0) \
pAttrs->add(#x, x)
#define OPDEBUG_TOATTR_HELP_BOOL(x) \
if (x) \
pAttrs->add(#x, x)
#define OPDEBUG_TOATTR_HELP_ATOMIC(x, y) \
if (auto __y = y.load(); __y > 0) \
pAttrs->add(x, __y)
#define OPDEBUG_TOATTR_HELP_OPTIONAL(x, y) \
if (y) \
pAttrs->add(x, *y)
void OpDebug::report(OperationContext* opCtx,
const SingleThreadedLockStats* lockStats,
const ResourceConsumption::OperationMetrics* operationMetrics,
logv2::DynamicAttributes* pAttrs) const {
Client* client = opCtx->getClient();
auto& curop = *CurOp::get(opCtx);
auto flowControlStats = opCtx->lockState()->getFlowControlStats();
if (iscommand) {
pAttrs->add("type", "command");
} else {
pAttrs->add("type", networkOpToString(networkOp));
}
pAttrs->addDeepCopy("ns", curop.getNS());
if (client) {
if (auto clientMetadata = ClientMetadata::get(client)) {
StringData appName = clientMetadata->getApplicationName();
if (!appName.empty()) {
pAttrs->add("appName", appName);
}
}
}
auto query = appendCommentField(opCtx, curop.opDescription());
if (!query.isEmpty()) {
if (iscommand) {
const Command* curCommand = curop.getCommand();
if (curCommand) {
mutablebson::Document cmdToLog(query, mutablebson::Document::kInPlaceDisabled);
curCommand->snipForLogging(&cmdToLog);
pAttrs->add("command", redact(cmdToLog.getObject()));
} else {
// Should not happen but we need to handle curCommand == NULL gracefully.
// We don't know what the request payload is intended to be, so it might be
// sensitive, and we don't know how to redact it properly without a 'Command*'.
// So we just don't log it at all.
pAttrs->add("command", "unrecognized");
}
} else {
pAttrs->add("command", redact(query));
}
}
auto originatingCommand = curop.originatingCommand();
if (!originatingCommand.isEmpty()) {
pAttrs->add("originatingCommand", redact(originatingCommand));
}
if (!curop.getPlanSummary().empty()) {
pAttrs->addDeepCopy("planSummary", curop.getPlanSummary().toString());
}
if (planningTime > Microseconds::zero()) {
pAttrs->add("planningTimeMicros", durationCount<Microseconds>(planningTime));
}
if (prepareConflictDurationMillis > Milliseconds::zero()) {
pAttrs->add("prepareConflictDuration", prepareConflictDurationMillis);
}
if (catalogCacheDatabaseLookupMillis > Milliseconds::zero()) {
pAttrs->add("catalogCacheDatabaseLookupDuration", catalogCacheDatabaseLookupMillis);
}
if (catalogCacheCollectionLookupMillis > Milliseconds::zero()) {
pAttrs->add("catalogCacheCollectionLookupDuration", catalogCacheCollectionLookupMillis);
}
if (catalogCacheIndexLookupMillis > Milliseconds::zero()) {
pAttrs->add("catalogCacheIndexLookupDuration", catalogCacheIndexLookupMillis);
}
if (databaseVersionRefreshMillis > Milliseconds::zero()) {
pAttrs->add("databaseVersionRefreshDuration", databaseVersionRefreshMillis);
}
if (shardVersionRefreshMillis > Milliseconds::zero()) {
pAttrs->add("shardVersionRefreshDuration", shardVersionRefreshMillis);
}
if (dataThroughputLastSecond) {
pAttrs->add("dataThroughputLastSecondMBperSec", *dataThroughputLastSecond);
}
if (dataThroughputAverage) {
pAttrs->add("dataThroughputAverageMBPerSec", *dataThroughputAverage);
}
if (!resolvedViews.empty()) {
pAttrs->add("resolvedViews", getResolvedViewsInfo());
}
OPDEBUG_TOATTR_HELP(nShards);
OPDEBUG_TOATTR_HELP(cursorid);
if (mongotCursorId) {
pAttrs->add("mongot", makeMongotDebugStatsObject());
}
OPDEBUG_TOATTR_HELP_BOOL(exhaust);
OPDEBUG_TOATTR_HELP_OPTIONAL("keysExamined", additiveMetrics.keysExamined);
OPDEBUG_TOATTR_HELP_OPTIONAL("docsExamined", additiveMetrics.docsExamined);
OPDEBUG_TOATTR_HELP_BOOL(hasSortStage);
OPDEBUG_TOATTR_HELP_BOOL(usedDisk);
OPDEBUG_TOATTR_HELP_BOOL(fromMultiPlanner);
OPDEBUG_TOATTR_HELP_BOOL(fromPlanCache);
if (replanReason) {
bool replanned = true;
OPDEBUG_TOATTR_HELP_BOOL(replanned);
pAttrs->add("replanReason", redact(*replanReason));
}
OPDEBUG_TOATTR_HELP_OPTIONAL("nMatched", additiveMetrics.nMatched);
OPDEBUG_TOATTR_HELP_OPTIONAL("nModified", additiveMetrics.nModified);
OPDEBUG_TOATTR_HELP_OPTIONAL("ninserted", additiveMetrics.ninserted);
OPDEBUG_TOATTR_HELP_OPTIONAL("ndeleted", additiveMetrics.ndeleted);
OPDEBUG_TOATTR_HELP_OPTIONAL("nUpserted", additiveMetrics.nUpserted);
OPDEBUG_TOATTR_HELP_BOOL(cursorExhausted);
OPDEBUG_TOATTR_HELP_OPTIONAL("keysInserted", additiveMetrics.keysInserted);
OPDEBUG_TOATTR_HELP_OPTIONAL("keysDeleted", additiveMetrics.keysDeleted);
OPDEBUG_TOATTR_HELP_ATOMIC("prepareReadConflicts", additiveMetrics.prepareReadConflicts);
OPDEBUG_TOATTR_HELP_ATOMIC("writeConflicts", additiveMetrics.writeConflicts);
OPDEBUG_TOATTR_HELP_ATOMIC("temporarilyUnavailableErrors",
additiveMetrics.temporarilyUnavailableErrors);
pAttrs->add("numYields", curop.numYields());
OPDEBUG_TOATTR_HELP(nreturned);
if (queryHash) {
pAttrs->addDeepCopy("queryHash", zeroPaddedHex(*queryHash));
}
if (planCacheKey) {
pAttrs->addDeepCopy("planCacheKey", zeroPaddedHex(*planCacheKey));
}
switch (queryFramework) {
case PlanExecutor::QueryFramework::kClassicOnly:
case PlanExecutor::QueryFramework::kClassicHybrid:
pAttrs->add("queryFramework", "classic");
break;
case PlanExecutor::QueryFramework::kSBEOnly:
case PlanExecutor::QueryFramework::kSBEHybrid:
pAttrs->add("queryFramework", "sbe");
break;
case PlanExecutor::QueryFramework::kCQF:
pAttrs->add("queryFramework", "cqf");
break;
case PlanExecutor::QueryFramework::kUnknown:
break;
}
if (!errInfo.isOK()) {
pAttrs->add("ok", 0);
if (!errInfo.reason().empty()) {
pAttrs->add("errMsg", redact(errInfo.reason()));
}
pAttrs->addDeepCopy("errName", errInfo.codeString());
pAttrs->add("errCode", static_cast<int>(errInfo.code()));
}
if (responseLength > 0) {
pAttrs->add("reslen", responseLength);
}
if (feature_flags::gFeatureFlagDeprioritizeLowPriorityOperations.isEnabledAndIgnoreFCV()) {
auto admissionPriority = opCtx->lockState()->getAdmissionPriority();
if (admissionPriority < AdmissionContext::Priority::kNormal) {
pAttrs->add("admissionPriority", admissionPriority);
}
}
if (lockStats) {
BSONObjBuilder locks;
lockStats->report(&locks);
pAttrs->add("locks", locks.obj());
}
auto userAcquisitionStats = curop.getReadOnlyUserAcquisitionStats();
if (userAcquisitionStats->shouldUserCacheAcquisitionStatsReport()) {
BSONObjBuilder userCacheAcquisitionStatsBuilder;
userAcquisitionStats->userCacheAcquisitionStatsReport(
&userCacheAcquisitionStatsBuilder, opCtx->getServiceContext()->getTickSource());
pAttrs->add("authorization", userCacheAcquisitionStatsBuilder.obj());
}
if (userAcquisitionStats->shouldLDAPOperationStatsReport()) {
BSONObjBuilder ldapOperationStatsBuilder;
userAcquisitionStats->ldapOperationStatsReport(&ldapOperationStatsBuilder,
opCtx->getServiceContext()->getTickSource());
pAttrs->add("LDAPOperations", ldapOperationStatsBuilder.obj());
}