file-morgan
v2.0.0
Published
Use morgan to save logs to the file system in production mode
Downloads
8
Maintainers
Readme
file-morgan
HTTP request logger middleware for node.js
Log HTTP requests to the file system
API
var fileMorgan = require('file-morgan')
fileMorgan(format, options)
Create a new file-morgan logger middleware function using the given format
and options
. The format
(same as
morgan module) argument may be a string of a predefined name (see
morgan predefined name) or a string of compiled format string (see
morgan compile function).
// BASIC EXAMPLE: save logs to a file named `access.log` placed in the `logs` directory
fileMorgan('common')
This will log all requests with error code 400 or higher to logs/access.log
.
This will only occur if
NODE_ENV
is set toproduction
orforceProductionMode
is set to true. Else all requests will be logged to the console ('dev' format).
Options
Options is the same as morgan module. Just added the following properties:
- forceProductionMode
- useStreamRotator
- dateFormat
- fileName
- directory
The option stream
is removed/overwriten.
forceProductionMode
Used for developers to force logging when your application is not running in production mode. Default is false
watchFiles
For performance watching files is optional. When watching files on changes an change event
is emitted. Default is false
useStreamRotator
When set to true a new log file will be created on daily basis. The format of the file is filename-date.log
, where the filename is default access
and the date is formatted as year-month-day (YYYYMMDD)
.
dateFormat
Will be used when useStreamRotator
is set to true and will overwrite the default setting (YYYYMMDD
).
fileName
Default is access.log
.
directory
Default is logs
// EXAMPLE: save logs to a file named 'errors-28022017.log'
fileMorgan('common', {
useStreamRotator: true,
dateFormat: 'DDMMYYYY',
fileName: 'errors.log',
directory: 'logfiles'
})
Events
For now file-morgan emits one event called change
, as defined in SUPPORTED_EVENTS
. To listen to events call on(eventName, listener)
or addListener(eventName, listener)
change
The change
event is emitted when a file has changed in the directory where logs are saved.
Methods
To listen to events there are two methods that can be used.
addListener(eventName, listener)
Alias for on(eventName, listener)
.
on(eventName, listener)
Adds the listener function for the event named eventName. The listener callback gets two arguments (path
, stats
). path
is the path of the file that has changed, and stats
are
the stats (see fs.stats) of the file that has changed.
fileMorgan.on('change', function(path, stats) {
console.log('File ' + path + ' changed size to ' + stats.size)
})
To Do
- [X] Add eslint
- [X] Replace Object.assign with object-assign module
- [ ] Check dependencies
- [X] Add GitHub information to package.json
- [X] Add tests
- [X] Add code coverage
- [ ] Improve tests for default options
- [X] Improve code coverage
- [X] Fire event when log file is changed
- [X] Add npm information
- [ ] Finish README
- [X] Add travis