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
|
// ttl.cpp
/**
* Copyright (C) 2008 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kIndex
#include "mongo/platform/basic.h"
#include "mongo/db/ttl.h"
#include "mongo/base/counter.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/auth/user_name.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/client.h"
#include "mongo/db/commands/fsync.h"
#include "mongo/db/commands/server_status_metric.h"
#include "mongo/db/catalog/collection_catalog_entry.h"
#include "mongo/db/catalog/database_catalog_entry.h"
#include "mongo/db/catalog/database_holder.h"
#include "mongo/db/dbdirectclient.h"
#include "mongo/db/operation_context_impl.h"
#include "mongo/db/ops/delete.h"
#include "mongo/db/repl/repl_coordinator_global.h"
#include "mongo/db/server_parameters.h"
#include "mongo/util/background.h"
#include "mongo/util/log.h"
namespace mongo {
Counter64 ttlPasses;
Counter64 ttlDeletedDocuments;
ServerStatusMetricField<Counter64> ttlPassesDisplay("ttl.passes", &ttlPasses);
ServerStatusMetricField<Counter64> ttlDeletedDocumentsDisplay("ttl.deletedDocuments", &ttlDeletedDocuments);
MONGO_EXPORT_SERVER_PARAMETER( ttlMonitorEnabled, bool, true );
class TTLMonitor : public BackgroundJob {
public:
TTLMonitor(){}
virtual ~TTLMonitor(){}
virtual string name() const { return "TTLMonitor"; }
static string secondsExpireField;
virtual void run() {
Client::initThread( name().c_str() );
cc().getAuthorizationSession()->grantInternalAuthorization();
while ( ! inShutdown() ) {
sleepsecs( 60 );
LOG(3) << "TTLMonitor thread awake" << endl;
if ( !ttlMonitorEnabled ) {
LOG(1) << "TTLMonitor is disabled" << endl;
continue;
}
if ( lockedForWriting() ) {
// note: this is not perfect as you can go into fsync+lock between
// this and actually doing the delete later
LOG(3) << " locked for writing" << endl;
continue;
}
// if part of replSet but not in a readable state (e.g. during initial sync), skip.
if (repl::getGlobalReplicationCoordinator()->getReplicationMode() ==
repl::ReplicationCoordinator::modeReplSet &&
!repl::getGlobalReplicationCoordinator()->getCurrentMemberState().readable())
continue;
set<string> dbs;
dbHolder().getAllShortNames( dbs );
ttlPasses.increment();
for ( set<string>::const_iterator i=dbs.begin(); i!=dbs.end(); ++i ) {
string db = *i;
vector<BSONObj> indexes;
{
OperationContextImpl txn;
getTTLIndexesForDB( &txn, db, &indexes );
}
for ( vector<BSONObj>::const_iterator it = indexes.begin();
it != indexes.end(); ++it ) {
OperationContextImpl txn;
if ( !doTTLForIndex( &txn, db, *it ) ) {
break; // stop processing TTL indexes on this database
}
}
}
}
}
private:
/**
* Acquire an IS-mode lock on the specified database and for each
* collection in the database, append the specification of all
* TTL indexes on those collections to the supplied vector.
*
* The index specifications are grouped by the collection to which
* they belong.
*/
void getTTLIndexesForDB( OperationContext* txn, const string& dbName,
vector<BSONObj>* indexes ) {
invariant( indexes && indexes->empty() );
ScopedTransaction transaction( txn, MODE_IS );
Lock::DBLock dbLock( txn->lockState(), dbName, MODE_IS );
Database* db = dbHolder().get( txn, dbName );
if ( !db ) {
return; // skip since database no longer exists
}
const DatabaseCatalogEntry* dbEntry = db->getDatabaseCatalogEntry();
list<string> namespaces;
dbEntry->getCollectionNamespaces( &namespaces );
for ( list<string>::const_iterator it = namespaces.begin();
it != namespaces.end(); ++it ) {
string ns = *it;
Lock::CollectionLock collLock( txn->lockState(), ns, MODE_IS );
CollectionCatalogEntry* coll = dbEntry->getCollectionCatalogEntry( txn, ns );
if ( !coll ) {
continue; // skip since collection not found in catalog
}
vector<string> indexNames;
coll->getAllIndexes( txn, &indexNames );
for ( size_t i = 0; i < indexNames.size(); i++ ) {
const string& name = indexNames[i];
BSONObj spec = coll->getIndexSpec( txn, name );
if ( spec.hasField( secondsExpireField ) ) {
indexes->push_back( spec.getOwned() );
}
}
}
}
/**
* Remove documents from the collection using the specified TTL index
* after a sufficient amount of time has passed according to its expiry
* specification.
*
* @return true if caller should continue processing TTL indexes of collections
* on the specified database, and false otherwise
*/
bool doTTLForIndex( OperationContext* txn, const string& dbName, const BSONObj& idx ) {
BSONObj key = idx["key"].Obj();
if ( key.nFields() != 1 ) {
error() << "key for ttl index can only have 1 field" << endl;
return true;
}
if ( !idx[secondsExpireField].isNumber() ) {
log() << "ttl indexes require the " << secondsExpireField << " field to be "
<< "numeric but received a type of: "
<< typeName( idx[secondsExpireField].type() );
return true;
}
BSONObj query;
{
BSONObjBuilder b;
long long expireMs = 1000 * idx[secondsExpireField].numberLong();
b.appendDate( "$lt", curTimeMillis64() - expireMs );
query = BSON( key.firstElement().fieldName() << b.obj() );
}
LOG(1) << "TTL: " << key << " \t " << query << endl;
long long n = 0;
{
const string ns = idx["ns"].String();
AutoGetDb autoDb(txn, dbName, MODE_IX);
Database* db = autoDb.getDb();
if (!db) return false;
Lock::CollectionLock collLock( txn->lockState(), ns, MODE_IX );
Collection* collection = db->getCollection( txn, ns );
if ( !collection ) {
// collection was dropped
return true;
}
if (!repl::getGlobalReplicationCoordinator()->canAcceptWritesForDatabase(dbName)) {
// we've stepped down since we started this function,
// so we should stop working as we only do deletes on the primary
return false;
}
if ( collection->getIndexCatalog()->findIndexByKeyPattern( txn, key ) == NULL ) {
// index not finished yet
LOG(1) << " skipping index because not finished";
return true;
}
n = deleteObjects( txn, db, ns, query, PlanExecutor::YIELD_AUTO, false, true );
ttlDeletedDocuments.increment( n );
}
LOG(1) << "\tTTL deleted: " << n << endl;
return true;
}
};
void startTTLBackgroundJob() {
TTLMonitor* ttl = new TTLMonitor();
ttl->go();
}
string TTLMonitor::secondsExpireField = "expireAfterSeconds";
}
|
