Skip to content

Latest commit

 

History

History
129 lines (96 loc) · 6.55 KB

README.md

File metadata and controls

129 lines (96 loc) · 6.55 KB
Raw

Notes from Echo

Echo augmented Graphiti by adding the following features:

  • one can now see a dashboard's graphs in the list or columns format
  • added possibility to specify time interval for all graphs on a page
  • graphs on a dashboards page can now be groupped into sections
  • a graph can now specify which graphite host has its data by specifying "graphite_host" option what makes it possible to show graphs from several graphite hosts on a single dashboard page

Graphiti

Graphiti is an alternate JavaScript and Ruby front-end and graph storage application for the Graphite Real-time graphing engine.

Graphiti

What

Graphiti allows you to easily access and manipulate the data you've collected in graphite in a couple of key ways. The focus is on ease of access, ease of recovery and ease of tweaking/manipulation:

  • Graphs - the basic building blocks of graphiti. Graphs are stored as JSON blobs in Redis. They are created/edited through an editor pane where you live edit the JSON and see a reference of your collected metrics and the display options available. Each graph is given a UUID and can be updated or cloned.
  • Dashboards - graphs are grouped into arbitrary dashboards which are just named collections with a URL slug for easy reference and retreival. We use dashboards to name personal lists (like "aq"/"mrb") or lists of related information ("key metrics"/"resque"/"rails").
  • Auth-less - No authentication is considered a feature of Graphiti. It's behind your VPN, your trusted engineers have access to it, and it's easy enough to recreate graphs (and make redis backups, for that matter), that we don't see the point of logins.

Background

This application is meant to replace the web application that ships with Graphite. While it's great for getting introduced to the wonders of Graphite graphs, it left a lot to be desired for us, both in terms of style and functionality.

We started talking to some smart people that were using Graphite in their own ways, and realized that the underlying API for graph access is pretty great. We started dreaming big for ways to generate graph links, came up with something useful right away, and hammered at it a bit. Aman (@tmm1) shared some Graph generation code they we're using at Github and we built an interface and toolset around it. We think Graphiti can be improved, so we wanted to open source it.

Reference/Bibliography

Technology

Graphiti is a very simple ruby 1.9.2/Sinatra (http://sinatrarb.com) backend that stores the Graph + Dashboard data in Redis. On top of this REST backend is a Sammy.js (http://sammyjs.org) application that handles the graph generation and manipulation. It also uses an embedded version of the Ace (http://ace.ajax.org/) for the editor interface. It uses Jim (http://github.com/quirkey/jim) to bundle and compress the JavaScript. The CSS/SCSS is created with the help of the awesome Compass framework (http://compass-style.org).

Dependencies

  • Ruby 1.9.2
  • Bundler (~>1.0)
  • Graphite (>=0.9.9) (and your data in graphite. The graphite URL API must be accessible from the same location as Graphiti and through the browser).
  • Redis (>2)
  • Unicorn
  • RubyGems and various Gems (see Gemfile)

Setup/Installation

  • Clone the repository
  • Make copies of the config/*.yml.example files application configuration.
  • Bundle: bundle install
  • Run: bundle exec unicorn -c config/unicorn.rb -E production -D
  • Generate the metrics list: bundle exec rake graphiti:metrics (In order to make searching through your list of metrics fast, Graphiti fetches and caches the full list in Redis. We put this in a rake task that you can run in the background and set up on a cron.)
  • A Capfile and config/deploy.rb is provided for reference (though it might work for you).

The JSON Graph data format

Every graph is stored and parsed as a JSON blob in a specific format that is meant to be readable and flexible.

The basic layout with required sections is:

{
  "options": {
    "optionName": "value" //, ...
  },
  "targets": [
    [
      "metricname",
        {"functionName": ["functionargument", ...]},
    ]
    //...
  ]
}

For simple targets, you can leave out the functions and just have something like:

{
  "options": { ... }, // options are also pre-generated from your settings.yml
                     // and can be controlled in the UI from the options form

  "targets": [
    "stats.timers.rails.production.controllers.total.*",
    "stats.timers.rails.staging.controllers.total.mean"
  ]
}

Functions are defined as a hash of function names and arguments:

{
  "targets": [
    [
      "stats.timers.rails.production.controllers.total.*",
      {
        "keepLastValue": true, // functions that take no arguments, just need a `true` value
        "movingAverage": 10, // functions that take a single argument, can just be assigned that value
        "substr": [6,7] // functions that take multiple arguments can be passed as an array of args
      } 
    ]
  ]
}

Credits

Mad peace and shout outs to @tmm1 and the Github crew for very helpful advice and code.

Contributing to Graphiti

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so we can cherry-pick around it.

Copyright

Copyright © 2011 Paperless Post. See LICENSE.md for details.