Skip to content

Latest commit

 

History

History
60 lines (31 loc) · 1.7 KB

README.md

File metadata and controls

60 lines (31 loc) · 1.7 KB
Raw

onyx

A dashboard app to visualize Graphite data using Cubism.js and NVD3

Build Dependencies

Install dependencies from npm

$> npm install

Configuration

Onyx comes with an example config.json file in the app directory called config_example.json. This can be used as a starting point for configuring Onyx to display data as desired.

$> cp app/config_example.json app/config.json

Be sure to update the graphite property in config.json with correct hostname that graphite is running on.

Cubism and NVD3 Graphs

There are two different sections in the configuration to define metrics and how they are graphed.

The cubism property is an array of objects that define the metrics and information for a single Cubism page. They all must have the type of cubism.

demo

The graphs property is an array of objects that define the metrics and information for a single NVD3 page. Currently only the following types of NVD3 graphs are available:

  • Simple Line type: lineGraph
  • Line with View Finder type: lineWithFocusGraph
  • Stacked Area type: stackedAreaChart

For each cubism and graph object the name, title, type and metrics properties must be defined.

name: this is used for the route/url

title: this is used for the navigation and header on the page

type: this is used to render the graph as line/lineWithFocus/stackedArea

metrics: is an array of metric objects and their aliases

demo