@schibsted/middy-access-log

Middy access log middleware

Access log middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

This middleware logs processed requests in an access log like fashion. I suggest using it together with @schibsted/middy-error-handler

This access log is optimised for JSON loggers e.g. bunyan or pino

Sets headers in after and onError phases.

Install

To install this middleware you can use NPM:

npm install --save @schibsted/middy-access-log

Options

• logger (defaults to console) - a logging function that is invoked with the current error as an argument. You can pass false if you don't want the logging to happen.
• level (defaults to info) - log level to use for the log entries
• excludeHeaders (array of header names, defaults to []) - prevent specified headers from showing up in logs (e.g. user credentials)

See the sample usage below.

Sample usage

const middy = require('@middy/core');
const accessLog = require('@schibsted/middy-access-log');
const bunyan = require('bunyan');
const logger = bunyan.createLogger({name: "myapp"});

const handler = middy(async () => ({
        statusCode: 200,
        body: JSON.stringify({ foo: 'bar' }),
    }));

handler
  .use(accessLog({ logger }));

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

Changelog

4.0.2 (2022-08-29)

Build System

• deps: bump got and release-it (#112) (5297d2c)

Miscellaneous Chores

• deps: update dependency @babel/eslint-parser to v7.18.9 (#105) (5c5c313)
• deps: update dependency @middy/core to v3.1.0 (#107) (41fc0a4)
• deps: update dependency @middy/core to v3.3.0 (#114) (1a72b32)
• deps: update dependency eslint to v8.23.0 (#115) (7964699)
• deps: update dependency jest to v28.1.3 (#108) (6b5dd2a)
• deps: update dependency jest to v29 (#113) (642a568)
• deps: update linters (#103) (d58f611)
• deps: update linters (#106) (7d81c0d)
• deps: update release-related tools (#104) (a6ec4b0)