This repository was archived by the owner on Dec 2, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 413
API Reference
mbostock edited this page Apr 16, 2012
·
16 revisions
Wiki ▸ API Reference
The Collector is a server that runs (by default) on port 1080.
- /1.0/event/put - post events.
- /collectd - receive events from collectd.
- configuration - various parameters to control the Collector.
The Evaluator is a server that runs (by default) on port 1081.
- /1.0/event/get - query events.
- /1.0/metric/get - query metrics.
- /1.0/types/get - query known event types.
- configuration - various parameters to control the Evaluator.
Cube stores events in MongoDB. You can access that data directly, if you like.
- events - a collection for storing events.
- metrics - a (typically capped) collection for caching computed metrics.
Cube provides a JavaScript WebSockets client for posting events to a collector.
- cube.emitter - construct a new emitter.
- emitter.open - connect to the Collector at the specified host and port.
- emitter.send - send a single event.
- emitter.close - close the connection, once all events have been sent.