1.1.1 • Published 5 years ago
@hilarion/mongoose-activity-logger v1.1.1
@hilarion/mongoose-activity-logger
Plugin adds a new document to Logs
collection on each save
, create
, remove
, deleteOne
, deleteMany
, updateMany
, update
, updateOne
, findOneAndDelete
, findOneAndRemove
, findOneAndUpdate
actions performed on other models.
Note: actions that don't modify documents (e.g. find
, findOne
) are not logged.
Getting started
- Install plugin:
npm i --save @hilarion/mongoose-activity-logger
- In your mongoose initialization file after importing mongoose add:
mongoose.plugin(require('@hilarion/mongoose-activity-logger'));
Viewing logs
- Import
Logs
model:const Logs = require('@hilarion/mongoose-activity-logger/models/Logger');
- Query
Logs
:
- by action:
Logs.find({ action: 'save' })
- by collectionName:
Logs.find({ collectionName: 'user' })
- by environment:
Logs.find({ env: 'local' })
- by createdAt timestamp:
Logs.find({ createdAt: { $gte: new Date("2019-10-01T00:00:00.000Z") } })
Log manually
Import
logger
:const logger = require('@hilarion/mongoose-activity-logger/logger');
Usage:
- log message:
logger.log('some message'')
; - log error:
logger.error('some error'')
;