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

express-logging

v1.1.1

Published

Express middleware to log each request and response

Downloads

596,276

Readme

express-logging

Express middleware to log, using a configurable logger, each request and response.

npm version Build Status Coverage Status

Installation

npm install express-logging

Basic usage

var express = require('express'),
    expressLogging = require('express-logging'),
    logger = require('logops');

var app = express();
app.use(expressLogging(logger));

app.listen(3000);

Extended usage with options

An optional argument options can customize enhanced aspects for the logging. This argument is an object with the following elements:

  • blacklist is available to prevent some resources from being logged (for example, static resources). This argument is an array of strings. If the URL path starts with any of the elements of the blacklist array, then the logging of this request/response is ignored.
  • policy is a string to customize how the info is logged. It supports two values: message or params. The former serializes all the log entry into a single string message. The latter passes to the logger an object with the log entry parameters and a second argument with the message; this policy is useful in order to process these parameters by systems like logstash. The default value is message.

The following example would ignore any resource available at either /images or /html. It also activates the logging policy params.

var blacklist = ['/images', '/html'];
app.use(expressLogging(logger, {blacklist: blacklist, policy: 'params'}));

Logs

### Logging with default policy message

The request is logged with:

logger.info('Request from %s: %s %s', clientIpAddress, requestMethod, requestUrl);

A response without Location header is logged with:

logger.info('Response with status %d in %d ms.', responseStatusCode, duration);

A response with Location header is logged with:

logger.info('Response with status %d in %d ms. Location: %s', responseStatusCode, duration, locationHeader);

Both response log entries include the duration of the whole transaction (between receiving the request until replying with the response).

### Logging with policy params

The request is logged with:

var params = {requestClientIp: requestClientIp, requestMethod: requestMethod, requestUrl: requestUrl};
logger.info(params, 'Request from %s: %s', requestMethod, requestUrl);

A response without Location header is logged with:

var params = {responseStatusCode: responseStatusCode, responseDuration: duration};
logger.info(params, 'Response with status %d', responseStatusCode);

A response with Location header is logged with:

var params = {responseStatusCode: responseStatusCode, responseDuration: duration, responseLocation: locationHeader};
logger.info(params, 'Response with status %d', responseStatusCode);

Both response log entries include the duration of the whole transaction (between receiving the request until replying with the response).

License

Copyright 2015, 2016 Telefónica Investigación y Desarrollo, S.A.U

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.