serverless-instana-wrapper v1.0.2

Serverless Instana Wrapper plugin

Automatically update your lambda's handler post-deploy to use the Instana AutoTrace layer.

Installation

From your serverless project folder run:

npm install serverless-instana-wrapper -D

Add the plugin to your serverless.yml:

plugins:
  - serverless-instana-wrapper

Configuration

The Instana lambda layer must be added to each function config before this plugin will work. To configure it for all functions in the stack, add the following under the 'provider' section of your serverless file and replace 'XX' with the desired version of the layer. You will still be required to periodically update the layer's version number to take advantage of any new features.

layers: 
    arn:aws:lambda:eu-west-2:410797082306:layer:instana-nodejs:XX

View a list of Instana lambda layer versions here

NOTE: The above ARN is for eu-west-2, a full list of ARNs for the layer can be found here.

The following environment variables must also be added to the provider or specific function section of your serverless file:

environment:
    INSTANA_ENDPOINT_URL: https://serverless-blue-saas.instana.io
    INSTANA_AGENT_KEY: ************
    # Optional extra headers to add to traces for projects utilising API Gateway
    INSTANA_EXTRA_HTTP_HEADERS: X-Custom-Header-One;X-Custom-Header-Two

You MUST NOT change the 'handler' reference for your function(s) as per Instana's documentation, you should leave these pointed at your own code and this plugin will switch it for you. There is also no need to install the @instana/lambda NPM module or make any changes to your function's code.

Why is it needed?

Due to how the serverless framework packages functions, the lambda handler reference cannot point to code external to your project's code (i.e. a lambda layer). There are ways around this but if you are using serverless-webpack, the problem gets worse and requires a manual step after deployment. This plugin addresses that issue by retrieving the lambda handler's reference and adding it to a LAMBDA_HANDLER environment variable in your function(s). The original handler reference will then be replaced with instana-aws-lambda-auto-wrap.handler to activate the layer.