rrd_rest_api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 929c34e0161b4b7e2f80444e6eeb8ef0c5827f43
-  data.tar.gz: adef1a36e9481ee427fcad1371203dad67472cae
+  metadata.gz: 0bcb45d62b3521655a92b06314bc6a9ea551f1f9
+  data.tar.gz: bdc45d4f92e258f117386fd8e89e730dc40b1c3b
 SHA512:
-  metadata.gz: 193a00a29b93069a30ca07f930d9273658fe75c650c591b50195a93e26b8e748740f2a72985526bdb290241c1c4de51d5709fad19a2ffd5e48c2fc057f2fea5d
-  data.tar.gz: aa2009b5611a2edefbe074db085878ef8fc07ed9e422cea1e6a536b185b9e48dcd936d6f544fba55a89f55d94aaf4f00dccc3a8bdbf03b4d2add3476aa0246cb
+  metadata.gz: 026c76a12ed4114c96b73c64a674a3d038db949746f0522e8a24111afc712d55fa76fa30c97614f4ccf116a33043478f87231b96a57ae5d4bb23a1e0a5860b6a
+  data.tar.gz: e557e453ee8466052c333b60f7c33d3ffefea5e50586ccf86e550b5a8d5059897f629392ad3df8b54743397916234ffef69c52d0de57f0379e33b454b64864a5

data/lib/rrd_repo.rb

@@ -0,0 +1,97 @@
+require 'rrd'
+
+class RRDRepo
+  attr_reader :filename
+
+  def self.create(filename, datasources, start = Time.now)
+    one_day = 60 * 60 * 24
+
+    rrd = RRD::Base.new(filename)
+    rrd.create(:start => start, :step => 60) do
+      datasources.each do |name|
+        datasource name, :type => :gauge, :heartbeat => 120, :min => 0, :max => :unlimited
+      end
+      archive :average, :every => 60, :during => one_day
+      archive :average, :every => 300, :during => one_day
+    end
+    RRDRepo.new(filename)
+  end
+
+  def initialize(filename)
+    @filename = filename
+  end
+
+  def latest_value(datasource)
+    _rrd.info["ds[#{datasource}].last_ds"].to_f
+  end
+
+  def info
+    info = _rrd.info
+    archives = unflatten_archives(info)
+    {
+      :step => info["step"],
+      :archives => archives.map do |archive|
+        {
+          :consolidation_function => archive["cf"],
+          :resolution_sec => info["step"] * archive["pdp_per_row"],
+          :duration_sec => info["step"] * archive["pdp_per_row"] * archive["rows"]
+        }
+      end
+    }
+  end
+
+  def read(resolution, start_ts, end_ts, function = :average)
+    start_time = (start_ts.to_i / resolution) * resolution
+    end_time = (end_ts.to_i / resolution) * resolution
+    data = _rrd.fetch(
+      function,
+      :resolution => resolution,
+      :start => start_time,
+      :end => end_time
+    )
+    header, values = data.first, data[1..-1]
+    nan_filtered = values.reject { |v| v[1..-1].any?(&:nan?) }
+    nan_filtered.map { |v| Hash[header.zip(v)] }
+  end
+
+  def write(time, values = [])
+    _rrd.update(time, *values)
+  end
+
+  def _rrd
+    raise("Unable to open RRD, because it doesn't exist: #{@filename}") unless File.exist?(@filename)
+    @rrd ||= RRD::Base.new(@filename)
+  end
+
+  private
+
+  # Takes a flat hash output from an rrd "info" call and unflattens
+  # it by each archive.
+  #
+  # Input:
+  # {
+  #   "rra[0].pdp_per_row"=>1,
+  #   "rra[0].xff"=>0.5,
+  #   "rra[1].pdp_per_row"=>168,
+  #   "rra[1].xff"=>0.5,
+  #    ...
+  # }
+  #
+  # Output:
+  # [
+  #   {
+  #     "pdp_per_row"=>1,
+  #     "xff" => 0.5,
+  #   },
+  #   {
+  #     "pdp_per_row" => 168,
+  #     "xff" => 0.5
+  #   }
+  # ]
+  def unflatten_archives(info)
+    info.select { |key, value| key.index("rra") == 0 }
+      .group_by { |elem| elem[0].split('.')[0] }
+      .sort_by { |rra, _| rra }
+      .map { |rra, values| Hash[values.map { |key, val| [key.split('.')[1], val] }] }
+  end
+end

data/server.rb

@@ -1,6 +1,7 @@
+require 'json'
 require 'sinatra'
 require 'yaml'
-require File.expand_path(File.dirname(__FILE__) + "/lib/rrd_query")
+require File.expand_path(File.dirname(__FILE__) + "/lib/rrd_repo")
 
 configure :production do
   set :port, 5678
@@ -16,8 +17,40 @@ get '/data/:file/latest/sum' do |file|
   end
 
   filename = _allowed_rrds[file]
-  rrd_query = RRDQuery.new(filename)
-  rrd_query.latest_value("sum").to_s
+  rrd_repo = RRDRepo.new(filename)
+  rrd_repo.latest_value("sum").to_s
+end
+
+get '/data/:file/read/' do |file|
+  unless _allowed_rrds.has_key?(file)
+    return 404
+  end
+
+  if params[:resolution].nil?
+    status 400
+    body "You must provide a 'resolution' query param in seconds"
+    return
+  end
+
+  if params[:duration].nil?
+    status 400
+    body "You must provide a 'duration' query param in seconds"
+    return
+  end
+
+  filename = _allowed_rrds[file]
+  rrd_repo = RRDRepo.new(filename)
+  info = rrd_repo.info
+  response.headers["X-RRD"] = "step=#{info[:step]}"
+  info[:archives].each_with_index do |archive, i|
+    response.headers["X-RRD-Archive#{i}"] = "cf=#{archive[:consolidation_function]}; resolution=#{archive[:resolution_sec]}; duration=#{archive[:duration_sec]}"
+  end
+
+  res = params[:resolution].to_i
+  dur = params[:duration].to_i
+  stop = Time.now
+  start = stop - dur
+  JSON.dump(rrd_repo.read(res, start, stop))
 end
 
 def _allowed_rrds

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rrd_rest_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - TempoIQ Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -47,7 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - config.ru
-- lib/rrd_query.rb
+- lib/rrd_repo.rb
 - public/.gitemptydir
 - server.rb
 - tmp/.gitemptydir

data/lib/rrd_query.rb

@@ -1,18 +0,0 @@
-require 'rrd'
-
-class RRDQuery
-  attr_reader :filename
-
-  def initialize(filename)
-    @filename = filename
-  end
-
-  def latest_value(datasource)
-    _rrd.info["ds[#{datasource}].last_ds"].to_f
-  end
-
-  def _rrd
-    raise("Unable to open RRD, because it doesn't exist: #{@filename}") unless File.exist?(@filename)
-    @rrd ||= RRD::Base.new(@filename)
-  end
-end