@perform/async-datadog-metrics
Records metrics with Datadog, supports asynchronous (via Datadog's Lambda integration) mode.
Last updated a year ago by automation-drone .
Original npm · Tarball · package.json
$ cnpm install @perform/async-datadog-metrics 
SYNC missed versions from official npm registry.

DAZN Datadog Metrics

Helper module for recording metrics with Datadog. It supports only asynchronous (via Datadog's Lambda integration) mode.

Main features:

  • Supports gauge, histogram and increment

  • Supports tracking of a function's execution time (see below for more details)

  • Support namespacing. You can specify prefix for all metrics with the DATADOG_PREFIX environment variable

  • Support default tags. You can specify default tags for all metrics with the DATADOG_TAGS environment variable, which should be a comma-separated value, e.g. environment:dev,awsRegion:us-east-1,load_test

Configuration options (environment variables):

  • DATADOG_PREFIX: string (optional), used to provide namespacing, e.g. giftcodes.

  • DATADOG_TAGS: string (optional), default tags in comma-separate format, e.g. environment:dev,awsRegion:us-east-1,load_test

Getting Started

Install from NPM: npm install @perform/async-datadog-metrics

API

Basic usage looks like this:

const Datadog = require('@perform/async-datadog-metrics')

Datadog.gauge('key', 42)                        // guage without tags
Datadog.gauge('key', 42, [ 'tag1', 'tag2:42' ]) // gauge with tags
Datadog.gauge('key', 42, [], Date.now())        // guage with timestamp override

Datadog.increment('key')                            // increment by 1, no tags
Datadog.increment('key', 42)                        // increment by 42, no tags
Datadog.increment('key', 42, [ 'tag1', 'tag2:42' ]) // increment by 42, with tags
Datadog.increment('key', 42, [], Date.now())        // increment with timestamp override

Datadog.histogram('key', 42)                        // histogram without tags
Datadog.histogram('key', 42, [ 'tag1', 'tag2:42' ]) // histogram with tags
Datadog.histogram('key', 42, [], Date.now())        // histogram with timestamp override

const f = () => {
  // ...
}

Datadog.trackExecTime(f, 'key')                        // track execution time without tags
Datadog.trackExecTime(f, 'key', [ 'tag1', 'tag2:42' ]) // track execution time with tags
// by default, timestamp of the metric is the time when the function finishes, but you can
// override the timestamp yourself
Datadog.trackExecTime(f, 'key', [], Date.now())

const asyncF = async () => {
  // ...
}

// track async function execution time without tags
Datadog.trackExecTime(asyncF, 'key')

// track async function execution time with tags
Datadog.trackExecTime(asyncF, 'key', [ 'tag1', 'tag2:42' ])

// track async function execution time with timestamp override
Datadog.trackExecTime(asyncF, 'key', [], Date.now())

Disabling console output

Sometimes you won't want the console output to be displayed (e.g. when running your unit tests) when running in async mode. In order to do this, you can set the environment variable DISABLE_METRICS=true; this will disable console logging output. Note: Only set this for scenarios you don't want metrics to be recorded, as setting this will stop any metrics from being recorded.

For example, your scripts section in package.json may look like this:

  "scripts": {
    "unit:test": "DISABLE_METRICS=true jest",
    ...
  }

Current Tags

  • 1.0.1                                ...           latest (a year ago)

2 Versions

  • 1.0.1                                ...           a year ago
  • 1.0.0 [deprecated]           ...           a year ago
Maintainers (344)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |