open-index/open-npm huggingface dataset:
npm package: @fredstrange/aws-xray-sdk-mysql
Description: AWS X-Ray Patcher for MySQL (Javascript)
Author: Amazon Web Services
Latest version: 1.2.4


## Requirements

  AWS X-Ray SDK Core
  MySQL 2.12.0 or greater

## AWS X-Ray and MySQL

The AWS X-Ray MySQL package automatically records query information and request and
response data. Simply patch the MySQL package via `captureMySQL` as shown below.

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. See the examples below.

### Environment variables

    MYSQL_DATABASE_VERSION           Sets additional data for the sql subsegment.
    MYSQL_DRIVER_VERSION             Sets additional data for the sql subsegment.

## Automatic mode example

    var AWSXRay = require('@fredstrange/aws-xray-sdk-core');
    var captureMySQL = require('aws-xray-sdk-mysql');

    var mysql = captureMySQL(require('mysql'));

    var config = { ... };

    ...

    var connection = mysql.createConnection(config);

    connection.query('SELECT * FROM cats', function(err, rows) {
      //Automatically captures query information and errors (if any)
    });

    ...

    var pool = mysql.createPool(config);

    pool.query('SELECT * FROM cats', function(err, rows, fields) {
      //Automatically captures query information and errors (if any)
    }

## Manual mode example

    var AWSXRay = require('@fredstrange/aws-xray-sdk-core');
    var captureMySQL = require('aws-xray-sdk-mysql');

    var mysql = captureMySQL(require('mysql'));

    var config = { ... };

    ...

    var connection = mysql.createConnection(config);

    connection.query('SELECT * FROM cats', function(err, rows) {
      //Automatically captures query information and errors (if any)
    });

    ...

    var pool = mysql.createPool(config);

    pool.query('SELECT * FROM cats', function(err, rows, fields) {
      //Automatically captures query information and errors (if any)
    }, segment);
npm package: @fredstrange/aws-xray-sdk-postgres
Description: AWS X-Ray Patcher for Postgres (Javascript)
Author: Amazon Web Services
Latest version: 1.2.4


## Requirements

  AWS X-Ray SDK Core
  Postgres 6.1.0 or greater

## AWS X-Ray and Postgres

The AWS X-Ray Postgres package automatically records query information and request
and response data. Simply patch the Postgres package via `capturePostgres` as shown below.

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. See the examples below.

### Environment variables

    POSTGRES_DATABASE_VERSION        Sets additional data for the sql subsegment.
    POSTGRES_DRIVER_VERSION          Sets additional data for the sql subsegment.

### Automatic mode example

    var AWSXRay = require('@fredstrange/aws-xray-sdk-core');
    var capturePostgres = require('aws-xray-sdk-postgres');

    var pg = capturePostgres(require('pg'));

    ...

    var client = new pg.Client();

    client.connect(function (err) {
      ...

      client.query({name: 'moop', text: 'SELECT $1::text as name'}, ['brianc'], function (err, result) {
        //Automatically captures query information and errors (if any)
      });
    });

    ...

    var pool = new pg.Pool(config);
    pool.connect(function(err, client, done) {
      if(err) {
        return console.error('error fetching client from pool', err);
      }
      var query = client.query('SELECT * FROM mytable', function(err, result) {
        //Automatically captures query information and errors (if any)
      });
    });

### Manual mode example

    var AWSXRay = require('@fredstrange/aws-xray-sdk-core');
    var capturePostgres = require('aws-xray-sdk-postgres');

    var pg = capturePostgres(require('pg'));

    ...

    var client = new pg.Client();

    client.connect(function (err) {
      ...

      client.query({name: 'moop', text: 'SELECT $1::text as name'}, ['mcmuls'], function (err, result) {
        //Automatically captures query information and errors (if any)
      });
    });

    ...

    var pool = new pg.Pool(config);
    pool.connect(function(err, client, done) {
      if(err) {
        return console.error('error fetching client from pool', err);
      }
      var query = client.query('SELECT * FROM mytable', function(err, result) {
        //Automatically captures query information and errors (if any)
      }, segment));
    };
npm package: @fredstrange/aws-xray-sdk-restify
Description: Enables AWS X-Ray for Restify (Javascript)
Author: Amazon Web Services
Latest version: 1.0.7


## 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](https://github.com/aws/aws-xray-sdk-node/tree/master/packages/core/README.md).

## 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](https://github.com/aws/aws-xray-sdk-node/tree/master/packages/core/README.md).

## 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)