Metrics collector that push metrics to Elastic Search + Kibana.
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
.gitignore
.travis.yml
README.md
index.js
package.json

README.md

black-pearl Build Status

Metrics collector that push metrics to Elastic Search + Kibana.

Getting started

Install and run server :

npm install -g black-pearl
black-pearl

Push metric from client :

var client = require('black-pearl-client').createClient();
client.push('connectedUsers', { count: 5 });

View metrics in Kibana :

Kibana

Install

npm install -g black-pearl

Usage

CLI

Usage: black-pearl [options]

  Options:

    -h, --help           output usage information
    -V, --version        output the version number
    -p, --port [port]    Http port.
    -e, --eshost [host]  Elastic search host, default 9400.

Node

var Server = require('black-pearl').Server;

var server = new Server({ es: { host: 'elasticsearch1' } });
server.listen(9400);

Push metrics

To push metrics, you must use the black-pearl-client module, it's very easy.

var blackPearl = require('black-pearl-client');
var client = blackPearl.createClient('http://localhost:9400');

client.push('connectedUsers', { count: 5 });

Debug mode

To enter in debug mode and view some logs, you have to set the DEBUG env variable.

DEBUG=true black-pearl

License

MIT