Node-simpletsdb NPM

node-simpletsdb

Installation

npm install node-simpletsdb

API

Object: `SimpleTSDB`

Parameters: `options`

options has the following properties:

Field	Type	Description
`host`	`string`	The host used to connect to SimpleTSDB
`port`	`number`	The port used to connect to SimpleTSDB
`insertBufferSize`	`number`	optional: The buffer size used by insertPoints. Defaults to 65536.

Example:

const { SimpleTSDB } = require('node-simpletsdb');

const db = new SimpleTSDB({
  host: '127.0.0.1',
  port: 8981,
});

Object: `Point`

Parameters: `options`

options has the following properties:

Field	Type	Description
`metric`	`string`	The metric name of the point
`value`	`number`	The value of the point
`timestamp`	`number`	The timestamp of the point
`tags`	`array`	optional: The tags associated with the inserted point

Example:

const { Point } = require('node-simpletsdb');

const pt = new Point({
  metric: 'test0',
  value: 99,
  timestamp: Date.now() * 1000000, // SimpleTSDB uses nanoseconds
  tags: {
    'id': '2',
  }
});

Function: `insertPoint`

Parameters: `point`

Example:

db.insertPoint(new Point({
  metric: 'test0',
  value: 99,
  tags: {
    'id': '2',
  },
  timestamp: Date.now() * 1000000, // SimpleTSDB uses nanoseconds
}))
  .then(() => console.log('successfully inserted point'))
  .catch(err => console.error(err));

Function: `insertPoints`

Parameters: `points`

The same as insertPoint but takes an array of points.

Function: `queryPoints`

Parameters: `query`

query has the following properties:

Field	Type	Description
`metric`	`string`	The metric to query.
`start`	`number`	The timestamp in nanoseconds for the start of the query.
`end`	`number`	optional: The timestamp in nanoseconds for the end of the query.
`n`	`number`	optional: The max number of points to return.
`tags`	`object`	optional: Key/value pairs to add criteria to the query.
`window`	`object`	optional: Windowing options. See Windowing / Gap filling
`aggregators`	`array`	optional: An array of aggregators. See aggregators

Example:

db.queryPoints({
  metric: 'test0',
  start: (Date.now() - 360000) * 1000000, // SimpleTSDB uses nanoseconds
  window: {
    every: '1m',
  }
})
  .then(points => console.log(points))
  .catch(err => console.error(err));

Function: `deletePoints`

Parameters: `options`

options has the following properties:

Field	Type	Description
`metric`	`string`	The metric to query.
`start`	`number`	The timestamp in nanoseconds for the start of the query.
`end`	`number`	The timestamp in nanoseconds for the end of the query.
`tags`	`object`	optional: Key/value pairs to add criteria to the query.

Example:

db.deletePoints({
  metric: 'test0',
  start: (Date.now() - 36000) * 1000000, // SimpleTSDB uses nanoseconds
  end: Date.now() * 1000000
})
  .then(() => console.log('successfully deleted points'))
  .catch(err => console.error(err));