cnn-metrics

CNN Metrics

Requirements

A current LTS or Stable version of Node.js. We recommend using nvm to manage node versions.

Installation

$ npm install

Usage

See the example/ directory. You can start up the example app with the following. Supply your own Hosted Graphite key or DataDog keys.

$ NODE_ENV=production ENABLE_MTERICS=true HOSTEDGRAPHITE_APIKEY=[valid-key] DEBUG=* DEBUGMETRICS=1 PORT=5000 node example/app.js

Environment variables

This package requires a few environment variable to be set.

• NODE_ENV

• ENVIRONMENT

• METRICS_ENABLED

• HOSTEDGRAPHITE_APIKEY -or- DATADOG_APIKEY and DATADOG_APPKEY

• NODE_APP_INSTANCE

• METRICS_INTERVAL

• DEBUGMETRICS

Changelog

2017-04-14, Version 0.5.0, @drenter

Notable changes

• Add DataDog support (mostly copied from the update-for-docker branch)
• Add support for DATADOG_APIKEY and DATADOG_APPKEY for above
• Add support for new METRICS_ENABLED environment variable, to explicitly control enabling and disabling metrics
• Add support for new METRICS_INTERVAL and METRICS_FLUSH_FREQ enviroment variables, either can be used to control the flush interval.
• Fixed a memory leak
• Update dependencies
• NOTE: The required parameters for configuration have slightly changed. Where before only an app property was required, now both appName and appType should be used, where appType is something like "api" or "fe". Note that a corresponding APPTYPE environment variable is also supported.

Known issues

See https://github.com/TurnerBroadcasting/cnn-metrics/labels/defect for complete and current list of known issues.

Commits

• [8f83411855] - Merge pull request #16 from cnnlabs/dogs-in-boxes (DrEnter)
• [ad3fd729da] - Update README with new env variables. (James Drenter)
• [13eeb80d3c] - Fix memory leak with using Histograms. Only output debugging output if it is asked for. Clean-up several things. (James Drenter)