Statful Client for NodeJS

Statful client for NodeJS written in Javascript. This client is intended to gather metrics and send them to Statful.

Table of Contents

• Supported Versions of NodeJS
• Installation
• Quick Start
• Reference
  • Global Configuration
  • Methods
  • Plugins
• Examples
  • UDP Configuration
  • HTTP Configuration
  • Logger Configuration
  • Configuration of Defaults per Method
  • Preset Configuration
  • Send Metrics Configuration
• Authors
• License

Supported Versions of NodeJS

Installation

First, install Statful’s NodeJS Client into your System, in the same path as your JS file, by executing the below command:

$ npm install statful-client --save

Quick Start

After installing Statful’s NodeJS Client, you are ready to push your metric into Statful by adding the below code into your JS file:

var Statful = require('statful-client');
 
// Creates an object with the desired configuration and pass it to the client
var config = {
    app: 'AccountService',
    transport: 'api',
    api: {
        token: 'STATFUL_API_TOKEN'        
    },
    tags: { cluster: 'production' }
};
var statful = new Statful(config);
 
// Send a `counter` metric
statful.counter('transactions', 1);

IMPORTANT:
host / port: Default values are set for host and port, based on whether the 'transport' attribute is set to udp or api. (Refer the below table for the default values). However, it is possible to override the default values, by manually specifying the desired values within the Object (udp or api as applicable)
token: Your token value is available in the 'Api Tokens' page of your Statful account.

[More configurations are available in the Examples section].

Reference

The following section presents a detailed reference of the available options to take full advantage of Statful.

Global Configuration

Below you can find the information on the custom options to set up the configurations parameters.

Methods

// Non-Aggregated Metrics
- statful.counter('myCounter', 1, {agg: ['sum']});
- statful.gauge('myGauge', 10, { tags: { host: 'localhost' } });
- statful.timer('myCounter', 200, {namespace: 'sandbox'});
- statful.put('myCustomMetric', 200, {timestamp: '1471519331'});
 
// Aggregated Metrics
- statful.aggregatedCounter('myCounter', 1, 'avg', 60, { tags: { host: 'localhost' } });
- statful.aggregatedGauge('myGauge', 10, 'avg', 60, { tags: { host: 'localhost' } });
- statful.aggregatedTimer('myCounter', 200, 'avg', 60, {namespace: 'sandbox'});
- statful.aggregatedPut('myCustomMetric', 200, 'avg', 60, {timestamp: '1471519331'});

The methods for non-aggregated metrics receive a metric name and value as arguments and send a counter, a gauge, a timer or a custom metric.

The methods for aggregated metrics receive a metric name and value, an aggregation and an aggregation frequency (the one used beforehand to aggregate the metric) as arguments, and send a counter, a gauge, a timer or a custom metric. Whenever the options parameter is left out, the default values are used instead.

The latter methods are a valuable asset to address the need of ingestion of already aggregated metrics into Statful (for example, aggregated metrics from AWS CloudWatch). For more information about the default values, read the methods options' reference presented next.

IMPORTANT: You can only send aggregated metrics with an api transport type. Otherwise, the metrics are discarded, and they will not be sent.

Plugins

System Stats Plugin

This plugin allows the client to send system-related metrics and to enrich the user's metrics with system tags.

It is possible to use this plugin with the client as follows:

    var SystemStatsPlugin = require('statful-client').systemStatsPlugin;
    var statful = new Statful(config, log);
    statful.use(new SystemStatsPlugin());

System Stats Plugin Configuration

The custom options available to set on config param are detailed below.

Examples

Here you can find some useful usage examples of the Statful’s NodeJS Client. In the following examples, we assume that you have already installed and included the Statful Client in your project with success.

UDP Configuration

Create a simple UDP configuration for the client.

var Statful = require('statful-client');
 
var config = {
    app: 'AccountService',
    transport: 'udp',
    host: 'statful-relay.yourcompany.com',
    tags: { cluster: 'production' }
};
 
var statful = new Statful(config);

HTTP Configuration

Create a simple HTTP API configuration for the client.

var Statful = require('statful-client');
 
var config = {
    app: 'AccountService',
    transport: 'api',
    api: {
        token: 'STATFUL_API_TOKEN'
    },
    tags: { cluster: 'production' }
};
 
var statful = new Statful(config);

Logger configuration

Create a simple client configuration to add your favorite logger to the client such as Bunyan, Winston or others. The only requirement is to make sure that the chosen logger object supports: log, info, warn, debug and error methods.

var Statful = require('statful-client');
var logger = require('your-favourite-logging-lib');
 
var config = {
    app: 'AccountService',
    transport: 'api',
    api: {
        token: 'STATFUL_API_TOKEN'
    },
    tags: { cluster: 'production' }
};
 
var statful = new Statful(config, logger);

Configuration of Defaults per Method

Create a configuration for the client where you define custom default options per method.

var Statful = require('statful-client');
 
var config = {
    default: {
        counter: { agg: ['avg'], aggFreq: 180 },
        gauge: { agg: ['first'], aggFreq: 180 },
        timer: { tags: { cluster: 'qa' }, agg: ['count'], aggFreq: 180 }
    },
    tags: { cluster: 'production' },
    api: {
        token: 'STATFUL_API_TOKEN'
    },
    transport: 'api'
}
 
var statful = new Statful(config);

Preset Configuration

Create a configuration where you define a value for currently available options.

var Statful = require('statful-client');
 
var config = {
    default: {
        timer: { tags: { cluster: 'qa' }, agg: ['count'], aggFreq: 180 }
    },
    dryRun: true,
    flushInterval: 5000,
    flushSize: 50,
    transport: 'api',
    api: {
        timeout: 300,
        token: 'STATFUL_API_TOKEN'
    },
    namespace: 'application',
    tags: { cluster: 'production' }
}
 
var statful = new Statful(config);

Send Metrics Configuration

Create a simple client configuration to send a few metrics.

var Statful = require('statful-client');
 
var config = {
    app: 'AccountService',
    transport: 'udp',
    host: 'statful-relay.yourcompany.com',
    tags: { cluster: 'production' }
};
 
var statful = new Statful(config);
 
// Send three different metrics (gauge, timer and counter)
statful.gauge('testGauge', 10);
statful.timer('testTimer', 100);
statful.counter('testCounter', 1, { agg: ['first'], aggFreq: 60, namespace: 'sandbox' });
 
// Send a metric with custom tags
statful.counter('testCounter', 1, {tags: {host: 'localhost', status: 'SUCCESS'}});

Authors

Mindera - Software Craft

License

Statful NodeJS Client is available under the MIT license. See the LICENSE file for more information.