aardvark

An OpenTSDB Visualiser

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
750May 4, 2021Jul 15, 2014Minified + gzip package size for aardvark in KB

Readme

NPM version NPM downloads GPL License Build Status Coverage

aardvark

An OpenTSDB Visualiser.

A brief list of features:

  • Javascript client-side rendered charts:
    • Line charts
    • Ratio charts
    • Mean weighted charts
    • Horizon charts
    • Scatter charts
  • Auto scaling
  • Stacked charts
  • Filtering by value or top/bottom timeseries
  • Deep linking
  • Tree based metric selection
  • Baselining - compare a time series to an earlier version of itself
  • View annotations

Intended additional features:

  • Auto-downsampling of series to prevent browser 'lock-up'
  • Filter UI by tag key/value and or time range
  • Popout to Gnuplot image
  • Add/edit annotations
  • Metadata viewer

Getting started

  • Install node
  • Run some commands:
     $ git clone https://github.com/eswdd/aardvark.git
     $ cd aardvark
     $ npm install
     $ node aardvark.js -s -d
    
  • Point browser at http://localhost:8000/.

Why the name?

It was originally called Otis (from OpenTSDB Visualiser). Anyone growing up in the UK in the 90's should be well aware of Otis the Aardvark.

Release process

Ensure all issues are labelled with the correct version in GitHub and closed.

   npm version <major|minor|patch>
   npm publish
   git push
   git push --tags

Create a release note and label for the next version.

Copyright

   Copyright 2014-2016 Simon Matic Langford

   Licensed under the GNU General Public License, Version 3.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.gnu.org/licenses/gpl-3.0.txt

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.