Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 2.54 KB

README.md

File metadata and controls

80 lines (60 loc) · 2.54 KB
Raw

IOpipe Analytics & Distributed Tracing Agent

Coverage Status npm version

This package provides analytics and distributed tracing for event-driven applications running on AWS Lambda.

Installation & usage

Install by requiring this module, passing it an object with your project token (register for access), and it will automatically monitor and collect metrics from your application running on AWS Lambda.

If you are using the Serverless Framework to deploy your lambdas, check out our serverless plugin.

Example:

var iopipe = require("iopipe")({ token: "YOUR_TOKEN"})

exports.handle = iopipe(
  function (event, context) {
    context.succeed("This is my serverless function!")
  }
)

Environment-based config

This library will look for an environment variable, IOPIPE_TOKEN and will use this if one is not explicitly passed to the configuration object. If a project token is passed to the configuration object, the library will prefer that token over the environment variable.

exports.handle = require("iopipe")()(
  function (event, context, callback) {
    // Do things here. Nothing will be reported.
  }
)

Capturing timeouts

By default, IOpipe will capture timeouts by exiting your function 150ms early from the AWS configured timeout, to allow time for reporting. You can disable this feature by setting timeoutWindow to 0 in your configuration:

var iopipe = require("iopipe")({ token: "YOUR_TOKEN", timeoutWindow: 0})

You can also update the timeout window from IOPIPE_TIMEOUT_WINDOW in your environment variables; IOpipe will prefer the configuration in the code over environment variables if both are configured.

Debugging integration

Debugging is possible by seeing the debug key to true in the configuration as such, which will log all data sent to IOpipe servers to STDOUT. This is also a good way to evaluate the sort of data that IOpipe is receiving from your application.

Debugging is also enabled if the the environment variable, IOPIPE_DEBUG is set to a truthful value.

exports.handle = require("iopipe")({ debug: true })(
  function (event, context, callback) {
    // Do things here. We'll log info to STDOUT.
  }
)

License

Apache 2.0