npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@fredstrange/aws-xray-sdk-restify

v1.0.7

Published

Enables AWS X-Ray for Restify (Javascript)

Downloads

5

Readme

Requirements

AWS X-Ray SDK Core (aws-xray-sdk-core) Restify 4.3.0 or greater

AWS X-Ray and Restify

The AWS X-Ray Restify package automatically records information for incoming and outgoing requests and responses, via the 'enable' function in this package.

The AWS X-Ray SDK Core has two modes - manual and automatic. Automatic mode uses the Continuation Local Storage package (CLS) 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: var segment = AWSXRay.getSegment();

In manual mode, you can get the base segment off of the request object: var segment = req.segment;

//If the restify context plugin is being used, it is placed under 'XRaySegment'
var segment = req.get('XRaySegment');

Sampling rates on routes

Sampling rates are determined by the AWS X-Ray SDK Core package, using the default sampling file that is provided, or by overriding this with a custom sampling file. For more information about sampling, see the aws-xray-sdk-core README.

Dynamic and fixed naming modes

The SDK requires that a default segment name is set. If it isn't set, an error is thrown. You can override this value via the AWS_XRAY_TRACING_NAME environment variable.

AWSXRayRestify.enable(server, 'defaultName');

The AWS X-Ray SDK Core defaults to a fixed naming mode. This means that each time the handler creates a new segment for an incoming request, the name of that segment is set to the default name. In dynamic mode, the segment name can vary between the host header of the request or the default name. For more information about naming modes, see the aws-xray-sdk-core README.

Automatic mode examples

var AWSXRayRestify = require('aws-xray-sdk-restify');
var restify = require('restify');
var server = restify.createServer();

//...

AWSXRayRestify.enable(server, 'defaultName');

server.get('/', function (req, res) {
  var segment = AWSXRay.getSegment();

  //...

  res.send('hello');
});

//Error capturing is attached to the server's uncaughtException and after events (for both handled and unhandled errors)

Manual mode examples

var AWSXRayRestify = require('aws-xray-sdk-restify');
var restify = require('restify');
var server = restify.createServer();

//...

AWSXRayRestify.enable(server, 'defaultName');          //Required at the start of your routes

server.get('/', function (req, res) {
  var segment = req.segment;

  //...

  res.send('hello');
});

//Error capturing is attached to the server's uncaughtException and after events (for both handled and unhandled errors)