@linzjs/lambda
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    Lambda wrapper @linzjs/lambda

    A minimal lambda wrapper for LINZ Javascript lambda function development

    • Automatically chooses the correct HTTP output event format based on input event (API Gateway, ALB or Cloudfront)
    • Generates a request id for every request using a ULID
    • Automatically Logs the correlationId if one is provided to the function.
    • Logs a meta log at the end of the request @type: "report"
    • Tracks performance and logs request duration & metrics using @linzjs/metrics

    Why?

    This repository wraps the default lambda handler so it can be invoked by ALB, API Gateway or Cloudfront without requiring code changes, while also apply a opinionated set of lambda defaults

    Http

    import {lf, LambdaHttpResponse} from '@linzjs/lambda';
    
    // This works for Cloud front, ALB or API Gateway events
    export const handler = lf.http(async (req) => {
      if (req.method !== 'POST') throw new LambdaHttpResponse(400, 'Invalid method');
      return new LambdaHttpResponse(200, 'Ok');
    });

    Lambda

    import {lf} from '@linzjs/lambda';
    
    export const handler = lf.handler<S3Event>(async (req) => {
        if (req.event.Records.length === 0) throw new Error('No records provided');
        for (const evt of req.event.Records) {
            req.log.info({key: evt.key}, 'Request s3')
        }
    });

    Request ID generation

    A ULID is generated for every request and can be accessed at req.id

    every log message generated by req.log will by include the request id.

    Metrics

    Simple timing events can be tracked with timer see @linzjs/metrics

    req.timer.start('some:event');
    // Do Work
    const duration = req.timer.end('some:event');

    Metalog

    At the end of every request a metalog is logged with use information for monitoring and alerting in something like elasticsearch, to add additional keys to the metatalog use req.set()

    req.set('xyz', { x, y, z });
    req.set('location', { lat, lon });

    Pino logging

    Automatically includes a configured pino logger

    function doRequest(req) {
        req.log.info('Some Log line'); // Includes useful information like requestId
    }

    This can be overridden at either the wrapper

    export const handler = LambdaFunction.wrap(doRequest, myOwnLogger)

    of set a different default logger

    LambdaFunction.logger = myOwnLogger;
    export const handler = LambdaFunction.wrap(doRequest)

    Keywords

    none

    Install

    npm i @linzjs/lambda

    DownloadsWeekly Downloads

    57

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    191 kB

    Total Files

    65

    Last publish

    Collaborators

    • linzds
    • blacha
    • philals