binora / iopipe

NodeJS agent for AWS Lambda tracing & analytics

IOpipe Analytics & Distributed Tracing Agent

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

Installation & usage

Installation is simple. Just require this module with your client id (register for access) and it will automatically monitor and collect metrics from your application running on AWS Lambda.

Example:

var iopipe = require("iopipe")({ clientId: "YOUR_ID"})

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

Testing & non-production use

By not specifying the clientId in the configuration object, or by setting it to a false value (such as undefined), data will not be sent to the IOpipe service. This is a good way to integrate and test this library without making remote calls.

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

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

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

Data reported

The following is provided to IOpipe:

• function_id (a hashed identifier of the function)
• client_id (your client id, common among all your functions)
• errors
• events (custom events sent via .emit('event', [data])
• time_sec_nanosec (execution time: [secs, nanosecs])
• time_sec (execution time: secs)
• time_nanosec (execution time: nanosecs)

License

Apache 2.0