prrd 0.2.0

data/lib/prrd/graph/hrule.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+# File: hrule.rb
+# Time-stamp: <2014-10-01 21:15:13 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Hrul class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Graph Hrule class
+    class Hrule < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :value,
+          :color,
+          :legend,
+          :dashes,
+          :dashes_offset
+        ]
+
+        super values
+      end
+
+      # Transform to a HRULE formatted string
+      def to_s
+        fail 'Empty hrule object' if @data.empty?
+
+        validate_presence :value, :color
+
+        chunks = []
+
+        @keys.each do |k|
+          next unless @data.key?(k)
+          case k
+          when :value
+            chunks << "HRULE:%s%s" % [@data[k], @data[:color]]
+          when :dashes
+            chunks << "dashes=\"%s\"" % @data[k]
+          when :dashes_offset
+            chunks << "dashes-offset=\"%s\"" % @data[k]
+          when :color
+            # nope
+          else
+            chunks << @data[k]
+          end
+        end
+
+        chunks.join ':'
+      end
+    end
+  end
+end

data/lib/prrd/graph/line.rb

@@ -0,0 +1,53 @@
+# File: line.rb
+# Time-stamp: <2014-10-01 21:16:41 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Line class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Graph Line class
+    class Line < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :value,
+          :width,
+          :color,
+          :legend,
+          :stack
+        ]
+
+        super values
+      end
+
+      # Transform to a LINE formatted string
+      def to_s
+        fail 'Empty line object' if @data.empty?
+
+        @data[:width] ||= 1
+
+        validate_presence :value
+
+        chunks = []
+
+        @keys.each do |k|
+          next unless @data.key?(k)
+          case k
+          when :value
+            chunks << "LINE%s:%s%s" % [@data[:width], @data[k], @data[:color]]
+          when :width, :color
+            # nope
+          when :legend
+            chunks << "\"%s\"" % @data[k]
+          when :stack
+            chunks << "STACK"
+          else
+            chunks << @data[k]
+          end
+        end
+
+        chunks.join ':'
+      end
+    end
+  end
+end

data/lib/prrd/graph/print.rb

@@ -0,0 +1,48 @@
+# File: print.rb
+# Time-stamp: <2014-10-01 21:17:17 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Print class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Graph Line class
+    class Print < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :gprint,
+          :vname,
+          :cf,
+          :format,
+          :strftime
+        ]
+
+        super values
+      end
+
+      # Transform to a PRINT formatted string
+      def to_s
+        fail 'Empty print object' if @data.empty?
+
+        validate_presence :vname, :cf, :format
+
+        @data[:grpint] ||= false
+
+        chunks = []
+
+        if @data.key?(:gprint) && @data[:gprint] == true
+          chunks << 'GPRINT'
+        else
+          chunks << 'PRINT'
+        end
+
+        chunks << @data[:vname]
+        chunks << @data[:cf]
+        chunks << @data[:format]
+        chunks << @data[:strftime] if @data.key?(:strftime)
+
+        chunks.join ':'
+      end
+    end
+  end
+end

data/lib/prrd/graph/shift.rb

@@ -0,0 +1,30 @@
+# File: shift.rb
+# Time-stamp: <2014-10-01 21:17:51 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Shift class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Shift Line class
+    class Shift < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :vname,
+          :offset
+        ]
+
+        super values
+      end
+
+      # Transform to a SHIFT formatted string
+      def to_s
+        fail 'Empty shift object' if @data.empty?
+
+        validate_presence :vname, :offset
+
+        "SHIFT:%s:%s" % [@data[:vname], @data[:offset]]
+      end
+    end
+  end
+end

data/lib/prrd/graph/textalign.rb

@@ -0,0 +1,32 @@
+# File: textalign.rb
+# Time-stamp: <2014-10-01 21:18:12 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Textalign class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Textalign Line class
+    class Textalign < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :orientation
+        ]
+
+        super values
+      end
+
+      # Transform to a TEXTALIGN formatted string
+      def to_s
+        fail 'Empty textalign object' if @data.empty?
+
+        validate_presence :orientation
+        unless ['left', 'right', 'justified', 'center'].include? @data[:orientation].to_s
+          fail 'Orientation option muts be: left|right|justified|center'
+        end
+
+        "TEXTALIGN:\"%s\"" % @data[:orientation]
+      end
+    end
+  end
+end

