file-stream-rotator

What is file-stream-rotator?

The file-stream-rotator npm package is used for rotating log files based on a specified time interval or file size. It is commonly used in logging systems to manage log file sizes and ensure that logs are archived and rotated properly.

What are file-stream-rotator's main functionalities?

Time-based rotation

This feature allows you to rotate log files based on a specified time interval, such as daily. The log files will be named with the current date.

const FileStreamRotator = require('file-stream-rotator');
const fs = require('fs');

const logStream = FileStreamRotator.getStream({
  filename: 'logs/logfile-%DATE%.log',
  frequency: 'daily',
  verbose: false,
  date_format: 'YYYYMMDD'
});

logStream.write('This is a log message.\n');

Size-based rotation

This feature allows you to rotate log files based on a specified file size. Once the log file reaches the specified size, it will be rotated, and a new log file will be created.

const FileStreamRotator = require('file-stream-rotator');
const fs = require('fs');

const logStream = FileStreamRotator.getStream({
  filename: 'logs/logfile-%DATE%.log',
  size: '10M',
  max_logs: '10',
  audit_file: 'logs/audit.json'
});

logStream.write('This is a log message.\n');

Custom rotation

This feature allows you to define custom rotation strategies, combining both time and size-based rotation. You can specify the frequency, size, and other parameters to control the rotation behavior.

const FileStreamRotator = require('file-stream-rotator');
const fs = require('fs');

const logStream = FileStreamRotator.getStream({
  filename: 'logs/logfile-%DATE%.log',
  frequency: 'custom',
  verbose: false,
  date_format: 'YYYYMMDD',
  size: '5M',
  max_logs: '5',
  audit_file: 'logs/audit.json',
  end_stream: true
});

logStream.write('This is a log message.\n');

Other packages similar to file-stream-rotator

winston-daily-rotate-file

The winston-daily-rotate-file package is a transport for the winston logging library that allows for daily log file rotation. It provides similar functionality to file-stream-rotator but is specifically designed to work with the winston logging library.

rotating-file-stream

The rotating-file-stream package provides a similar functionality of rotating log files based on time or size. It offers more flexibility in terms of configuration and supports various rotation strategies.

logrotate-stream

The logrotate-stream package is a simple stream that rotates log files based on size. It is less feature-rich compared to file-stream-rotator but can be a lightweight alternative for basic log rotation needs.

README

####NOTE: This project is no longer maintained. If you're interested in taking ownership, please contact us####

file-stream-rotator

NodeJS file stream rotator

Purpose

To provide an automated rotation of Express/Connect logs based on date.

Install

npm install file-stream-rotator

Usage

# Default date added at the end of the file
var rotatingLogStream = require('file-stream-rotator').getStream({filename:"/tmp/test.log", frequency:"daily", verbose: false});

# Default date added using file pattern
var rotatingLogStream = require('file-stream-rotator').getStream({filename:"/tmp/test-%DATE%.log", frequency:"daily", verbose: false});

# Custom date added using file pattern using moment.js formats
var rotatingLogStream = require('file-stream-rotator').getStream({filename:"/tmp/test-%DATE%.log", frequency:"daily", verbose: false, date_format: "YYYY-MM-DD"});

.....

// Use new stream in express
app.use(express.logger({stream: rotatingLogStream, format: "default"}));
.....
frequency options include:
* daily
* rotate on given minutes using the 'm' option i.e. 5m or 30m
** var rotatingLogStream = require('file-stream-rotator').getStream({filename:"/tmp/test.log", frequency:"5m", verbose: false});
* rotate on the hour or any specified number of hours
** var rotatingLogStream = require('file-stream-rotator').getStream({filename:"/tmp/test.log", frequency:"1h", verbose: false});
* test - creates a log file with a date suffix

NPM Maintainers

The npm module for this library is maintained by:

• Dan Jenkins
• Roger Castells
• Viktor Trako

License

file-stream-rotator is licensed under the MIT license.