Serverless-offline: AWS X-Ray in offline mode

Created on 8 Nov 2017 · 6Comments · Source: dherault/serverless-offline

How to deal with such service? I have set up it in my func but when I run the func locally, I get:

Missing AWS Lambda trace data for X-Ray. Expected _X_AMZN_TRACE_ID to be set.

Any proposal?

Source

mazzy89

👍30

Most helpful comment

@dherault Can we reopen this? Just setting AWS_XRAY_CONTEXT_MISSING=LOG_ERROR results in a ton of extra logging, and there is no obvious way to suppress that without collateral damage.

The best workarounds I've found are verbose and intrusive:

let AWS
if (process.env._X_AMZN_TRACE_ID) {
  AWS = require("aws-xray-sdk").captureAWS(require("aws-sdk"))
} else {
  console.log("Serverless Offline detected; skipping AWS X-Ray setup")
  AWS = require("aws-sdk")
}

const sequelize = new Sequelize(database, username, password, {
  // ...
  dialectModulePath: !!process.env.AWS_XRAY_DAEMON_ADDRESS ? "sequelize-aws-x-ray-mysql2" : "mysql2",
  // ...
})

jelder on 18 May 2018

👍19

All 6 comments

Seconded. Right now I'm just doing a check on an environment variable (process.env.DEBUG). When I invoke the function using DEBUG=true sls invoke local -f activateTrigger --path trigger.json I don't require the aws-xray-sdk but just require regular aws-sdk.

Would be down for a more elegant solution though.

shahzeb1 on 15 Nov 2017

If you set this environment variable, X-Ray logs the error and the function keeps running.
AWS_XRAY_CONTEXT_MISSING=LOG_ERROR
If you have a logger configured, X-Ray uses that format, otherwise just console output.
Reference: http://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-configuration.html

staceymoore on 22 Dec 2017

@dherault Can we reopen this? Just setting AWS_XRAY_CONTEXT_MISSING=LOG_ERROR results in a ton of extra logging, and there is no obvious way to suppress that without collateral damage.

The best workarounds I've found are verbose and intrusive:

let AWS
if (process.env._X_AMZN_TRACE_ID) {
  AWS = require("aws-xray-sdk").captureAWS(require("aws-sdk"))
} else {
  console.log("Serverless Offline detected; skipping AWS X-Ray setup")
  AWS = require("aws-sdk")
}

const sequelize = new Sequelize(database, username, password, {
  // ...
  dialectModulePath: !!process.env.AWS_XRAY_DAEMON_ADDRESS ? "sequelize-aws-x-ray-mysql2" : "mysql2",
  // ...
})

jelder on 18 May 2018

👍19

Another potential workaround here, if you're not concerned with the extra logging, is to define the AWS_XRAY_CONTEXT_MISSING environment variable in your serverless.yml.

Thanks to @aburdiak for the answer.