Skip to content
A StatsD backend that sends metrics to Ducksboard
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
docs
src
LICENSE
README.md
ducksboard.js
metrics.yaml
package.json

README.md

statsd-ducksboard-backend

Overview

This is a pluggable backend for [StatsD][statsd], which push metrics to Ducksboard.

ATTENTION: THIS IS A PROVISIONAL DOCUMENTS AND AN ALPHA VERSION

Requirements

  • [StatsD][statsd] versions >= 0.5.0.
  • [visionmedia][js-yaml] version >= 0.2.3
  • An active Ducksboards account.

Installation

$ cd /path/to/statsd
$ npm install statsd-ducksboard-backend

Enabling

Add the statsd-ducksboard-backend backend to the list of StatsD backends in the StatsD configuration file:

{
  backends: ["statsd-ducksboard-backend"]
}

Configuration

You must include 'statsd-ducksboard-backend' in the array backeds from your StatsD config file to enable it.

{
  ducksboard: {
    apikey: '<APIKEY from ducksboards.com>',
    cache: '/tmp/',
    definitions: './metrics.yaml'
  }
}

Start/restart the statsd daemon and your StatsD metrics should now be pushed to your Librato Metrics account.

Widget definitions

Quick and dirty metrics.yaml example:

---
metrics:
    gearman.ymailer.iunaites.done:
        allowZero: true
        reset: day
    gearman.ymailer.iunaites.fail:
        reset: hour
widgets:
    #Counter
    101826:
        format: number
        metric: 
            name: gearman.ymailer.iunaites.done
    #Graphs
    101893:
        format: number
        metric: 
            name: gearman.ymailer.iunaites.done
            type: last
            timestamp: true
    #Gauge
    101838:
        format: gauge
        dividend: 
            name: gearman.ymailer.iunaites.fail
        divisor: 
            value: 100
    #Status Leaderboard
    100539:
        format: leaderboard.status
        limit: 5|50
        metrics: 
            - name: gearman.ymailer.iunaites.exception
            - name: gearman.ymailer.iunaites.done
              label: ejemplo
              limit: 1|1000000
            - name: gearman.ymailer.iunaites.warning
            - name: gearman.ymailer.iunaites.fail
    #Status Leaderboard using a regexp
    101998:
        format: leaderboard.status
        limit: 5|100
        type: sum
        regexp: !!js/regexp /gearman\.ymailer\.iunaites\.(.*)/i
    #Tends Leaderboard using a regexp
    102001:
        format: leaderboard.trend
        regexp: !!js/regexp /gearman\.ymailer\.iunaites\.(.*)/i
...
Something went wrong with that request. Please try again.