alpha-lambda-bunyan

alpha-lambda-bunyan

Middleware for alpha-lambda that adds log and child methods to the context object.

Installation

$ npm install alpha-lambda-bunyan

Usage

const bunyan = require('alpha-lambda-bunyan');
const handler = require('alpha-lambda');

module.exports = handler()
  .use(bunyan({
    level: 'debug',
    serializers: {
      event(data) => { id: data.id }
    }
  }))
  .use((event, context) => {
    context.log({ event }, 'event received');

    const newContext = context.child({ event });
    return doSomething(newContext, event);
  });

context.log

context.log is a bunyan instance initialized with such properties:

• name: name of the AWS Lambda function
• level: logging level taken from options.level or LOG_LEVEL environment variable; info by default (check bunyan documentation for more information)
• awsRequestId: AWS request ID associated with the request
• functionVersion: the AWS Lambda function version that is executing
• serializers: custom serializers for err / error object (based on bunyan.stdSerializers.err, but custom error fields, if present, are included as well), and context object (to prevent log and child properties from being logged) (can be overridden/extended using options.serializers)

context.child

context.child method provides a way to create child logger with additional bound fields to be included into log records. Please note, that original context is cloned, so it is not mutated. This method is based on bunyan's log.child method.

extend(context, [options])

Library exports extend method, so it can be used not just like middleware.

const bunyan = require('alpha-lambda-bunyan');
const handler = require('alpha-lambda');

module.exports = handler()
  .use((event, context) => {
    const newContext = bunyan.extend(context, { level: 'debug' });
    return doSomething(newContext, event);
  });

Configuration

alpha-lambda-bunyan accepts an optional configuration object, where:

• [level] - { String | Number } - logging level; when not set, logging level is taken from LOG_LEVEL environment variable (info by default)
• [serializers] - { Object } - custom serializers that override / extend existing ones
• [refProps] - { String | String[] } - properties on the context that should be shallow copied and not deep copied when a child context is created

License

The MIT License (MIT)

Copyright (c) 2017 Anton Bazhal

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.