write-events-to-log v0.1.18

StatsD backend for Dumping Events data to File System

Overview

StatsD is a smart Node.js package that collects and aggregates statistics from differents apps sent over the UDP protocol. At a set time interval it forwards the aggregated data to a configured backend. It is pluggable with several backends available, the most popular being Graphite, a python/django monitoring tool.

With write-events-to-log you can dump data to the local file sytem for the Events API designed internally.

Counters, timers, gauges and sets are all supported.

LOcal code stored in https://gitlab.devtools.intel.com/sports/tee-control/write-events-to-log

Installation

You need node.js installed on your system aswell as StatsD. Follow the instructions on their sites or see this blog post/tutorial on how to install these components on a Windows system.

The CloudWatch backend is an npm package that can be installed with the npm command which comes with your installation of node.js. Go to the npm site for more information.

npm install write-events-to-log

The package has two depdencies that should be installed automatically, fs.

Configuration

The StatsD and its backends are configured in a json object placed in a file supplied to StatsD at the command line. For example, start StatsD with the following.

node ./stats.js ./myConfig.js

The following demonstrates the minimum config for the CloudWatch backend.

{
    backends: [ "write-events-to-log" ],
    writeevents: 
    {
        fileDir: /tmp/writeEvents,
        watchKeys: ["AggregatedMetrics."]   
    }
}

The metric name, unit and value depends on what you send StatsD with your UDP request. For example, given

gorets:1|c

the Unit will be Counter, the metric name gorets. The value will be the aggregated count as calculated by StatsD.

ms corresponds the unit Milliseconds. s and g to None*.

Additional configuration options

Whitelisting Metrics

Using AWS Roles to obtain credentials

Multi-region support

Tutorial