forked from winstonjs/winston-mongodb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
winston-mongodb.js
388 lines (369 loc) · 11.8 KB
/
winston-mongodb.js
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
/**
* @module 'winston-mongodb'
* @fileoverview Winston transport for logging into MongoDB
* @license MIT
* @author charlie@nodejitsu.com (Charlie Robbins)
* @author 0@39.yt (Yurij Mikhalevich)
*/
'use strict';
const util = require('util');
const os = require('os');
const mongodb = require('mongodb');
const winston = require('winston');
const Stream = require('stream').Stream;
const helpers = require('./helpers');
/**
* Constructor for the MongoDB transport object.
* @constructor
* @param {Object} options
* @param {string=info} options.level Level of messages that this transport
* should log.
* @param {boolean=false} options.silent Boolean flag indicating whether to
* suppress output.
* @param {string|Object} options.db MongoDB connection uri or preconnected db
* object.
* @param {Object} options.options MongoDB connection parameters
* (optional, defaults to `{poolSize: 2, autoReconnect: true}`).
* @param {string=logs} options.collection The name of the collection you want
* to store log messages in.
* @param {boolean=false} options.storeHost Boolean indicating if you want to
* store machine hostname in logs entry, if set to true it populates MongoDB
* entry with 'hostname' field, which stores os.hostname() value.
* @param {string} options.username The username to use when logging into
* MongoDB.
* @param {string} options.password The password to use when logging into
* MongoDB. If you don't supply a username and password it will not use MongoDB
* authentication.
* @param {string} options.label Label stored with entry object if defined.
* @param {string} options.name Transport instance identifier. Useful if you
* need to create multiple MongoDB transports.
* @param {boolean=false} options.capped In case this property is true,
* winston-mongodb will try to create new log collection as capped.
* @param {number=10000000} options.cappedSize Size of logs capped collection
* in bytes.
* @param {number} options.cappedMax Size of logs capped collection in number
* of documents.
* @param {boolean=false} options.tryReconnect Will try to reconnect to the
* database in case of fail during initialization. Works only if `db` is
* a string.
* @param {boolean=false} options.decolorize Will remove color attributes from
* the log entry message.
* @param {number} options.expireAfterSeconds Seconds before the entry is removed. Do not use if capped is set.
*/
let MongoDB = exports.MongoDB = function(options) {
winston.Transport.call(this, options);
options = (options || {});
if (!options.db) {
throw new Error('You should provide db to log to.');
}
this.name = options.name || 'mongodb';
this.db = options.db;
this.options = options.options;
if (!this.options) {
this.options = {
poolSize: 2,
autoReconnect: true
};
}
this.collection = (options.collection || 'log');
this.level = (options.level || 'info');
this.silent = options.silent;
this.username = options.username;
this.password = options.password;
this.storeHost = options.storeHost;
this.label = options.label;
this.capped = options.capped;
this.cappedSize = (options.cappedSize || 10000000);
this.cappedMax = options.cappedMax;
this.decolorize = options.decolorize;
this.expireAfterSeconds = !this.capped && options.expireAfterSeconds;
if (this.storeHost) {
this.hostname = os.hostname();
}
this._opQueue = [];
let self = this;
function setupDatabaseAndEmptyQueue(db) {
return authorizeDb(db).then(createCollection, err=>{
db.close();
console.error('winston-mongodb, initialization error: ', err);
}).then(db=>{
self.logDb = db;
processOpQueue();
});
}
function processOpQueue() {
self._opQueue.forEach(operation=>
self[operation.method].apply(self, operation.args));
delete self._opQueue;
}
function createCollection(db) {
let opts = self.capped ?
{capped: true, size: self.cappedSize, max: self.cappedMax} : {};
return db.createCollection(self.collection, opts).then(col=>{
const ttlIndexName = 'timestamp_1';
let indexOpts = {name: ttlIndexName, background: true};
if (self.expireAfterSeconds) {
indexOpts.expireAfterSeconds = self.expireAfterSeconds;
}
return col.indexInformation({full: true}).then(info=>{
info = info.filter(i=>i.name === ttlIndexName);
if (info.length === 0) { // if its a new index then create it
return col.createIndex({timestamp: -1}, indexOpts);
} else { // if index existed with the same name check if expireAfterSeconds param has changed
if (info[0].expireAfterSeconds !== undefined &&
info[0].expireAfterSeconds !== self.expireAfterSeconds) {
return col.dropIndex(ttlIndexName)
.then(()=>col.createIndex({timestamp: -1}, indexOpts));
}
}
});
}).then(()=>db);
}
function authorizeDb(db) {
if (self.username && self.password) {
return db.authenticate(self.username, self.password).then(ok=>{
if (!ok) {
throw new Error('invalid username or password');
}
return db;
});
} else {
return new Promise(resolve=>resolve(db));
}
}
function connectToDatabase(logger) {
return mongodb.MongoClient.connect(logger.db, logger.options
).then(setupDatabaseAndEmptyQueue, err=>{
console.error('winston-mongodb: error initialising logger', err);
if (options.tryReconnect) {
console.log('winston-mongodb: will try reconnecting in 10 seconds');
return new Promise(resolve=>setTimeout(resolve, 10000)
).then(()=>connectToDatabase(logger));
}
});
}
if ('string' === typeof this.db) {
connectToDatabase(this);
} else if ('function' === typeof this.db.then) {
this.db.then(setupDatabaseAndEmptyQueue, err=>console.error(
'winston-mongodb: error initialising logger from promise', err));
} else { // preconnected object
setupDatabaseAndEmptyQueue(this.db);
}
};
/**
* Inherit from `winston.Transport`.
*/
util.inherits(MongoDB, winston.Transport);
/**
* Define a getter so that `winston.transports.MongoDB`
* is available and thus backwards compatible.
*/
winston.transports.MongoDB = MongoDB;
/**
* Closes MongoDB connection so using process would not hang up.
* Used by winston Logger.close on transports.
*/
MongoDB.prototype.close = function() {
if (!this.logDb) {
return;
}
this.logDb.close().then(()=>this.logDb = null).catch(err=>{
console.error('Winston MongoDB transport encountered on error during '
+ 'closing.', err);
});
};
/**
* Core logging method exposed to Winston. Metadata is optional.
* @param {string} level Level at which to log the message.
* @param {string} msg Message to log
* @param {Object=} opt_meta Additional metadata to attach
* @param {Function} cb Continuation to respond to when complete.
*/
MongoDB.prototype.log = function(level, msg, opt_meta, cb) {
if (!this.logDb) {
this._opQueue.push({method: 'log', args: arguments});
return;
}
// Avoid reentrancy that can be not assumed by database code.
// If database logs, better not to call database itself in the same call.
process.nextTick(()=>{
if (this.silent) {
cb(null, true);
return;
}
let entry = {timestamp: new Date(), level};
entry.message = this.decolorize ? msg.replace(/\u001b\[[0-9]{1,2}m/g, '') : msg;
entry.meta = helpers.prepareMetaData(opt_meta);
if (this.storeHost) {
entry.hostname = this.hostname;
}
if (this.label) {
entry.label = this.label;
}
this.logDb.collection(this.collection).insertOne(entry).then(()=>{
this.emit('logged');
cb(null, true);
}).catch(err=>{
this.emit('error', err);
cb(err);
});
});
};
/**
* Query the transport. Options object is optional.
* @param {Object=} opt_options Loggly-like query options for this instance.
* @param {Function} cb Continuation to respond to when complete.
* @return {*}
*/
MongoDB.prototype.query = function(opt_options, cb) {
if (!this.logDb) {
this._opQueue.push({method: 'query', args: arguments});
return;
}
if ('function' === typeof opt_options) {
cb = opt_options;
opt_options = {};
}
let options = this.normalizeQuery(opt_options);
let query = {timestamp: {$gte: options.from, $lte: options.until}};
let opt = {
skip: options.start,
limit: options.rows,
sort: {timestamp: options.order === 'desc' ? -1 : 1}
};
if (options.fields) {
opt.fields = options.fields;
}
this.logDb.collection(this.collection).find(query, opt).toArray().then(docs=>{
if (!options.includeIds) {
docs.forEach(log=>delete log._id);
}
cb(null, docs);
}).catch(cb);
};
/**
* Returns a log stream for this transport. Options object is optional.
* This will only work with a capped collection.
* @param {Object} options Stream options for this instance.
* @param {Stream} stream Pass in a pre-existing stream.
* @return {Stream}
*/
MongoDB.prototype.stream = function(options, stream) {
options = options || {};
stream = stream || new Stream;
let start = options.start;
if (!this.logDb) {
this._opQueue.push({method: 'stream', args: [options, stream]});
return stream;
}
stream.destroy = function() {
this.destroyed = true;
};
if (start === -1) {
start = null;
}
let col = this.logDb.collection(this.collection);
if (start != null) {
col.find({}, {skip: start}).toArray().then(docs=>{
docs.forEach(doc=>{
if (!options.includeIds) {
delete doc._id;
}
stream.emit('log', doc);
});
delete options.start;
this.stream(options, stream);
}).catch(err=>stream.emit('error', err));
return stream;
}
if (stream.destroyed) {
return stream;
}
col.isCapped().then(capped=>{
if (!capped) {
return this.streamPoll(options, stream);
}
let cursor = col.find({}, {tailable: true});
stream.destroy = function() {
this.destroyed = true;
cursor.destroy();
};
cursor.on('data', doc=>{
if (!options.includeIds) {
delete doc._id;
}
stream.emit('log', doc);
});
cursor.on('error', err=>stream.emit('error', err));
}).catch(err=>stream.emit('error', err));
return stream;
};
/**
* Returns a log stream for this transport. Options object is optional.
* @param {Object} options Stream options for this instance.
* @param {Stream} stream Pass in a pre-existing stream.
* @return {Stream}
*/
MongoDB.prototype.streamPoll = function(options, stream) {
options = options || {};
stream = stream || new Stream;
let self = this;
let start = options.start;
let last;
if (!this.logDb) {
this._opQueue.push({method: 'streamPoll', args: [options, stream]});
return stream;
}
if (start === -1) {
start = null;
}
if (start == null) {
last = new Date(new Date - 1000);
}
stream.destroy = function() {
this.destroyed = true;
};
(function check() {
let query = last ? {timestamp: {$gte: last}} : {};
self.logDb.collection(self.collection).find(query).toArray().then(docs=>{
if (stream.destroyed) {
return;
}
if (!docs.length) {
return next();
}
if (start == null) {
docs.forEach(doc=>{
if (!options.includeIds) {
delete doc._id;
}
stream.emit('log', doc);
});
} else {
docs.forEach(doc=>{
if (!options.includeIds) {
delete doc._id;
}
if (!start) {
stream.emit('log', doc);
} else {
start -= 1;
}
});
}
last = new Date(docs.pop().timestamp);
next();
}).catch(err=>{
if (stream.destroyed) {
return;
}
next();
stream.emit('error', err);
});
function next() {
setTimeout(check, 2000);
}
})();
return stream;
};