forked from pinojs/pino
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pino.js
409 lines (365 loc) Β· 11.1 KB
/
pino.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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
'use strict'
var os = require('os')
var EventEmitter = require('events').EventEmitter
var stringifySafe = require('fast-safe-stringify')
var serializers = require('pino-std-serializers')
var fs = require('fs')
var util = require('util')
var pump = require('pump')
var flatstr = require('flatstr')
var pretty = require('./pretty')
var events = require('./lib/events')
var levels = require('./lib/levels')
var tools = require('./lib/tools')
var time = require('./lib/time')
var needsMetadata = Symbol.for('needsMetadata')
var isStandardLevelVal = levels.isStandardLevelVal
var isStandardLevel = levels.isStandardLevel
var applyOptions = tools.applyOptions
var LOG_VERSION = 1
var defaultOptions = {
safe: true,
name: undefined,
serializers: {},
timestamp: time.epochTime,
slowtime: false,
extreme: false,
level: 'info',
levelVal: undefined,
prettyPrint: false,
onTerminated: function (eventName, err) {
if (err) return process.exit(1)
process.exit(0)
},
base: {
pid: process.pid,
hostname: os.hostname()
},
enabled: true,
appendLineEndings: true,
messageKey: 'msg'
}
var pinoPrototype = Object.create(EventEmitter.prototype, {
silent: {
value: tools.noop,
enumerable: true
},
stream: {
value: process.stdout,
writable: true
},
pino: {
value: require('./package.json').version,
enumerable: true
}
})
var levelMethods = ['fatal', 'error', 'warn', 'info', 'debug', 'trace']
levelMethods.forEach(function (m) {
Object.defineProperty(pinoPrototype, m, {
value: tools.genLog(levels.levels[m]),
enumerable: true,
writable: true
})
})
function getLevelVal () {
return this._levelVal
}
function setLevelVal (num) {
if (typeof num === 'string') { return this._setLevel(num) }
if (this.emit) {
this.emit('level-change', this.levels.labels[num], num, this.levels.labels[this._levelVal], this._levelVal)
}
this._levelVal = num
for (var key in this.levels.values) {
if (num > this.levels.values[key]) {
this[key] = tools.noop
continue
}
this[key] = isStandardLevel(key) ? pinoPrototype[key] : tools.genLog(this.levels.values[key])
}
}
Object.defineProperty(pinoPrototype, 'levelVal', {
get: getLevelVal,
set: setLevelVal
})
function _setLevel (level) {
if (typeof level === 'number') {
if (!isFinite(level)) {
throw Error('unknown level ' + level)
}
level = this.levels.labels[level]
}
if (!this.levels.values[level]) {
throw Error('unknown level ' + level)
}
this.levelVal = this.levels.values[level]
}
Object.defineProperty(pinoPrototype, '_setLevel', {
value: _setLevel
})
Object.defineProperty(pinoPrototype, '_getLevel', {
value: function _getLevel (level) {
return this.levels.labels[this.levelVal]
}
})
Object.defineProperty(pinoPrototype, 'level', {
get: pinoPrototype._getLevel,
set: pinoPrototype._setLevel
})
Object.defineProperty(pinoPrototype, '_lscache', {
value: tools.copy({}, levels.lscache)
})
Object.defineProperty(
pinoPrototype,
'LOG_VERSION',
{value: LOG_VERSION}
)
function asJson (obj, msg, num, time) {
// to catch both null and undefined
var hasObj = obj !== undefined && obj !== null
var objError = hasObj && obj instanceof Error
msg = !msg && objError ? obj.message : msg || undefined
var data = this._lscache[num] + time
if (msg !== undefined) {
// JSON.stringify is safe here
data += this.messageKeyString + JSON.stringify('' + msg)
}
// we need the child bindings added to the output first so that logged
// objects can take precedence when JSON.parse-ing the resulting log line
data = data + this.chindings
var value
if (hasObj) {
var notHasOwnProperty = obj.hasOwnProperty === undefined
if (objError) {
data += ',"type":"Error","stack":' + this.stringify(obj.stack)
}
// if global serializer is set, call it first
if (this.serializers[Symbol.for('pino.*')]) {
obj = this.serializers[Symbol.for('pino.*')](obj)
}
for (var key in obj) {
value = obj[key]
if ((notHasOwnProperty || obj.hasOwnProperty(key)) && value !== undefined) {
value = this.stringify(this.serializers[key] ? this.serializers[key](value) : value)
if (value !== undefined) {
data += ',"' + key + '":' + value
}
}
}
}
return data + this.end
}
Object.defineProperty(pinoPrototype, 'asJson', {
enumerable: true,
value: asJson
})
function asChindings (that, bindings) {
if (!bindings) {
throw Error('missing bindings for child Pino')
}
var key
var value
var data = that.chindings
if (that.serializers[Symbol.for('pino.*')]) {
bindings = that.serializers[Symbol.for('pino.*')](bindings)
}
for (key in bindings) {
value = bindings[key]
if (key !== 'level' && key !== 'serializers' && bindings.hasOwnProperty(key) && value !== undefined) {
value = that.serializers[key] ? that.serializers[key](value) : value
data += ',"' + key + '":' + that.stringify(value)
}
}
return data
}
function child (bindings) {
var opts = {
chindings: asChindings(this, bindings),
level: bindings.level || this.level,
levelVal: isStandardLevelVal(this.levelVal) ? undefined : this.levelVal,
serializers: bindings.hasOwnProperty('serializers') ? Object.assign({}, this.serializers, bindings.serializers) : this.serializers
}
var _child = Object.create(this)
_child.stream = this.stream
applyOptions(_child, opts)
return _child
}
Object.defineProperty(pinoPrototype, 'child', {
enumerable: true,
value: child
})
function pinoWrite (obj, msg, num) {
var t = this.time()
var s = this.asJson(obj, msg, num, t)
var stream = this.stream
if (this.cache === null) {
if (stream[needsMetadata]) {
stream.lastLevel = num
stream.lastMsg = msg
stream.lastObj = obj
stream.lastTime = t.slice(8)
stream.lastLogger = this // for child loggers
}
stream.write(flatstr(s))
return
}
this.cache.buf += s
if (this.cache.buf.length > this.cache.size) {
stream.write(flatstr(this.cache.buf))
this.cache.buf = ''
}
}
Object.defineProperty(pinoPrototype, 'write', {
value: pinoWrite
})
function flush () {
if (!this.cache) {
return
}
this.stream.write(flatstr(this.cache.buf))
this.cache.buf = ''
}
Object.defineProperty(pinoPrototype, 'flush', {
enumerable: true,
value: flush
})
function addLevel (name, lvl) {
if (this.levels.values.hasOwnProperty(name)) return false
if (this.levels.labels.hasOwnProperty(lvl)) return false
this.levels.values[name] = lvl
this.levels.labels[lvl] = name
this._lscache[lvl] = flatstr('{"level":' + Number(lvl))
Object.defineProperty(this, name, {
value: lvl < this._levelVal ? tools.noop : tools.genLog(lvl),
enumerable: true,
writable: true
})
return true
}
Object.defineProperty(pinoPrototype, 'addLevel', {
enumerable: true,
value: addLevel
})
function isLevelEnabled (logLevel) {
var logLevelVal = this.levels.values[logLevel]
return logLevelVal && (logLevelVal >= this._levelVal)
}
Object.defineProperty(pinoPrototype, 'isLevelEnabled', {
enumerable: true,
value: isLevelEnabled
})
function pino (opts, stream) {
var iopts = opts
var istream = stream
if (iopts && (iopts.writable || iopts._writableState)) {
istream = iopts
iopts = defaultOptions
}
iopts = Object.assign({}, defaultOptions, iopts)
if (iopts.extreme && iopts.prettyPrint) throw Error('cannot enable pretty print in extreme mode')
istream = istream || process.stdout
var isStdout = istream === process.stdout
if (!isStdout && iopts.prettyPrint) throw Error('cannot enable pretty print when stream is not process.stdout')
if (iopts.prettyPrint) {
var prettyOpts = Object.assign({ messageKey: iopts.messageKey }, iopts.prettyPrint)
var pstream = pretty(prettyOpts)
pump(pstream, process.stdout, function (err) {
if (err) instance.emit('error', err)
})
istream = pstream
}
// internal options
iopts.stringify = iopts.safe ? stringifySafe : JSON.stringify
iopts.formatOpts = {lowres: true}
iopts.messageKeyString = `,"${iopts.messageKey}":`
iopts.end = ',"v":' + LOG_VERSION + '}' + (iopts.appendLineEndings !== false ? (iopts.crlf ? '\r\n' : '\n') : '')
iopts.cache = !iopts.extreme ? null : {
size: 4096,
buf: ''
}
iopts.chindings = ''
if (iopts.enabled === false) {
iopts.level = 'silent'
}
var instance = Object.create(pinoPrototype)
instance.stream = istream
tools.defineLevelsProperty(instance)
instance.stringify = iopts.stringify
instance.end = iopts.end
instance.name = iopts.name
instance.timestamp = iopts.timestamp
instance.slowtime = iopts.slowtime
instance.cache = iopts.cache
instance.formatiopts = iopts.formatiopts
instance.onTerminated = iopts.onTerminated
instance.messageKey = iopts.messageKey
instance.messageKeyString = iopts.messageKeyString
applyOptions(instance, iopts)
if (iopts.slowtime) {
instance.time = time.slowTime
util.deprecate(tools.noop, '(pino) `slowtime` is deprecated: use `timestamp: pino.stdTimeFunctions.slowTime`')()
} else if (iopts.timestamp && Function.prototype.isPrototypeOf(iopts.timestamp)) {
instance.time = iopts.timestamp
} else if (iopts.timestamp) {
instance.time = time.epochTime
} else {
instance.time = time.nullTime
}
if (iopts.cache) setTimeout(waitForFDSettle, 100)
var settleTries = 0
function waitForFDSettle () {
var isBlockable = tools.streamIsBlockable(istream)
if (isBlockable === false && settleTries > 10) {
return instance.emit('error', Error('stream must have a file descriptor in extreme mode'))
} else if (isBlockable === true) {
return events(instance, extremeModeExitHandler)
}
settleTries += 1
setTimeout(waitForFDSettle, 100)
}
function extremeModeExitHandler () {
var buf = iopts.cache.buf
if (buf) {
// We need to block the process exit long enough to flush the buffer
// to the destination stream. We do that by forcing a synchronous
// write directly to the stream's file descriptor.
var fd = (istream.fd) ? istream.fd : istream._handle.fd
fs.writeSync(fd, buf)
}
}
var base = (typeof iopts.base === 'object') ? iopts.base : defaultOptions.base
if (iopts.name !== undefined) {
base = Object.assign({}, base, {
name: iopts.name
})
}
if (base !== null) {
instance = instance.child(base)
}
return instance
}
tools.defineLevelsProperty(pino)
module.exports = pino
module.exports.stdSerializers = {
req: serializers.req,
res: serializers.res,
err: serializers.err,
wrapRequestSerializer: serializers.wrapRequestSerializer,
wrapResponseSerializer: serializers.wrapResponseSerializer
}
Object.defineProperty(module.exports.stdSerializers, 'wrapRespnonseSerializer', {
enumerable: true,
get: util.deprecate(
function () {
return serializers.wrapResponseSerializer
},
'`pino.stdSerializers.wrapRespnonseSerializer` is deprecated: use `pino.stdSerializers.wrapResponseSerializer`'
)
})
module.exports.stdTimeFunctions = Object.assign({}, time)
module.exports.pretty = pretty
Object.defineProperty(
module.exports,
'LOG_VERSION',
{value: LOG_VERSION, enumerable: true}
)