- NPM Downloads Last Month
IOpipe has been acquired by New Relic. Please migrate to the equivalent New Relic Serverless plugin. Check out our migration guide for more information.
A Serverless plugin to add IOpipe observability using AWS Lambda Layers without requiring a code change.
npm install --save-dev serverless-iopipe-layers
yarn add --dev serverless-iopipe-layers
Add the plugin to your
plugins: - serverless-iopipe-layers
Get a free IOpipe token and plug it into your
custom: iopipe: token: your-iopipe-token-here
Deploy and you’re all set.
This plugin wraps your handlers without requiring a code change. If you’re currently using IOpipe, you can remove the wrapping code you currently have and this plugin will do it for you automatically.
The following config options are available via the
iopipe section of the
custom section of your
The IOpipe token to use.
Whether or not to enable debug mode. Must be a boolean value.
custom: iopipe: debug: true
An array of functions to exclude from automatic wrapping.
custom: iopipe: exclude: - excluded-func-1 - another-excluded-func
Pin to a specific layer version. The latest layer ARN is automatically fetched from the IOpipe Layers API
Whether or not to prepend the IOpipe layer. Defaults to
false which appends the layer.
custom: iopipe: prepend: true
This plugin currently supports the following AWS runtimes:
When using with serverless-webpack it is highly recommended to use the
nodejs10.x runtime as this runtime does not require a helper script. For earlier Node.js runtimes a helper script is required which must be included via your
serveless-iopipe-layers plugin must follow the
serverless-webpack plugin in your
serverless.yml. See here for an example.
When using with the Serverless Enterprise Plugin, because this plugin uses a similar method to wrap functions, a helper script must be used. If using with
serverless-webpack, the helper script must be included in your
webpack.config.js as described above.