Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koajs/trace-influxdb
InfluxDB tracing for koa-trace
https://github.com/koajs/trace-influxdb
Last synced: about 1 month ago
JSON representation
InfluxDB tracing for koa-trace
- Host: GitHub
- URL: https://github.com/koajs/trace-influxdb
- Owner: koajs
- License: mit
- Created: 2015-01-06T05:15:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-26T20:58:45.000Z (over 8 years ago)
- Last Synced: 2024-04-14T13:08:40.883Z (5 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 15
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-koa - trace-influxdb - InfluxDB tracing for koa-trace (Middleware)
README
# koa-trace-influxdb
[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![Dependency Status][david-image]][david-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![Gittip][gittip-image]][gittip-url]
Tracing for [koa-trace](https://github.com/koajs/trace) using [influxdb-udp](https://github.com/jonathanong/node-influxdb-udp).
## Usage
```js
var app = koa();
require('koa-trace')(app);
var traceInflux = require('koa-trace-influxdb');
app.instrument(traceInflux({
port: 4444,
host: '127.0.0.1'
}));
app.use(function* (next) {
// set an ID for every request.
// optionally, make this a request UUID
this.id = '1234';
// optionally set properties to add to all traces
this.traces = {
user_id: this.session.user_id.toString('hex')
};
// trace something
this.trace('start')
})
```
This will create a time series called `trace.start`.
Thus, it tracks each event as a separate series.
You probably want to track the elapsed time.
```js
app.use(function* (next) {
var start = Date.now();
yield* next;
this.trace('response-time', {
elapsed: Date.now() - start
});
});
```
You may want to build your own helper for this.
## Options
- `host`
- `port`
- `prefix` - prefix to add to all the series, defaulting to `trace.`.
If you don't want any prefixes, set it as `''`.
## Limitations
- The trace arguments must only be a single object, if anything at all.
- UDP is used underneath, so you may lose events.
There is no error reporting for logging these.
[gitter-image]: https://badges.gitter.im/koajs/trace-influxdb.png
[gitter-url]: https://gitter.im/koajs/trace-influxdb
[npm-image]: https://img.shields.io/npm/v/koa-trace-influxdb.svg?style=flat-square
[npm-url]: https://npmjs.org/package/koa-trace-influxdb
[github-tag]: http://img.shields.io/github/tag/koajs/trace-influxdb.svg?style=flat-square
[github-url]: https://github.com/koajs/trace-influxdb/tags
[travis-image]: https://img.shields.io/travis/koajs/trace-influxdb.svg?style=flat-square
[travis-url]: https://travis-ci.org/koajs/trace-influxdb
[coveralls-image]: https://img.shields.io/coveralls/koajs/trace-influxdb.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/koajs/trace-influxdb
[david-image]: http://img.shields.io/david/koajs/trace-influxdb.svg?style=flat-square
[david-url]: https://david-dm.org/koajs/trace-influxdb
[license-image]: http://img.shields.io/npm/l/koa-trace-influxdb.svg?style=flat-square
[license-url]: LICENSE
[downloads-image]: http://img.shields.io/npm/dm/koa-trace-influxdb.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/koa-trace-influxdb
[gittip-image]: https://img.shields.io/gratipay/jonathanong.svg?style=flat-square
[gittip-url]: https://gratipay.com/jonathanong/