rotating-file-stream

What is rotating-file-stream?

The rotating-file-stream npm package is used to create a stream that writes to a file and rotates the file based on a specified condition, such as file size or time interval. This is particularly useful for logging purposes where you want to manage log file sizes and avoid having a single, ever-growing log file.

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

Time-based rotation

This feature allows you to rotate the log file based on a time interval. In this example, the log file 'access.log' will be rotated daily and stored in the '/var/log' directory.

const rfs = require('rotating-file-stream');
const stream = rfs.createStream('access.log', {
  interval: '1d', // rotate daily
  path: '/var/log'
});

Size-based rotation

This feature allows you to rotate the log file based on its size. In this example, the log file 'access.log' will be rotated every time it reaches 10MB and stored in the '/var/log' directory.

const rfs = require('rotating-file-stream');
const stream = rfs.createStream('access.log', {
  size: '10M', // rotate every 10 MegaBytes written
  path: '/var/log'
});

Compression

This feature allows you to compress the rotated log files. In this example, the log file 'access.log' will be rotated daily and compressed using gzip, then stored in the '/var/log' directory.

const rfs = require('rotating-file-stream');
const stream = rfs.createStream('access.log', {
  interval: '1d', // rotate daily
  compress: 'gzip', // compress rotated files
  path: '/var/log'
});

Custom rotation

This feature allows you to specify a custom rotation policy. In this example, the log file 'access.log' will be rotated and up to 7 rotated files will be kept in the '/var/log' directory.

const rfs = require('rotating-file-stream');
const stream = rfs.createStream('access.log', {
  rotate: 7, // keep 7 rotated files
  path: '/var/log'
});

Other packages similar to rotating-file-stream

winston-daily-rotate-file

The winston-daily-rotate-file package is a transport for the winston logging library that allows you to rotate log files based on a time interval. It is similar to rotating-file-stream in that it supports time-based rotation and compression, but it is specifically designed to work with the winston logging library.

logrotate-stream

The logrotate-stream package provides a writable stream that rotates log files based on size or time. It is similar to rotating-file-stream in terms of functionality, but it offers a simpler API and fewer configuration options.

file-stream-rotator

The file-stream-rotator package is another option for rotating log files based on size or time. It offers similar features to rotating-file-stream, including time-based and size-based rotation, as well as compression. However, it is less actively maintained compared to rotating-file-stream.

README

rotating-file-stream

example

var rfs    = require("rfs");
var stream = rfs("file.log", {
    size:     "10M", // rotate every 10 MegaBytes written
    interval: "1d"   // rotate daily
});

under development

This package is currently under development.

fs.createWriteStream