Skip to content

Commit

Permalink
support passing through timed frequencies, if desired (#208)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattberther authored Jan 14, 2019
1 parent 508892e commit 4bbc067
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ npm install winston-daily-rotate-file
## Options
The DailyRotateFile transport can rotate files by minute, hour, day, month, year or weekday. In addition to the options accepted by the logger, `winston-daily-rotate-file` also accepts the following options:

* **frequency:** A string representing the frequency of rotation. This is useful if you want to have timed rotations, as opposed to rotations that happen at specific moments in time. Valid values are '#m' or '#h' (e.g., '5m' or '3h'). Leaving this null relies on `datePattern` for the rotation times. (default: null)
* **datePattern:** A string representing the [moment.js date format](http://momentjs.com/docs/#/displaying/format/) to be used for rotating. The meta characters used in this string will dictate the frequency of the file rotation. For example, if your datePattern is simply 'HH' you will end up with 24 log files that are picked up and appended to every day. (default 'YYYY-MM-DD')
* **zippedArchive:** A boolean to define whether or not to gzip archived log files. (default 'false')
* **filename:** Filename to be used to log to. This filename can include the `%DATE%` placeholder which will include the formatted datePattern at that point in the filename. (default: 'winston.log.%DATE%)
Expand Down
2 changes: 1 addition & 1 deletion daily-rotate-file.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ var DailyRotateFile = function (options) {

this.logStream = require('file-stream-rotator').getStream({
filename: path.join(this.dirname, this.filename),
frequency: 'custom',
frequency: options.frequency ? options.frequency : 'custom',
date_format: options.datePattern ? options.datePattern : 'YYYY-MM-DD',
verbose: false,
size: getMaxSize(options.maxSize),
Expand Down

0 comments on commit 4bbc067

Please sign in to comment.