opentsdb-tquery v0.0.2

TSUID Query

OpenTSDB TSUID query factory.

OpenTSDB permits two query types: metric and tsuid.

Metric queries are general queries which return an indeterministic number of timeseries. OpenTSDB implements metric queries by searching for timeseries matching the metric criteria, e.g., metric name and tag.

TSUID queries request a specific timeseries having a unique id. Every timeseries has an assigned unique identifier, which is based on metric name and any tags.

This module provides a TSUID query generator.

Install

For use in Node.js,

$ npm install opentsdb-tquery

For use in the browser, use browserify.

Usage

To use the module,

var createQuery = require( 'opentsdb-tquery' );

To create a new TSUID query,

var tQuery = createQuery();

A TSUID query is configurable and has the following methods...

tQuery.aggregator( aggregator )

This method is a setter/getter. If no aggregator is provided, returns the query aggregator. The default aggregator is avg. To set a different aggregator,

tQuery.aggregator( 'min' );

tQuery.downsample( downsample )

This method is a setter/getter. If no downsample function is provided, returns the configured downsample function. By default, downsampling is turned off (i.e., set to null). To specify a downsample function,

tQuery.downsample( '5s-avg' );

tQuery.rate( bool )

This method is a setter/getter. If no boolean flag is provided, returns the flag indicating whether to return the difference between consecutive data values. By default, the flag is false. To turn on difference calculation,

tQuery.rate( true );

Note that rate calculation requires a set of three options.

tQuery.rateOptions( object )

This method is a setter/getter. If no configuration object is provided, returns the rate options: counter, counterMax, resetValue. counter must be a boolean; counterMax must be numeric or null; and resetValue must be numeric.

By default,

var rateOptions = {
	"counter": false,
	"counterMax": null,
	"resetValue": 0
};

tQuery.tsuids( tsuids )

This method is a setter/getter. If no tsuids are provided, return the query tsuids. tsuids are required to encode a tsuid query. To set tsuids,

// Comma-delimited string:
tQuery.tsuids( '001,002,003' );

// Array:
tQuery.tsuids( ['001','002','003'] );

Examples

var createQuery = require( 'opentsdb-tquery' );

var tQuery = createQuery();

tQuery
	.aggregator( 'sum' )
	.downsample( '5m-avg' )
	.rate( false )
	.tsuids( '001,002,003' );

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2014. Athan Reines.