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
|
/**
* Copyright (C) 2022-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/db/change_collection_expired_documents_remover.h"
#include "mongo/db/catalog_raii.h"
#include "mongo/db/change_stream_change_collection_manager.h"
#include "mongo/db/change_streams_cluster_parameter_gen.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/service_context.h"
#include "mongo/logv2/log.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/duration.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/periodic_runner.h"
#include <algorithm>
#include <memory>
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kQuery
namespace mongo {
// Hangs the change collection remover job before initiating the deletion process of documents.
MONGO_FAIL_POINT_DEFINE(hangBeforeRemovingExpiredChanges);
// Injects the provided ISO date to currentWallTime which is used to determine if the change
// collection document is expired or not.
MONGO_FAIL_POINT_DEFINE(injectCurrentWallTimeForRemovingExpiredDocuments);
namespace {
// TODO SERVER-61822 Provide the real implementation after 'listDatabasesForAllTenants' is
// available.
std::vector<boost::optional<TenantId>> getAllTenants() {
return {boost::none};
}
boost::optional<int64_t> getExpireAfterSeconds(boost::optional<TenantId> tid) {
auto* clusterParameters = ServerParameterSet::getClusterParameterSet();
auto* changeStreamsParam =
clusterParameters->get<ClusterParameterWithStorage<ChangeStreamsClusterParameterStorage>>(
"changeStreams");
return changeStreamsParam->getValue(tid).getExpireAfterSeconds();
}
void removeExpiredDocuments(Client* client) {
// TODO SERVER-66717 Remove this logic from this method. Due to the delay in the feature flag
// activation it was placed here. The remover job should ultimately be initialized at the mongod
// startup when launched in serverless mode.
if (!ChangeStreamChangeCollectionManager::isChangeCollectionsModeActive()) {
return;
}
hangBeforeRemovingExpiredChanges.pauseWhileSet();
try {
auto opCtx = client->makeOperationContext();
const auto clock = client->getServiceContext()->getFastClockSource();
auto currentWallTime = clock->now();
// If the fail point 'injectCurrentWallTimeForRemovingDocuments' is enabled then set the
// 'currentWallTime' with the provided wall time.
if (injectCurrentWallTimeForRemovingExpiredDocuments.shouldFail()) {
injectCurrentWallTimeForRemovingExpiredDocuments.execute([&](const BSONObj& data) {
currentWallTime = data.getField("currentWallTime").date();
});
}
// Number of documents removed in the current pass.
size_t removedCount = 0;
long long maxStartWallTime = 0;
auto& changeCollectionManager = ChangeStreamChangeCollectionManager::get(opCtx.get());
for (const auto& tenantId : getAllTenants()) {
auto expiredAfterSeconds = getExpireAfterSeconds(tenantId);
invariant(expiredAfterSeconds);
// Acquire intent-exclusive lock on the change collection.
AutoGetChangeCollection changeCollection{
opCtx.get(), AutoGetChangeCollection::AccessMode::kWrite, tenantId};
// Early exit if collection does not exist or if running on a secondary (requires
// opCtx->lockState()->isRSTLLocked()).
if (!changeCollection ||
!repl::ReplicationCoordinator::get(opCtx.get())
->canAcceptWritesForDatabase(opCtx.get(), NamespaceString::kConfigDb)) {
continue;
}
// Get the metadata required for the removal of the expired change collection
// documents. Early exit if the metadata is missing, indicating that there is nothing
// to remove.
auto purgingJobMetadata =
ChangeStreamChangeCollectionManager::getChangeCollectionPurgingJobMetadata(
opCtx.get(),
&*changeCollection,
currentWallTime - Seconds(*expiredAfterSeconds));
if (!purgingJobMetadata) {
continue;
}
removedCount +=
ChangeStreamChangeCollectionManager::removeExpiredChangeCollectionsDocuments(
opCtx.get(), &*changeCollection, purgingJobMetadata->maxRecordIdBound);
changeCollectionManager.getPurgingJobStats().scannedCollections.fetchAndAddRelaxed(1);
maxStartWallTime =
std::max(maxStartWallTime, purgingJobMetadata->firstDocWallTimeMillis);
}
// The purging job metadata will be 'boost::none' if none of the change collections have
// more than one oplog entry, as such the 'maxStartWallTimeMillis' will be zero. Avoid
// reporting 0 as 'maxStartWallTimeMillis'.
if (maxStartWallTime > 0) {
changeCollectionManager.getPurgingJobStats().maxStartWallTimeMillis.store(
maxStartWallTime);
}
const auto jobDurationMillis = clock->now() - currentWallTime;
if (removedCount > 0) {
LOGV2_DEBUG(6663503,
3,
"Periodic expired change collection job finished executing",
"numberOfRemovals"_attr = removedCount,
"jobDuration"_attr = jobDurationMillis.toString());
}
changeCollectionManager.getPurgingJobStats().totalPass.fetchAndAddRelaxed(1);
changeCollectionManager.getPurgingJobStats().timeElapsedMillis.fetchAndAddRelaxed(
jobDurationMillis.count());
} catch (const DBException& exception) {
if (exception.toStatus() != ErrorCodes::OK) {
LOGV2_WARNING(6663504,
"Periodic expired change collection job was killed",
"errorCode"_attr = exception.toStatus());
} else {
LOGV2_ERROR(6663505,
"Periodic expired change collection job failed",
"reason"_attr = exception.reason());
}
}
}
/**
* Defines a periodic background job to remove expired documents from change collections.
* The job will run every 'changeCollectionRemoverJobSleepSeconds', as defined in the cluster
* parameter.
*/
class ChangeCollectionExpiredDocumentsRemover {
public:
ChangeCollectionExpiredDocumentsRemover(ServiceContext* serviceContext) {
const auto period = Seconds{gChangeCollectionRemoverJobSleepSeconds.load()};
_jobAnchor = serviceContext->getPeriodicRunner()->makeJob(
{"ChangeCollectionExpiredDocumentsRemover", removeExpiredDocuments, period});
_jobAnchor.start();
}
static void start(ServiceContext* serviceContext) {
auto& changeCollectionExpiredDocumentsRemover = _serviceDecoration(serviceContext);
changeCollectionExpiredDocumentsRemover =
std::make_unique<ChangeCollectionExpiredDocumentsRemover>(serviceContext);
}
static void shutdown(ServiceContext* serviceContext) {
auto& changeCollectionExpiredDocumentsRemover = _serviceDecoration(serviceContext);
if (changeCollectionExpiredDocumentsRemover) {
changeCollectionExpiredDocumentsRemover->_jobAnchor.stop();
changeCollectionExpiredDocumentsRemover.reset();
}
}
private:
inline static const auto _serviceDecoration = ServiceContext::declareDecoration<
std::unique_ptr<ChangeCollectionExpiredDocumentsRemover>>();
PeriodicJobAnchor _jobAnchor;
};
} // namespace
void startChangeCollectionExpiredDocumentsRemover(ServiceContext* serviceContext) {
LOGV2(6663507, "Starting the ChangeCollectionExpiredChangeRemover");
ChangeCollectionExpiredDocumentsRemover::start(serviceContext);
}
void shutdownChangeCollectionExpiredDocumentsRemover(ServiceContext* serviceContext) {
LOGV2(6663508, "Shutting down the ChangeCollectionExpiredChangeRemover");
ChangeCollectionExpiredDocumentsRemover::shutdown(serviceContext);
}
} // namespace mongo
|
