Skip to content

jeromemacias/fastify-xray

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

fastify-xray

npm version Build Status

Requirements

  • AWS X-Ray SDK Core (aws-xray-sdk-core)
  • Fastify 3.0.0 or greater

AWS X-Ray and Fastify

The AWS X-Ray Fastify package automatically records information for incoming and outgoing requests and responses, via the 'enable' function in this package. To configure sampling, dynamic naming, and more see the set up section.

The AWS X-Ray SDK Core has two modes - manual and automatic. Automatic mode uses the cls-hooked package and automatically tracks the current segment and subsegment. This is the default mode. Manual mode requires that you pass around the segment reference.

In automatic mode, you can get the current segment or subsegment at any time:

const segment = AWSXRay.getSegment();

In manual mode, you can get the base segment off of the request object:

const segment = request.segment;

This plugin should be register as soon as possible after Fastify initialisation.

Plugin usage

Automatic mode examples

For more automatic mode examples, see the example code.

const fastify = require("fastify")();

fastify.register(require("fastify-xray"), {
  defaultName: "My App Name",
});

// Error capturing is attached to the fastify onError hook

Manual mode examples

For more manual mode examples, see manual mode examples. The X-Ray SDK can be used identically inside Restify routes. Note that you don't have to manually start or close the segments since that is handled by the X-Ray middleware.

const fastify = require("fastify")();

fastify.register(require("fastify-xray"), {
  defaultName: "My App Name",
});

//...

fastify.get("/", async function (request, reply) {
  const segment = request.segment;

  //...

  return "hello";
});

// Error capturing is attached to the fastify onError hook

Give your own AWSXRay instance

In case you need to use your own, already configured, AWSRay instance, here is two possibilities.

By passing the AWSXRay instance as plugin option:

const AWSXRay = require('aws-xray-sdk-core')
const fastify = require("fastify")();

// ... configure your AWSXRay instance

fastify.register(require("fastify-xray"), {
  defaultName: "My App Name",
  AWSXRay
});

By decorating the Fastify instance with the AWSXRay instance:

const AWSXRay = require('aws-xray-sdk-core')
const fastify = require("fastify")();

// ... configure your AWSXRay instance

fastify.decorate('AWSXRay', AWSXRay)

fastify.register(require("fastify-xray"), {
  defaultName: "My App Name",
});

License

MIT License