An open API service indexing awesome lists of open source software.

https://github.com/opennms/backshift

Time series graphing on the client side
https://github.com/opennms/backshift

Last synced: about 1 year ago
JSON representation

Time series graphing on the client side

Awesome Lists containing this project

README

          

# Backshift [![CircleCI](https://circleci.com/gh/OpenNMS/backshift.svg?style=svg)](https://circleci.com/gh/OpenNMS/backshift)

This library was built as an alternative to [rrdgraph](http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html) for use in [OpenNMS](https://github.com/OpenNMS/opennms).

![](https://raw.githubusercontent.com/opennms/backshift/gh-pages/images/jrobin-vs-flot.png)

## Motivation

As our needs grew, we began investigating alternative time series databases.
One of the initial barriers to integrating these within OpenNMS was graphing: we needed a way for our users to visualize the metrics similar to how they were previously shown using *rrdgraph*.
The system already contained a large number of [prefabricated graphs](http://www.opennms.org/wiki/Prefabricated_Standard_Graphs) defined using *rrdgraph* commands and any suitable alternative needed to a way of rendering these.

And thus Backshift was born at [DevJam 2014](http://www.opennms.org/wiki/Dev-Jam_2014).

## Design

Backshift provides the glue between data sources and charting APIs.

Charts and data sources are made accessible via a consistent API, allowing these to be easily interchanged.

The actual rendering of the charts is performed by third party libraries i.e. [c3.js](http://c3js.org/) built to this end.

## Getting Started

### Building

Install the dependencies and build the minified scripts:

```
npm install
npx grunt
```

### Running the examples

Run the development web server:

```
npm start
```

Now browse to the examples at `http://localhost:8000/examples/`.