npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rotating-log

v0.1.1

Published

Rotating log file with writable stream interface

Downloads

5

Readme

rotating-log

Writable stream with an underlying rotating log file. The rotation is somewhat configurable (to become moreso), but defaults to rotating daily or once the size of the file >= 50MB, and only one rotated log file will be kept.

This is a simple module. It does not do compression or anything fancy, and could probably stand to have more error checking in place. It only exposes a writable stream interface and has no additional methods.

One feature (important to me), is that the log file is never moved/removed, and can be read from (via tail -f or whatever) indefinitely, even through rotations. When it comes time to rotate, output to the file is paused, the file is copied to the same name + '.1' (the existing '.1' is rotated to '.2' before-hand, etc), then the logfile is truncated in place, and finally logging is resumed. During this (relatively quick) process, log messages will be buffered in memory, which always carries a risk.

Install

npm install rotating-log

Example

var RotatingLog = require('rotating-log')
,   logfile     = '/tmp/rotating-log-demo.log'
,   log         = RotatingLog(logfile, {keep:2, maxsize:512}) // 512 byte cap

log.on('rotated', function () {
    console.log('The log file was rotated.')
})
log.on('error', function (err) {
    console.error('There was an error: %s', err.message || err)
})

setInterval(function () {
    log.write( (new Date).toString() + '\n' )
}, 1000)

console.log('Logging to %s', logfile)
console.log('execute "tail -f %s" to watch log. press ctrl-c to exit.', logfile)

Usage

RotatingLog(logfilepath, options)

  • logfilepath (required) - path to the log file
  • options (default: {}) - configurable behaviour options

Configuration Options

  • keep (default:1) - number of rotated log files to keep; rotations beyond this number are removed
  • maxsize (default:50MB) - maximum size of log file before rotation is forced (IN BYTES)

Supported Events

  • rotating - Emitted once a rotation begins
  • rotated - Emitted once a rotation has completed

Rotated Filenames

Rotated logfiles will be found in the same directory as the primary log file with an extra index appended to the filename. The higher the digit, the older the rotated logfile (this is identical to traditional unix logging). For example, the following command:

var log = new RotatingLog('/tmp/test.log', {keep:3})

Will result in the following files (after a couple of days):

test.log
test.log.1
test.log.2
test.log.3

The next time the log is rotated, test.log.3 will be removed, test.log.2 will become test.log.3, test.log.1 will become test.log.2, and test.log will become test.log.1. Afterwards, test.log is truncated.

Testing

npm test