1.1.0 • Published 5 years ago

datadog-statsd-metrics-collector v1.1.0

Weekly downloads
90
License
MIT
Repository
github
Last release
5 years ago

datadog-statsd-metrics-collector

A wrapper for for node-dogstatsd that buffers and rolls up metrics into efficient calls to a Datadog StatsD server.

Install

npm install datadog-statsd-metrics-collector node-dogstatsd

Usage

const StatsD = require('node-dogstatsd').StatsD
const Collector = require('datadog-statsd-metrics-collector');

const dd = new Collector(new StatsD('example.org', 8125));
dd.increment('test.metric', 1, ['tag:first']);

Buffered stats

  • increment
  • incrementBy
  • decrement
  • decrementBy

TODO

  • histagram

API

Aside from the constructor all StatsD calls proxied to node-dogstatsd.

constructor(client, delayMilliseconds)

argtyperequireddefault
clientinstanceof node-dogstatsdyesundefined
delayMillisecondsnumberno10000

increment(metrics, sample_rate, tags)

argtyperequireddefault
metricstringyesundefined
sample_raten/an/an/a
tagsarraystringnoundefined

Note: sample rates are ignored as they serve no purpose when rolling up metrics.

incrementBy(metrics, value, tags)

argtyperequireddefault
metricstringyesundefined
valuenumberno1
tagsarraystringnoundefined

decrement(metrics, sample_rate, tags)

argtyperequireddefault
metricstringyesundefined
sample_raten/an/an/a
tagsarraystringnoundefined

Note: sample rates are ignored as they serve no purpose when rolling up metrics.

decrementBy(metrics, value, tags)

argtyperequireddefault
metricstringyesundefined
valuenumberno1
tagsarraystringnoundefined

timing(metric, time, sample_rate, tags)

argtyperequireddefault
metricstringyesundefined
timenumberyesundefined
sample_ratenumberno1
tagsarraystringnoundefined

gauge(metric, value, sample_rate, tags)

argtyperequireddefault
metricstringyesundefined
valuenumberyesundefined
sample_ratenumberno1
tagsarraystringnoundefined

histogram(metric, value, sample_rate, tags)

argtyperequireddefault
metricstringyesundefined
valuenumberyesundefined
sample_ratenumberno1
tagsarraystringnoundefined

set(metric, value, sample_rate, tags)

argtyperequireddefault
metricstringyesundefined
valuenumberyesundefined
sample_ratenumberno1
tagsarraystringnoundefined