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

@uswitch/koa-access

v2.9.11

Published

πŸ‘Œ A Koa middleware for logging JSON access logs consistently, similar to morgan

Downloads

7,088

Readme

Contributors License type language test style

Overview

This package is a Koa middleware inspired by Morgan, an access log middleware for Express.

It tries to address the following;

  • πŸ–Œ Custom formatting - Allow you to inject your own formatting
  • πŸ’° Custom tokens - Allow you to add your own extra logging tokens
  • πŸ““ JSON tokens - All of this is handled using JSON rather than strings

All of this allows you to create consistent access logs decoupled from the actual implementation of your code.


Usage

import Koa from 'koa'
import access from 'koa-access'

const app = new Koa()

app.use(access())           /* Default configuration */
app.use(access([ 'id' ]))   /* Add `id` from `ctx.state` to access log */

app.use(access(readContext)) /* Read extra poperties by calling `readContext` on `ctx` */

app.on('koa-access:access', Logger.log)

This package uses Event Emitters to decouple the handling of logging from the implementation of your code.

API

By default, the koa-access will bundle the following properties into an object and fire them on the the koa-access:access event.

{
  "res": {
    "responseTime": 23    // Response time in `ms`
    "length": 23232       // Content length of the response
    "status": 200         // Response status
    "statusBucket": "2XX" // Status as a bucket string
    "time": "2017-..."    // Timestamp of the response
  },
  "req": {
    "method": "GET"       // Method of request
    "path": "/foo/bar"    // Path being accessed
    "time": "2017-..."    // Timestamp of request start
    "host": "127.0.0.1"   // Host of the request
  }
}

The koa-access can be configured with extra parameters in one of two ways,

Array - access([ 'id', 'errors' ])

This will add the id and errors properties from the Koa ctx.state object onto the access log object.

Function - access((ctx) => ({ id: ctx.state.id, errors: ctx.state.errors }))

This will return an object by calling the function on Koa's ctx object, in this example, it'll just grab the id and errors properties from the state.

Events

Once a request access log has been built, the following event is fired with the access object

koa-access:access => (ctx, { req, res, ...extras })

The event can be imported from the koa-access module, as

import { eventAccess } from 'koa-access

Contributors

Thanks goes to these wonderful people (emoji key):

| Dom CharlesworthπŸ“– πŸ’» πŸ€” πŸ”Œ | David AnnezπŸ’» πŸ€” πŸ”Œ | | :---: | :---: |

This project follows the all-contributors specification. Contributions of any kind welcome!