A serverless plugin to automatically wrap your functions with iopipe.

• Node >= 4.3.2
• NPM >= 2.14.12
• Serverless >= 1.13.0
• Yarn >= 0.22.0 (optional)
• A valid package.json file
• A valid serverless.yml file

With yarn (recommended) in project directory:

yarn add iopipe
npm install serverless-plugin-iopipe -g
npm link serverless-plugin-iopipe

With npm in project directory:

npm install iopipe
npm install serverless-plugin-iopipe -g
npm link serverless-plugin-iopipe

Add the plugin to your serverless.yml file:

plugins:
  - serverless-plugin-iopipe

Add your IOpipe project token within the "custom" config in serverless.yml. Where is the token?

custom:
  iopipeToken: YOUR_TOKEN HERE

You're set! The plugin will run during an sls deploy.

serverless-plugin-iopipe wraps the function handlers defined in serverless.yml with IOpipe so you don't have to. It allows you to deploy and upgrade multiple functions simultaneously.

It's powered by the the excellent jscodeshift. The plugin examines each handler and modifies the code only within the deployment package if it needs to.

All options are set in the "custom" config in serverless.yml. See Example

The token (clientId) of the project you would like to wrap your functions with.

Skip a check that ensures iopipe is installed via npm/yarn and present in package.json

The plugin automatically upgrades the IOpipe library to the latest available version that satisfies the semver range specified in package.json. Use this option to disable that feature.

When auto-upgrading, Yarn will be used in place of NPM if a yarn.lock file is found. Use this flag disable yarn and use NPM to upgrade the iopipe library.

Exclude certain functions from the plugin. Comma separated string.

Use process.env.IOPIPE_TOKEN as a placeholder variable to allow the token to be configured via environment variables in Serverless, AWS CLI, or AWS Console instead of embedding the token string directly.

It's highly recommended you install this plugin globally instead of per-project. If installed locally, your Serverless bundle may be much larger than you'd like. However, if you're sure you want to use a local copy of serverless-plugin-iopipe, use this option to skip the global check.

By default, the plugin sends anonymized, non-identifying usage statistics to Google Analytics. IOpipe will use this info to prioritize updates and enhancements to the plugin. If you'd like to opt out of this, just set this option.

• Why npm link? In order to keep your serverless package size down, it's recommended that you install the package globally. But due to the nature of module resolution, the Serverless Framework needs to reference a project-based copy of the plugin. npm link solves this issue by simply creating a symlink from your project directory to the global node_modules directory.

• This plugin attempts to skip handlers that are already wrapped, but edge cases my arise, especially if you require the iopipe module outside of the handler file.
• If your package.json is located in a non-standard place, auto-upgrading may not work.
• If attempting to use es6 modules natively i.e. export function handler..., may not work.

File an issue here, hit us up on Slack, or send us a note at [email protected]