data/lib/prrd/graph/vrule.rb

@@ -0,0 +1,51 @@
+# File: vrule.rb
+# Time-stamp: <2014-10-01 21:19:19 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Hrul class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Graph Vrule class
+    class Vrule < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :time,
+          :color,
+          :legend,
+          :dashes,
+          :dashes_offset
+        ]
+
+        super values
+      end
+
+      # Transform to a VRULE formatted string
+      def to_s
+        fail 'Empty vrule object' if @data.empty?
+
+        validate_presence :time, :color
+
+        chunks = []
+
+        @keys.each do |k|
+          next unless @data.key?(k)
+          case k
+          when :time
+            chunks << "VRULE:%s%s" % [@data[k], @data[:color]]
+          when :color
+            # nope
+          when :dashes
+            chunks << "dashes=\"%s\"" % @data[k]
+          when :dashes_offset
+            chunks << "dashes-offset=\"%s\"" % @data[k]
+          else
+            chunks << @data[k]
+          end
+        end
+
+        chunks.join ':'
+      end
+    end
+  end
+end

data/prrd.gemspec

@@ -0,0 +1,23 @@
+# File: prrd.gemspec
+# Time-stamp: <2015-07-13 10:48:12>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: rrdtool ruby interface
+
+require File.expand_path('../lib/prrd', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name              = 'prrd'
+  gem.require_paths     = ['lib']
+  gem.version           = PRRD::VERSION
+  gem.files             =
+    %w(README.md Gemfile Rakefile showcase.rb prrd.gemspec) +
+    `git ls-files lib spec`.split("\n")
+
+  gem.authors           = ['Pierre Lecocq']
+  gem.email             = ['pierre.lecocq@gmail.com']
+  gem.summary           = 'rrdtool ruby interface'
+  gem.description       = 'Graph your system with rrdtool in ruby'
+  gem.homepage          = 'https://github.com/pierre-lecocq/prrd'
+  gem.date              = Date.today.to_s
+  gem.license           = 'MIT'
+end

data/showcase.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+# File: showcase.rb
+# Time-stamp: <2014-10-01 22:42:11 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Showcase
+
+require_relative 'lib/prrd'
+
+create = false
+
+PRRD.activate_debug_mode
+
+dbpath = '/home/pierre/rrd/showcase.rrd'
+imgpath = '/home/pierre/rrd/showcase.png'
+start_ts = Time.now.to_i - 86_400
+
+if create
+  begin
+    File.delete dbpath, imgpath
+  rescue Exception
+    puts 'Nothing to delete, but we do not care'
+  end
+end
+
+# Db :: init
+
+database = PRRD::Database.new({path: dbpath, start: start_ts, step: 300})
+
+if create
+
+  database.add_datasources [
+    PRRD::Database::Datasource.new({name: 'ds1', type: 'GAUGE', heartbeat: 600, min: 0, max: 'U'}),
+    PRRD::Database::Datasource.new({name: 'ds2', type: 'GAUGE', heartbeat: 600, min: 0, max: 'U'}),
+    PRRD::Database::Datasource.new({name: 'ds3', type: 'GAUGE', heartbeat: 600, min: 0, max: 'U'})
+  ]
+
+  database.add_archives [
+    PRRD::Database::Archive.new({cf: 'AVERAGE', xff: 0.5, steps: 1, rows: 576}),
+    PRRD::Database::Archive.new({cf: 'AVERAGE', xff: 0.5, steps: 6, rows: 672}),
+    PRRD::Database::Archive.new({cf: 'AVERAGE', xff: 0.5, steps: 24, rows: 732}),
+    PRRD::Database::Archive.new({cf: 'AVERAGE', xff: 0.5, steps: 144, rows: 1460})
+  ]
+
+  database.create
+
+  # Db :: update
+
+  now_ts = Time.now.to_i
+  update_ts = start_ts + 1
+  while update_ts < now_ts
+    value1 = Random.rand(200)
+    value2 = Random.rand(80)
+    value3 = Random.rand(150)
+
+    database.update update_ts, value1, value2, value3
+
+    update_ts += 1
+  end
+
+end
+
+# Graph :: init
+
+graph = PRRD::Graph.new({path: imgpath, database: database, width: 1024, height: 768, title: 'Showcase', lower_limit: 0, upper_limit: 200})
+
+graph.add_colors [
+  PRRD::Graph::Color.new({colortag: 'BACK', color: '#222222'}),
+  PRRD::Graph::Color.new({colortag: 'FONT', color: '#777777'}),
+  PRRD::Graph::Color.new({colortag: 'CANVAS', color: '#222222'}),
+  PRRD::Graph::Color.new({colortag: 'ARROW', color: '#00ff00'}),
+  PRRD::Graph::Color.new({colortag: 'GRID', color: '#444444'}),
+  PRRD::Graph::Color.new({colortag: 'MGRID', color: '#333333'}),
+]
+
+graph.add_definitions [
+  PRRD::Graph::Definition.new({vname: 'ds1', rrdfile: database.path, ds_name: 'ds1', cf: 'AVERAGE'}),
+  PRRD::Graph::Definition.new({vname: 'ds2', rrdfile: database.path, ds_name: 'ds2', cf: 'AVERAGE'}),
+  PRRD::Graph::Definition.new({vname: 'ds3', rrdfile: database.path, ds_name: 'ds3', cf: 'AVERAGE'})
+]
+
+graph.add_comment PRRD::Graph::Comment.new({text: "This is a comment"})
+
+graph.add_print PRRD::Graph::Print.new({gprint: true, vname: 'ds1', cf: 'AVERAGE', format: "%3.3le"})
+graph.add_print PRRD::Graph::Print.new({gprint: true, vname: 'ds2', cf: 'AVERAGE', format: "%3.3le"})
+
+color1 = PRRD::Color.new(:blue)
+color2 = PRRD::Color.new(:blue, :dark)
+color3 = PRRD::Color.new(:red)
+
+graph.add_areas [
+  PRRD::Graph::Area.new({value: 'ds1', color: color1, legend: 'Ds1'}),
+  PRRD::Graph::Area.new({value: 'ds2', color: color2, legend: 'Ds2'})
+]
+
+graph.add_lines [
+  PRRD::Graph::Line.new({width: 1, value: 'ds1', color: color1.lighten(50), legend: 'Ds1'}),
+  PRRD::Graph::Line.new({width: 1, value: 'ds2', color: color2.lighten(50), legend: 'Ds2'}),
+  PRRD::Graph::Line.new({width: 2, value: 'ds3', color: color3, legend: 'Ds3'})
+]
+
+# Graph :: Generate
+
+graph.generate

data/spec/prrd_spec.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# File: prrd_spec.rb
+# Time-stamp: <2014-09-22 22:44:14 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: PRRD spec file
+
+require_relative '../lib/prrd'
+describe PRRD do
+  describe 'VERSION' do
+    it 'should return 0.2.0' do
+      expect(PRRD::VERSION).to eql '0.2.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: prrd
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Pierre Lecocq
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies: []
+description: Graph your system with rrdtool in ruby
+email:
+- pierre.lecocq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Gemfile
+- Rakefile
+- showcase.rb
+- prrd.gemspec
+- lib/prrd.rb
+- lib/prrd/database.rb
+- lib/prrd/database/archive.rb
+- lib/prrd/database/datasource.rb
+- lib/prrd/graph.rb
+- lib/prrd/graph/area.rb
+- lib/prrd/graph/colors.rb
+- lib/prrd/graph/comment.rb
+- lib/prrd/graph/definition.rb
+- lib/prrd/graph/hrule.rb
+- lib/prrd/graph/line.rb
+- lib/prrd/graph/print.rb
+- lib/prrd/graph/shift.rb
+- lib/prrd/graph/textalign.rb
+- lib/prrd/graph/vrule.rb
+- spec/prrd_spec.rb
+homepage: https://github.com/pierre-lecocq/prrd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: rrdtool ruby interface
+test_files: []