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

pino-roll

v2.2.0

Published

A Pino transport that automatically rolls your log files

Downloads

618,155

Readme

pino-roll

A Pino transport that automatically rolls your log files.

Install

npm i pino-roll

Usage

import { join } from 'path'
import pino from 'pino'

const transport = pino.transport({
  target: 'pino-roll',
  options: { file: join('logs', 'log'), frequency: 'daily', mkdir: true }
})

const logger = pino(transport)

(Also works in CommonJS)

API

build(options) => SonicBoom

Creates a Pino transport (a Sonic-boom stream) to writing into files. Automatically rolls your files based on a given frequency, size, or both.

Options

You can specify any of Sonic-Boom options except dest

  • file: absolute or relative path to the log file. Your application needs the write right on the parent folder. Number will be appened to this file name. When the parent folder already contains numbered files, numbering will continue based on the highest number. If this path does not exist, the logger with throw an error unless you set mkdir to true. file may also be a function that returns a string.

  • size?: the maximum size of a given log file. Can be combined with frequency. Use k, m and g to express values in KB, MB or GB. Numerical values will be considered as MB.

  • frequency?: the amount of time a given log file is used. Can be combined with size. Use daily or hourly to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used. Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.

  • extension?: appends the provided string after the file number.

  • symlink?: creates a symlink to the current log file. The symlink will be updated to the latest log file upon rotation. The name of the symlink is always called current.log.

  • limit?: strategy used to remove oldest files when rotating them:

  • limit.count?: number of log files, in addition to the currently used file.

  • dateFormat?: the format for appending the current date/time to the file name. When specified, appends the date/time in the provided format to the log file name. Supports date formats from date-fns (see: date-fns format documentation). For example: Daily: 'yyyy-MM-dd'error.2024-09-24.log Hourly: 'yyyy-MM-dd-hh'error.2024-09-24-05.log

Please not that limit only considers created log files. It will not consider any pre-existing files. Therefore, starting your logger with a limit will never tries deleting older log files, created during previous executions.

License

MIT