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

file-morgan

v2.0.0

Published

Use morgan to save logs to the file system in production mode

Downloads

8

Readme

file-morgan

NPM Version NPM Downloads Dependencies Build Status Test Coverage Join the chat at https://gitter.im/file-morgan/Lobby

HTTP request logger middleware for node.js

Log HTTP requests to the file system

API

var fileMorgan = require('file-morgan')

fileMorgan(format, options)

Create a new file-morgan logger middleware function using the given format and options. The format (same as morgan module) argument may be a string of a predefined name (see morgan predefined name) or a string of compiled format string (see morgan compile function).

// BASIC EXAMPLE: save logs to a file named `access.log` placed in the `logs` directory
fileMorgan('common')

This will log all requests with error code 400 or higher to logs/access.log.

This will only occur if NODE_ENV is set to production or forceProductionMode is set to true. Else all requests will be logged to the console ('dev' format).

Options

Options is the same as morgan module. Just added the following properties:

  • forceProductionMode
  • useStreamRotator
  • dateFormat
  • fileName
  • directory

The option stream is removed/overwriten.

forceProductionMode

Used for developers to force logging when your application is not running in production mode. Default is false

watchFiles

For performance watching files is optional. When watching files on changes an change event is emitted. Default is false

useStreamRotator

When set to true a new log file will be created on daily basis. The format of the file is filename-date.log, where the filename is default access and the date is formatted as year-month-day (YYYYMMDD).

dateFormat

Will be used when useStreamRotator is set to true and will overwrite the default setting (YYYYMMDD).

fileName

Default is access.log.

directory

Default is logs

// EXAMPLE: save logs to a file named 'errors-28022017.log'
fileMorgan('common', {
	useStreamRotator: true,
	dateFormat: 'DDMMYYYY',
	fileName: 'errors.log',
	directory: 'logfiles'
})

Events

For now file-morgan emits one event called change, as defined in SUPPORTED_EVENTS. To listen to events call on(eventName, listener) or addListener(eventName, listener)

change

The change event is emitted when a file has changed in the directory where logs are saved.

Methods

To listen to events there are two methods that can be used.

addListener(eventName, listener)

Alias for on(eventName, listener).

on(eventName, listener)

Adds the listener function for the event named eventName. The listener callback gets two arguments (path, stats). path is the path of the file that has changed, and stats are the stats (see fs.stats) of the file that has changed.

fileMorgan.on('change', function(path, stats) {
	console.log('File ' + path + ' changed size to ' + stats.size)
})

To Do

  • [X] Add eslint
  • [X] Replace Object.assign with object-assign module
  • [ ] Check dependencies
  • [X] Add GitHub information to package.json
  • [X] Add tests
  • [X] Add code coverage
  • [ ] Improve tests for default options
  • [X] Improve code coverage
  • [X] Fire event when log file is changed
  • [X] Add npm information
  • [ ] Finish README
  • [X] Add travis

License

MIT