g5k-graph 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Cyril Rohr, INRIA Rennes - Bretagne Atlantique
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# g5k-graph
+A tool to help generate graphs for your Grid'5000 metrics.
+
+## Installation
+
+    gem install g5k-graph
+
+## Usage
+
+    g5k-graph -h
+    
+    * Description
+      g5k-graph - Graph your Grid'5000 metrics.
+    * Usage
+      g5k-graph [options] < list-of-nodes
+    * Options
+        -f, --from=                      The timeseries start time, in seconds since EPOCH [default=1303113485]
+        -t, --to=                        The timeseries end time, in seconds since EPOCH [default=1303114080]
+        -r, --resolution=                The timeseries resolution, in seconds [default=15]
+        -m, --metrics=                   The comma-separated list of metrics to fetch [default=mem_free,cpu_idle,bytes_in,bytes_out]
+        -o, --output=                    Where to write the timeseries data and graphs [default=/Volumes/backup/dev/g5k-graph/data]
+        -h, --help                       Show this message
+
+Example:
+
+      g5k-graph --metrics mem_free,custom_metric -o /tmp -r 360 < $OAR_NODE_FILE
+
+This tools takes a list of nodes on STDIN, and a set of options, and outputs a graph for each metric that you gave.
+It fetches the timeseries from the [Grid'5000 API](https://api.grid5000.fr/) with the `cURL` tool, and as such you may need to have a proper `~/.netrc` setup for the authentication to work (see the curl-tutorial at  <http://grid5000.github.com/tutorials/>).
+
+## Authors
+* Cyril Rohr <cyril.rohr@inria.fr>

data/bin/g5k-graph

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'grid5000/graph'
+
+require 'optparse'
+
+@options = {
+  :from => Time.now.to_i-600,
+  :resolution => 15,
+  :metrics => ['mem_free', 'cpu_idle', 'bytes_in', 'bytes_out'],
+  :to => (Time.now.to_i/15*15),
+  :output => File.expand_path("./data")
+}
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+* Description
+  g5k-graph #{Grid5000::Graph::VERSION} - Graph your Grid'5000 metrics.
+* Usage
+  g5k-graph [options] < list-of-nodes
+* Options
+BANNER
+
+  opts.on("-f=", "--from=", "The timeseries start time, in seconds since EPOCH [default=#{@options[:from]}]") do |v|
+    @options[:from] = v.to_i
+  end
+  opts.on("-t=", "--to=", "The timeseries end time, in seconds since EPOCH [default=#{@options[:to]}]") do |v|
+    @options[:to] = v.to_i
+  end
+  opts.on("-r=", "--resolution=", "The timeseries resolution, in seconds [default=#{@options[:resolution]}]") do |v|
+    @options[:resolution] = v.to_i
+  end
+  opts.on("-m=", "--metrics=", "The comma-separated list of metrics to fetch [default=#{@options[:metrics].join(",")}]") do |v|
+    @options[:metrics] = v.split(",")
+  end
+  opts.on("-o=", "--output=", "Where to write the timeseries data and graphs [default=#{@options[:output]}]") do |v|
+    @options[:output] = File.expand_path(v)
+  end
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+  
+end
+
+option_parser.parse!
+
+
+begin
+  Grid5000::Graph.check_environment!
+
+  nodes = []
+  while node = gets() do
+    nodes.push(node.chomp) unless node.strip.empty?
+  end
+
+  Grid5000::Graph.new(nodes, @options).graph!
+  exit 0
+rescue Grid5000::Graph::Error => e
+  STDERR.puts "#{e.class.name}: #{e.message}"
+  exit 1
+end

data/lib/grid5000/graph.rb

@@ -0,0 +1,99 @@
+module Grid5000
+  class Graph
+    VERSION = "0.1.0"
+    
+    class Error < StandardError; end
+    
+    attr_reader :options, :nodes
+    
+    def initialize(nodes, options = {})
+      @nodes = nodes
+      @options = options
+      @colors = {}
+    end
+    
+    class << self
+      def check_environment!
+        `which rrdtool`
+        raise(Error, "It looks like you do not have the `rrdtool` binary in your path. Please try to install it first.") if $?.exitstatus != 0
+        `which unzip`
+        raise(Error, "It looks like you do not have the `unzip` binary in your path. Please try to install it first.") if $?.exitstatus != 0
+        true
+      end
+    end
+    
+    def graph!      
+      raise(Error, "No nodes given") if nodes.empty?
+
+      if nodes.all?{|n| n =~ /\.\w+\.grid5000\.fr$/}
+        fetch_timeseries
+        graph_timeseries
+      else
+        raise(Error, "One of the given nodes is not correct: #{nodes.inspect}")
+      end
+
+    end
+    
+    def fetch_timeseries
+      nodes_by_site = nodes.group_by{|n|
+        n.split(".")[1]
+      }
+      nodes_by_site.keys.each do |site|
+        cmd = "curl -kn \"https://api.grid5000.fr/2.0/grid5000"+
+        "/sites/#{site}/metrics/{#{options[:metrics].join(",")}}/timeseries.zip"+
+        "?only=#{nodes_by_site[site].join(",")}"+
+        "&from=#{options[:from]}"+
+        "&to=#{options[:to]}"+
+        "&resolution=#{options[:resolution]}\""+
+        " -o \"#{File.join(options[:output], "#{site}-#1-timeseries.zip")}\""
+        puts cmd
+        system cmd
+      end
+    end
+    
+    def graph_timeseries
+      Dir.chdir(options[:output]) do |dir|
+        Dir["*.zip"].each do |zip|
+         system "unzip #{zip}"
+        end
+        commands = {}
+        Dir["*.grid5000.fr/*.xml"].each do |xml|
+         dirname = File.dirname(xml)
+         metric = File.basename(xml, ".xml")
+         node = File.basename(dirname).split(".").first
+         commands[metric] ||= "rrdtool graph #{metric}.png --title #{metric} -s #{options[:from]}"
+         puts "Restoring #{metric}..."
+         rrd = "#{File.join(dirname, metric)}.rrd"
+         File.unlink rrd if File.exist?(rrd)
+         system "rrdtool restore #{xml} #{rrd}"
+         # generate random color
+         color = color(node)
+         commands[metric] += " DEF:#{node}=#{rrd}:sum:AVERAGE LINE2:#{node}##{color}:#{node}"
+        end
+        commands.each do |metric, cmd| 
+         puts "Executing #{cmd}"
+         system cmd
+        end
+        puts "The following graphs have been generated in #{dir.inspect}:"
+        puts Dir["*.png"].join("\n")
+      end
+    end
+    
+    # FIXME: a bit too verbose
+    def color(id)
+      if @colors.has_key?(id)        
+        @colors[id]
+      else
+        c = "%06x" % (rand * 0xffffff)
+        if @colors.values.find{|v| v == c}
+          # find another color
+          color(id)
+        else
+          @colors[id] = c
+          @colors[id]
+        end
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: g5k-graph
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cyril Rohr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Graph your Grid'5000 metrics
+email: 
+- cyril.rohr@gmail.com
+executables: 
+- g5k-graph
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- bin/g5k-graph
+- lib/grid5000/graph.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/crohr/g5k-graph
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 31
+      segments: 
+      - 1
+      - 8
+      version: "1.8"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 9
+      segments: 
+      - 1
+      - 3
+      version: "1.3"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Graph your Grid'5000 metrics
+test_files: []
+