# knex-aws-xray

> AWS X-Ray adapter for knex

Latest version **0.0.3** (published 2018-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install knex-aws-xray
pnpm add knex-aws-xray
yarn add knex-aws-xray
bun add knex-aws-xray
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2018-03-30 |
| First published | 2017-09-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Marian Zange |
| Maintainers | mzange |
| Keywords | amazon, api, aws, mysql, xray, x-ray, x ray, knex |

## Links

- npm: https://www.npmjs.com/package/knex-aws-xray
- Repository: https://github.com/marianzange/knex-aws-xray
- Homepage: https://github.com/marianzange/knex-aws-xray#readme
- Issues: http://github.com/marianzange/knex-aws-xray/issues
- npm.io page: https://npm.io/package/knex-aws-xray

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2018-03-30
- 0.0.2 — 2017-09-11

## README

# AWS X-Ray for Knex

Unfortunately the official AWS mysql adapter is not working properly when used together with Knex.
So this project aims to allow capturing MySQL queries when using Knex in a reliable way.

Please note that this module is work in progress and currently considered a prototype.

## Installation

To install, simply run

```bash
npm install knex-aws-xray
```

## Usage

This module extends the official `AWSXRay` SDK with a `captureKnex` call. Use it like in the example below.

```js
const AWSXRay = require('aws-xray-sdk');
require('knex-aws-xray')(AWSXRay)
const knex = AWSXRay.captureKnex(require('knex')(config));
```

---
_Source: https://npm.io/package/knex-aws-xray · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._