rrd-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daeb5b5caaff3a57391092455327295daa8c6210
+  data.tar.gz: 7e97ab2b34253dc454f1a05e943c1116a06f6d98
+SHA512:
+  metadata.gz: 16614243ebdf97b3b029f3bfb90aa771a80c9229845a428225f103c87d641a705aa6197ea5f91dc74659e834b876ed48bfc97bc35b6730426f5de4ab1647d3cd
+  data.tar.gz: 48774a58542500e7e4dbd4101a682068c1810af9195abdf06a63f6997278d1dc7f6b7b19fa8da84a6c2254d227ea6d13110ff1f4906f7d697c9ec0e525daf884

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rrd-native.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Igor Yamolov
+
+MIT License
+
+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,56 @@
+# RRD::Ruby
+
+Native ruby implementation of RRD format parsing.
+Don't need all these pesky C libraries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rrd-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rrd-ruby
+
+## Usage
+
+```ruby
+require 'rrd'
+
+file = RRD::File.new("path/to/my_awesome.rrd")
+
+# Get all Round Robin Archive infos
+rra = file.rra
+
+# Get all DataSource infos
+ds = file.datasources
+
+# Get all data from RRA in specified time interval
+data = file.data(rra.first).fetch(start_time: 20.minutes.ago, end_time: 5.minutes.ago)
+
+# Format data right in reading loop (perfomance for perfomance god!)
+data = file.data(rra.first).fetch do |row, columns|
+	columns # => [:time, :col1, :col2, :col3]
+	row # => [123345345, 123.0, 456.0, 789.0]	
+
+	# turn em into hash
+	Hash[columns.zip(row)] # => { time: 123345345, col1: 123.0, col2: 456.0, col3: 789.0 }
+end
+# => [... , { time: 123345345, col1: 123.0, col2: 456.0, col3: 789.0 }, ...]
+
+# All data read from file stream, right on spot
+file.close
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rrd/archive.rb

@@ -0,0 +1,57 @@
+module RRD
+  class Archive
+    RRA_cdp_xff_val = 0
+    RRA_hw_alpha = 1
+    RRA_hw_beta = 2
+    RRA_dependent_rra_idx = 3
+    RRA_period = 4
+    RRA_seasonal_gamma = 1
+    RRA_seasonal_smoothing_window = 2
+    RRA_seasonal_smooth_idx = 4
+    RRA_delta_pos = 1
+    RRA_delta_neg = 2
+    RRA_window_len = 4
+    RRA_failure_threshold = 5
+
+    attr_reader :cf, :rows, :pdpr, :options
+
+    attr_accessor :current_row, :data_pointer
+
+    def initialize(cf, rows, per_row, options)
+      @cf, @rows, @pdpr, @options = cf, rows, per_row, options
+    end
+
+    def cdp
+      @cdp ||= []
+    end
+
+    def self.parse(reader)
+      cf = reader.read_string(20, "A*").downcase.to_sym
+      rows, pdpr = reader.read(16, "QQ", align: true)
+
+      params = reader.read_uniparams(10)
+
+      options = {}
+
+      case cf
+      when :hwpredict, :mhwpredict
+        options[:alpha] = params[RRA_hw_alpha].to_f
+        options[:beta]  = params[RRA_hw_beta].to_f
+      when :seasonal, :devseasonal
+        options[:gamma] = params[RRA_seasonal_gamma].to_f
+        options[:smoothing_window]  = params[RRA_seasonal_smoothing_window].to_f
+      when :failures
+        options[:delta_pos] = params[RRA_delta_pos].to_f
+        options[:delta_neg] = params[RRA_delta_neg].to_f
+        options[:failure_threshold] = params[RRA_failure_threshold].to_i
+        options[:window_length] = params[RRA_window_len].to_i
+      when :devpredict
+      else
+        options[:xff] = params[RRA_cdp_xff_val].to_f
+      end
+      
+      Archive.new(cf, rows, pdpr, options)
+    end
+
+  end
+end

data/lib/rrd/cdp.rb

@@ -0,0 +1,55 @@
+module RRD
+  class CDP
+    CDP_val = 0
+    CDP_unkn_pdp_cnt = 1
+    CDP_hw_intercept = 2
+    CDP_hw_seasonal = 2
+    CDP_seasonal_deviation = 2
+    CDP_hw_last_intercept = 3
+    CDP_hw_last_seasonal = 3
+    CDP_last_seasonal_deviation = 3
+    CDP_hw_slope = 4
+    CDP_hw_last_slope = 5
+    CDP_null_count = 6
+    CDP_init_seasonal = 6
+    CDP_last_null_count = 7
+    CDP_primary_val = 8
+    CDP_secondary_val = 9
+
+    def initialize(options)
+      @options = options
+    end
+
+    def self.parse(reader, rra)
+      params = reader.read_uniparams(10)
+
+      options = {
+        primary_value: params[CDP_primary_val].to_f,
+        secondary_value: params[CDP_secondary_val].to_f
+      }
+
+      case rra.cf
+      when :hwpredict, :mhwpredict
+        options[:intercept] = params[CDP_hw_intercept].to_f
+        options[:last_intercept] = params[CDP_hw_intercept].to_f
+        options[:slope] = params[CDP_hw_intercept].to_f
+        options[:last_slope] = params[CDP_hw_intercept].to_f
+        options[:null_count] = params[CDP_hw_intercept].to_i
+        options[:last_null_count] = params[CDP_hw_intercept].to_i
+      when :seasonal
+        options[:seasonal] = params[CDP_hw_seasonal].to_f
+        options[:last_seasonal] = params[CDP_hw_last_seasonal].to_f
+        options[:init_seasonal] = params[CDP_init_seasonal].to_i
+      when :devseasonal
+        options[:seasonal_deviation] = params[CDP_seasonal_deviation].to_f
+        options[:last_seasonal_deviation] = params[CDP_last_seasonal_deviation].to_f
+        options[:init_seasonal] = params[CDP_init_seasonal].to_i
+      else
+        options[:value] = params[CDP_val].to_f
+        options[:unknown_datapoints] = params[CDP_unkn_pdp_cnt].to_i
+      end
+
+      new(options)
+    end
+  end
+end

data/lib/rrd/data.rb

@@ -0,0 +1,113 @@
+module RRD
+  class Data
+
+    attr_reader :reader, :rra, :header, :data_start
+
+    def initialize(rra, reader, header, data_start)
+      @rra = rra
+      @reader = reader
+      @header = header
+      @data_start = data_start
+
+      header.setup_reader(reader) # update endianess and alignment
+    end
+
+    def last_update
+      @last_update ||= round_time(header.last_update.to_i)
+    end
+
+    def last_row
+      reader.seek(base_position + rra.current_row * row_size)
+
+      [last_update] + reader.read(row_size, unpack_formula)
+    end
+    
+    def fetch(options = {}, &block)
+      row = options[:start_row] || 0
+      rows = [options[:rows] || rra.rows, rra.rows].min
+
+      head = 
+
+      last_update = round_time(header.last_update.to_i)
+      current_time = last_update - (rra.rows * step_time)
+
+      columns = [:time] + header.datasources.map(&:name).map(&:to_sym)
+
+      if options[:start_time]
+        start_time = round_time(options[:start_time].to_i)
+
+        if current_time < start_time
+          row = ((start_time - current_time) / step_time).floor
+          current_time = start_time
+        end
+      end
+
+      if options[:end_time]
+        end_time = round_time(options[:end_time].to_i)
+
+        if end_time < last_update
+          rows = ((end_time - current_time) / step_time).ceil
+        end
+      end
+
+      if row < head
+        reader.seek(base_position + ((rra.current_row + 1 + row) * row_size))
+      end
+
+      data = []
+      while row < rows
+        if head && row >= head
+          reader.seek(base_position + (row - head) * row_size) # jump to beginning
+          head = nil
+        end
+
+        current_time += step_time
+
+        row_data = [current_time] + reader.read(row_size, unpack_formula)
+
+        row_data = block.call(row_data, columns, options) if block
+
+        data << row_data
+
+        row += 1
+      end
+
+      data
+    end
+
+    private
+
+    def head
+      @head ||= rra.rows - (rra.current_row + 1)
+    end
+
+    def tail
+      rra.current_row
+    end
+
+    def unpack_formula
+      @unpack_formula ||= "D" * ds_count
+    end
+
+    def base_position
+      @base_position ||= data_start + rra.data_pointer
+    end
+
+    def step_time
+      @step_time ||= header.step * rra.pdpr
+    end
+
+    def row_size
+      @row_size ||= ds_count * 8
+    end
+
+    def ds_count
+      @ds_count ||= header.datasources.size
+    end
+
+    def round_time(time)
+      time - time % step_time
+    end
+
+  end
+end

data/lib/rrd/data_source.rb

@@ -0,0 +1,36 @@
+module RRD
+  class DataSource
+    PARAMS = [
+      :min_heartbeat, :min_value, :max_value
+    ]
+
+    attr_accessor :name, :type, :last_value, :last_ds, :unknown_seconds, :options
+
+    def initialize(name, type, options = {})
+      @name, @type = name, type
+      @options = options
+    end
+
+    def self.parse(reader)
+      name = reader.read_string(20, "A*")
+      type = reader.read_string(20, "A*")
+      params = Hash[PARAMS.zip(reader.read_uniparams(10))]
+
+      options = {
+        min_heartbeat: params[:min_heartbeat].to_i,
+        min_value: params[:min_value].to_f,
+        max_value: params[:max_value].to_f
+      }
+     
+      DataSource.new(name, type, options)
+    end
+
+    def cdp
+      @cdp ||= []
+    end
+
+    def inspect
+      "<RRD::DataSource name='#{name}' type='#{type}' options='#{options}'>"
+    end
+  end
+end

data/lib/rrd/file.rb

@@ -0,0 +1,31 @@
+module RRD
+  class File
+    attr_reader :reader, :header, :data_start
+
+    def initialize(file)
+      @reader = RRD::Reader.new(file)
+    end
+
+    def close
+      @reader.close if @reader
+    end
+
+    def header
+      @header ||= begin
+        header = RRD::Header.parse(reader)
+
+        @data_start = reader.pos
+
+        header
+      end
+    end
+
+    def data(rra_index)
+      RRD::Data.new(header.rra[rra_index], reader, header, @data_start)
+    end
+
+    def fetch(rra_index, options ={}, &block)
+      data(rra_index).fetch(options, &block)
+    end
+  end
+end

data/lib/rrd/header.rb

@@ -0,0 +1,117 @@
+module RRD
+  class Header
+    COOKIE_STRING = "RRD\0"
+    COOKIE_DOUBLE = 8.642135E130
+
+    attr_reader :version, :last_update, :step, :endianess, :alignment
+
+    attr_reader :rra, :datasources
+
+    def initialize(options)
+      @version = options[:version] || "0003"
+      @last_update = options[:last_update] # || Time.now
+      @step = options[:step] || 10
+      @endianess = options[:endianess] || :little
+      @alignment = options[:alignment] || 4
+
+      @rra = options[:rra] || []
+      @datasources = options[:datasources] || []
+    end
+
+    def setup_reader(reader)
+      reader.endianess = endianess
+      reader.alignment = alignment
+    end
+
+    def self.parse(reader)
+      reader.seek(0) # rewind to start
+
+      read_cookie(reader)
+
+      options = {}
+
+      options[:version] = reader.read(5, "a*").first
+
+      read_double_cookie(reader, options)
+
+      datasources_count, rra_count, @step = reader.read(24, "QQQ")
+
+      global_params = reader.read_uniparams(10)
+
+      options[:datasources] = []
+      datasources_count.times do |i|
+        options[:datasources] << RRD::DataSource.parse(reader)
+      end
+
+      options[:rra] = []
+      rra_pointer = 0
+      rra_count.times do |i|
+        rra = RRD::Archive.parse(reader)
+
+        rra.data_pointer = rra_pointer
+        rra_pointer += rra.rows * datasources_count * 8
+
+        options[:rra] << rra
+      end
+
+      last_update, last_update_msec = reader.read(16, "QQ")
+
+      options[:last_update] = Time.at(last_update.to_f + (last_update_msec.to_f / 1000000))
+
+      datasources_count.times do |i|
+        datasource = options[:datasources][i]
+
+        datasource.last_ds = reader.read_string(30, "A*")
+        reader.align
+        params = reader.read_uniparams(10)
+        datasource.unknown_seconds = params[0].to_i
+        datasource.last_value = params[1].to_f
+      end
+
+      rra_count.times do |rra_index|
+        datasources_count.times do |ds_index|
+          cdp = RRD::CDP.parse(reader, options[:rra][rra_index])
+          options[:rra][rra_index].cdp[ds_index] = cdp
+          options[:datasources][ds_index].cdp[rra_index] = cdp
+        end
+      end
+
+      rra_count.times do |rra_index|
+        options[:rra][rra_index].current_row = reader.read(8, "Q").first
+      end
+
+      Header.new(options)
+    end    
+
+    private
+
+    def self.read_cookie(reader) 
+      raise "Invalid RRD file" unless reader.read_string(4) == COOKIE_STRING
+    end
+
+    def self.read_double_cookie(reader, options)
+      reader.read(3) # skip 32-bit alignment
+      part = reader.read_string(4) # 64-bit alignment or first part of double-cookie
+
+      if part == "\0\0\0\0" # RRD made on 64-bit system
+        cookie = reader.read_string(8)
+        options[:alignment] = 8
+      else # made on 32-bit system
+        cookie = part + reader.read_string(4)
+        options[:alignment] = 4
+      end
+
+      case COOKIE_DOUBLE
+      when cookie.unpack("G").first
+        options[:endianess] = :big
+      when cookie.unpack("E").first
+        options[:endianess] = :little
+      else
+        raise "Unknown architecture!"
+      end
+
+      reader.endianess = options[:endianess]
+      reader.alignment = options[:alignment]
+    end
+  end
+end