Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Voyeur.io collection agents
JavaScript
tree: 49592e2bbd

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
Makefile
README.md
index.js
package.json

README.md

Voyeur.io Collector

The collector is the engine room of Voyeur. A number of different collection agents are implemented, and more are on their way.

Usage

Using the voyeur.io collector in a project is very simple. First install the npm package:

npm install voyeur

Then, in your application code doing something similar to the following:

var voyeur = require('voyeur'),
    collector = voyeur.collectToDB();

// other stuff goes here

// on exit, stop collecting (this closes the db nicely)
process.on('exit', function() {
    collector.stop();
});

No in the above configuration, the collector will happily run up the default agents and save the data to a leveldb database in the samples directory. Presumably, however, you also want to get the data out and report on it somehow.

The simplest way to do this is through using the Connect middleware that is included in the voyeur package:

To be completed

Advanced Usage

To be completed

Something went wrong with that request. Please try again.