visage-app 1.0.0 → 2.0.0

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+log/*
+tmp/*
+pkg/*
+*~
+.#*
+webrat*
+lib/visage-app/config/profiles.yaml
+_site
+features/data/config/*/*.yaml

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+2.0.0
+ - New builder interface, optimised for metric discovery + investigatory work
+ - Backwards incompatible profile.yaml file format change
+ - Chart performance optimisations
+ - Visual improvements to chart layout + design
+ - Bump versions of dependencies
+ - Improve the installation documentation for non-Ubuntu platforms
+
+1.0.0 (e11234a) - Sat Jun 11 07:56:08 2011 +1000
+
+ - 1.0.0 release! Production ready.
+

data/Gemfile

@@ -1,18 +1,4 @@
 #!/usr/bin/env ruby
 
 source :rubygems
-
-gem "haml"
-gem "tilt"
-gem "sinatra"
-gem "errand", "0.7.3"
-gem "yajl-ruby"
-
-group :development do
-  gem "shotgun"
-  gem "rack-test"
-  gem "rspec"
-  gem "cucumber"
-  gem "webrat"
-  gem "jeweler"
-end
+gemspec

data/Gemfile.lock

@@ -1,62 +1,64 @@
+PATH
+  remote: .
+  specs:
+    visage-app (2.0.0)
+      errand (= 0.7.3)
+      haml (= 3.1.4)
+      sinatra (= 1.3.2)
+      tilt (= 1.3.3)
+      yajl-ruby (= 1.1.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
     builder (3.0.0)
-    cucumber (0.10.0)
+    cucumber (1.1.9)
       builder (>= 2.1.2)
-      diff-lcs (~> 1.1.2)
-      gherkin (~> 2.3.2)
-      json (~> 1.4.6)
-      term-ansicolor (~> 1.0.5)
-    diff-lcs (1.1.2)
-    errand (0.7.2)
-    gherkin (2.3.3)
-      json (~> 1.4.6)
-    git (1.2.5)
-    haml (3.0.25)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    json (1.4.6)
-    nokogiri (1.4.4)
-    rack (1.2.1)
-    rack-test (0.5.7)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.9.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    errand (0.7.3)
+    gherkin (2.9.1)
+      json (>= 1.4.6)
+    haml (3.1.4)
+    json (1.6.5)
+    nokogiri (1.5.2)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rake (0.8.7)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
-    shotgun (0.8)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    shotgun (0.9)
       rack (>= 1.0)
-    sinatra (1.1.2)
-      rack (~> 1.1)
-      tilt (~> 1.2)
-    term-ansicolor (1.0.5)
-    tilt (1.2.2)
-    webrat (0.7.1)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    term-ansicolor (1.0.7)
+    tilt (1.3.3)
+    webrat (0.7.3)
       nokogiri (>= 1.2.0)
       rack (>= 1.0)
       rack-test (>= 0.5.3)
-    yajl-ruby (0.7.9)
+    yajl-ruby (1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   cucumber
-  errand
-  haml
-  jeweler
   rack-test
   rspec
   shotgun
-  sinatra
-  tilt
+  visage-app!
   webrat
-  yajl-ruby

data/README.md

@@ -16,10 +16,8 @@ Features
 
 Here, have a graph:
 
-
 ![Something I prepared earlier.](http://farm2.static.flickr.com/1020/4730994504_c8c6fc9c18_z.jpg)
 
-
 Or check out [a live demo](http://visage.unstated.net/nadia/cpu+load).
 
 Installing
@@ -27,68 +25,121 @@ Installing
 
 N.B: Visage must be deployed on a machine where `collectd` stores its stats in RRD.
 
+### Ubuntu ###
+
 On Ubuntu, to install dependencies run:
 
-    $ sudo apt-get install -y build-essential librrd-ruby ruby ruby-dev rubygems collectd
+``` bash
+sudo apt-get install -y build-essential librrd-ruby ruby ruby-dev rubygems collectd
+```
+
+Then install the app with:
+
+``` bash
+gem install visage-app
+```
+
+### CentOS/RHEL ###
+
+#### CentOS/RHEL 5 ####
+Visage uses [yajl-ruby](https://github.com/brianmario/yajl-ruby) to work with
+JSON, which requires Ruby >= 1.8.6. CentOS/RHEL 5 ship with Ruby 1.8.5, so you
+will need to use [Ruby Enterprise Edition](http://www.rubyenterpriseedition.com/).
+
+Endpoint provide packages for REE and a [Yum repository](https://packages.endpoint.com/)
+to ease installation.
 
-On CentOS, to install dependencies run:
+Follow the above instructions for installing REE, and then run:
 
-    $ sudo yum install -y ruby-RRDtool ruby rubygems collectd
+``` bash
+sudo yum install -y librrd-dev ruby rubygems collectd
+gem install librrd
+```
 
-If you are using Ruby Enterprise Edition, instead of installing librrd-ruby or ruby-RRDtool, run
+Then install the app with:
+
+``` bash
+gem install visage-app
+```
+
+#### CentOS/RHEL 6+ ####
 
-    $ gem install librrd
+On CentOS 6, to install dependencies run:
+
+``` bash
+sudo yum install -y ruby-RRDtool ruby rubygems collectd
+```
 
 Then install the app with:
 
-    $ gem install visage-app
+``` bash
+gem install visage-app
+```
+
+### Mac OS X ###
+
+Visage is not supported on Mac OS X, as RRDtool is a pain in the arse on that
+platform. It's highly recommended you use [Vagrant](http://vagrantup.com/) to
+fire up an Ubuntu box to run Visage.
+
 
 Running
 -------
 
 You can try out Visage quickly with:
 
-    $ visage-app start
+``` bash
+visage-app start
+```
 
 Then paste the URL from the output into your browser.
 
 If you get a `command not found` when running the above command (RubyGems likely
 isn't on your PATH), try this instead:
 
-    $ $(dirname $(dirname $(gem which visage-app)))/bin/visage-app start
+``` bash
+$(dirname $(dirname $(gem which visage-app)))/bin/visage-app start
+```
 
 Deploying
 ---------
 
 Visage can be deployed on Apache with Passenger:
 
-    $ sudo apt-get install libapache2-mod-passenger
+``` bash
+sudo apt-get install libapache2-mod-passenger
+```
 
 Visage can attempt to generate an Apache vhost config for use with Passenger:
 
-    $ visage-app genapache
-    <VirtualHost *>
-      ServerName ubuntu.localdomain
-      ServerAdmin root@ubuntu.localdomain
+``` bash
+visage-app genapache
+<VirtualHost *>
+  ServerName ubuntu.localdomain
+  ServerAdmin root@ubuntu.localdomain
 
-      DocumentRoot /home/user/.gem/ruby/1.8/gems/visage-app-0.1.0/lib/visage-app/public
+  DocumentRoot /home/user/.gem/ruby/1.8/gems/visage-app-0.1.0/lib/visage-app/public
 
-      <Directory "/home/user/.gem/ruby/1.8/gems/visage-app-0.1.0/lib/visage-app/public">
-         Options FollowSymLinks Indexes
-         AllowOverride None
-         Order allow,deny
-         Allow from all
-       </Directory>
-    </VirtualHost>
+  <Directory "/home/user/.gem/ruby/1.8/gems/visage-app-0.1.0/lib/visage-app/public">
+     Options FollowSymLinks Indexes
+     AllowOverride None
+     Order allow,deny
+     Allow from all
+   </Directory>
+</VirtualHost>
+```
 
 Copypasta this into your system's Apache config structure and tune to taste.
 
 To do this on Debian/Ubuntu:
 
-    $ sudo -s
-    $ visage-app genapache > /etc/apache2/sites-enabled/visage
-    $ a2dissite default
-    $ service apache2 reload
+``` bash
+sudo -s
+visage-app genapache > /etc/apache2/sites-available/visage
+a2ensite visage
+a2dissite default
+service apache2 reload
+```
 
 Then head to your Apache instance and Visage will be up and running.
 
@@ -104,58 +155,74 @@ Visage has a configuration search path which can be used for overriding
 individual files. By default it has one entry: `$VISAGE_ROOT/lib/visage/config/`.
 You can set the `CONFIG_PATH` environment variable to add another directory to
 the config load path. This directory will be searched when loading up
-configuration files.
+configuration files:
 
-    CONFIG_PATH=/var/lib/visage-app start
+```
+CONFIG_PATH=/var/lib/visage visage-app start
+```
 
 This is especially useful when you want to deploy + run Visage from an installed
 gem with Passenger. e.g.
 
-    <VirtualHost *:80>
-      ServerName monitoring.example.org
-      ServerAdmin me@example.org
+```
+<VirtualHost *:80>
+  ServerName monitoring.example.org
+  ServerAdmin me@example.org
 
-      SetEnv CONFIG_PATH /var/lib/visage
-      SetEnv RRDDIR /opt/collectd/var/lib/collectd
+  SetEnv CONFIG_PATH /var/lib/visage
+  SetEnv RRDDIR /opt/collectd/var/lib/collectd
 
-      DocumentRoot /var/lib/gems/1.8/gems/visage-app-0.3.0/lib/visage/public
-      <Directory />
-        Options FollowSymLinks
-        AllowOverride None
-      </Directory>
+  DocumentRoot /var/lib/gems/1.8/gems/visage-app-0.3.0/lib/visage/public
+  <Directory />
+    Options FollowSymLinks
+    AllowOverride None
+  </Directory>
 
-      LogFormat "%h %l %u %t \"%r\" %>s %b" common
-      CustomLog /var/log/apache2/access.log common
-    </VirtualHost>
+  LogFormat "%h %l %u %t \"%r\" %>s %b" common
+  CustomLog /var/log/apache2/access.log common
+</VirtualHost>
+```
 
 Also to keep in mind when deploying with Passenger, the `CONFIG_PATH` directory
 and its files need to have the correct ownership:
 
-    chown nobody:nogroup -R /var/lib/visage
+``` bash
+chown nobody:nogroup -R /var/lib/visage
+```
 
 Developing + testing
 --------------------
 
 Check out the code with:
 
-    $ git clone git://github.com/auxesis/visage.git
+``` bash
+git clone git://github.com/auxesis/visage.git
+```
 
 Install the development dependencies with:
 
-    $ gem install bundler
-    $ bundle install
+``` bash
+gem install bundler
+bundle install
+```
 
 Run all cucumber features:
 
-    $ rake cucumber
+``` bash
+rake features
+```
 
 And run the app with:
 
-    $ shotgun lib/visage-app/config.ru
+``` bash
+shotgun lib/visage-app/config.ru
+```
 
 To create and install a new gem from the current source tree:
 
-    $ rake install
+``` bash
+rake install
+```
 
 Licencing
 ---------
@@ -168,3 +235,10 @@ permission to distribute Highcharts under the GPLv2 as part of Visage.
 If you ever need an excellent JavaScript charting library, please consider
 purchasing a [commercial license](http://highcharts.com/license) for
 Highcharts.
+
+TODO
+----
+
+ - add natural language support for timeframes (default view: 1 week ago)
+ - add sparklines to profile view
+ - add checkbox to enable live updates on all graphs

data/Rakefile

@@ -1,35 +1,25 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
+require 'bundler/setup'
+require 'cucumber'
+require 'cucumber/rake/task'
 
-begin
-  require 'cucumber/rake/task'
-
-  Cucumber::Rake::Task.new do |t|
-    t.binary = "bin/cucumber"
-    t.cucumber_opts = "--require features/ features/"
-  end
-rescue LoadError
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
 end
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name        = "visage-app"
-    gemspec.summary     = "a web (interface | service) for viewing collectd statistics"
-    gemspec.description = "Visage is a web interface for viewing collectd statistics. It also provides a JSON interface onto collectd's RRD data, giving you an easy way to mash up the data."
-    gemspec.email       = "lindsay@holmwood.id.au"
-    gemspec.homepage    = "http://visage-app.com/"
-    gemspec.authors     = ["Lindsay Holmwood"]
+desc "build gem"
+task :build do
+  build_output = `gem build visage-app.gemspec`
+  puts build_output
 
-    gemspec.add_dependency "sinatra", "~> 1.1.3"
-    gemspec.add_dependency "tilt", "~> 1.2.2"
-    gemspec.add_dependency "haml", "~> 3.0.13"
-    gemspec.add_dependency "errand", "= 0.7.3"
-    gemspec.add_dependency "yajl-ruby", "~> 0.8.1"
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
+  gem_filename = build_output[/File: (.*)/,1]
+  pkg_path = "pkg"
+  FileUtils.mkdir_p(pkg_path)
+  FileUtils.mv(gem_filename, pkg_path)
+
+  puts "Gem built in #{pkg_path}/#{gem_filename}"
 end
 
 desc "push gem"
@@ -58,7 +48,7 @@ end
 
 desc "clean up various generated files"
 task :clean do
-  [ "webrat.log", "pkg/", "visage-app-*.spec", "_site/"].each do |filename|
+  [ "webrat.log", "pkg/", "_site/"].each do |filename|
     puts "Removing #{filename}"
     FileUtils.rm_rf(filename)
   end