oml4r 2.9.0.2 → 2.9.1

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+.project

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright 2009-2012 National ICT Australia (NICTA), Australia
+Copyright 2009-2013 National ICT Australia (NICTA), Australia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -31,42 +31,50 @@ Usage
 
 ### Initialisation, Injection and Tear-down
 
-    OML4R::init(ARGV, {
+    OML4R::init(ARGV, 
     	:appName => 'oml4rSimpleExample',
-    	:expID => 'foo',
+    	:domain => 'foo', 
     	:nodeID => 'n1',
-    	:omlServer => 'file:-'}
     )
-    MyMP.inject("hello", 13, 37.)
+    MyMP.inject("hello", 13, 37.1)
     OML4R::close()
+    
+### Multiple Channels
 
-### Real example
-
-See examples files oml4r-simple-example.rb and oml4r-wlanconfig.rb.
+It is sometimes desirable to send different measurement points to different collectors. OML4R supports
+this with the 'channel' abstraction.
 
+    class A_MP < OML4R::MPBase
+      name :a
+      channel :default
+    
+      param :a_val, :type => :int32
+    end
 
-License
--------
+    class B_MP < OML4R::MPBase
+      name :b
+      channel :archive
+      channel :default
+    
+      param :b_val, :type => :int32
+    end
+    
+    OML4R::init(ARGV, 
+      :appName => 'doubleAgent',
+      :domain => 'foo' 
+    )
+    OML4R::create_channel(:archive, 'file:/tmp/archive.log')    
 
-Copyright 2009-2012 National ICT Australia (NICTA), Australia
+Setting the command line flag '--oml-collect' will define a ':default' channel. Any additional channels
+need to be declared with 'OML4R::create_channel' which takes two arguments, the name of the channel
+and the destination for the measurement stream. The above example defines an 'archive' channel
+which is being collected in the local '/tmp/archive.log' file.
 
-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:
+Please note that by declaring a specific channel, every MP needs at least one channel declaration.
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+### Real example
 
-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.
+See examples files oml4r-simple-example.rb and oml4r-wlanconfig.rb.
 
 [oml-text]: http://oml.mytestbed.net/projects/oml/wiki/Description_of_Text_protocol
 [oml4r-rubygem]: https://rubygems.org/gems/oml4r/

data/examples/oml4r-simple-example.rb

@@ -0,0 +1,60 @@
+# Copyright (c) 2009 - 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+# ------------------
+#
+# = oml4r-simple-example.rb
+#
+# == Description
+#
+# A very simple straightforward example of OML4R.
+#
+require 'rubygems'
+require 'oml4r'
+
+# Define your own Measurement Points
+class SinMP < OML4R::MPBase
+  name :sin
+  #channel :default
+
+  param :label
+  param :angle, :type => :int32
+  param :value, :type => :double
+end
+
+class CosMP < OML4R::MPBase
+  name :cos
+  # channel :ch1
+  # channel :default
+
+  param :label
+  param :value, :type => :double
+end
+
+# Initialise the OML4R module for your application
+opts = {:appName => 'oml4rSimpleExample',
+  :domain => 'foo',
+  :collect => 'file:-'} # Server could also be tcp:host:port
+#  
+#OML4R::create_channel(:ch1, 'file:/tmp/foo.log')    
+
+begin
+  OML4R::init(ARGV, opts)
+rescue OML4R::MissingArgumentException => mex
+  $stderr.puts mex
+  exit
+end
+
+# Now collect and inject some measurements
+500.times do |i|
+  sleep 0.5
+  angle = 15 * i
+  SinMP.inject("label_#{angle}", angle, Math.sin(angle))
+  CosMP.inject("label_#{angle}", Math.cos(angle))    
+end
+
+# Don't forget to close when you are finished
+OML4R::close()
+
+# vim: sw=2

data/{lib/oml4r → examples}/oml4r-wlanconfig.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2010-2012 National ICT Australia (NICTA), Australia
+# Copyright (c) 2010-2013 National ICT Australia (NICTA), Australia
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -30,6 +30,7 @@
 # its output (= measurements), and finally pass them to OML4R, which will in 
 # turn either store them in a local file or forward them to the OML Server.
 #
+require "rubygems"
 require "oml4r"
 
 APPNAME = "wlanconfig"

data/examples/oml4r-zabbix.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+# example script that reads CPU load measurements from a Zabbix server
+# and pushes them into an OML database
+
+# make sure you install these two gems
+require "zabbixapi"
+require "oml4r"
+
+# # Zabbix node names
+# nodes = ["10.129.16.11", "10.129.16.12", "10.129.16.13"]
+
+# Define your own Measurement Point
+class CPU_MP < OML4R::MPBase
+  name :CPU
+  param :ts, :type => :string  
+  param :node, :type => :string    
+  param :load1, :type => :double
+  param :load5, :type => :double
+  param :load15, :type => :double 
+end
+
+
+# Initialise the OML4R module for your application
+oml_opts = {
+  :appName => 'zabbix',
+  :domain => 'zabbix-cpu-measurement', 
+  :nodeID => 'cloud',
+  :collect => 'file:-'
+}
+zabbix_opts = {
+  :url => 'http://cloud.npc.nicta.com.au/zabbix/api_jsonrpc.php',
+  :user => 'Admin',
+  :password => 'zabbix'
+}
+
+interval = 1
+
+nodes = OML4R::init(ARGV, oml_opts) do |op|
+  op.banner = "Usage: #{$0} [options] host1 host2 ...\n"
+
+  op.on( '-i', '--interval SEC', "Query interval in seconds [#{interval}]" ) do |i|
+    interval = i.to_i
+  end
+  op.on( '-s', '--service-url URL', "Zabbix service url [#{zabbix_opts[:url]}]" ) do |u|
+    zabbix_opts[:url] = p
+  end
+  op.on( '-p', '--password PW', "Zabbix password [#{zabbix_opts[:password]}]" ) do |p|
+    zabbix_opts[:password] = p
+  end
+  op.on( '-u', '--user USER', "Zabbix user name [#{zabbix_opts[:user]}]" ) do |u|
+    zabbix_opts[:user] = u
+  end
+end
+if nodes.empty?
+  OML4R.logger.error "Missing host list"
+  OML4R::close()
+  exit(-1)
+end
+
+# connect to Zabbix JSON API
+zbx = ZabbixApi.connect(zabbix_opts)
+
+# catch CTRL-C
+exit_requested = false
+Kernel.trap( "INT" ) { exit_requested = true }
+
+# poll Zabbix API
+while !exit_requested
+  nodes.each{|n|
+    # https://www.zabbix.com/documentation/2.0/manual/appendix/api/item/get
+    results = zbx.query(
+      :method => "item.get",
+      :params => {
+        :output => "extend",
+        :host => "#{n}",
+        # only interested in CPU load
+        :search => {
+          :name => "Processor load"
+        }
+      }
+    )
+    unless results.empty?
+      l15 = results[0]["lastvalue"]
+      l1 = results[1]["lastvalue"]
+      l5 = results[2]["lastvalue"]
+      #puts "Injecting values #{l1}, #{l5}, #{l15} for node #{n}"
+      # injecting measurements into OML
+      CPU_MP.inject(Time.now.to_s, n, l1, l5, l15)
+    else
+      OML4R.logger.warn "Empty result usually means misspelled host address"
+    end
+  }
+  sleep interval
+end
+
+OML4R::close()
+puts "Exiting"

data/examples/test_types.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2009 - 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+# ------------------
+#
+# = test_types.rb
+#
+# == Description
+#
+# Testing blobs and long strings. Should really go into a test suite.
+#
+require 'rubygems'
+require 'oml4r'
+
+# Define your own Measurement Points
+class TestMP < OML4R::MPBase
+  name :test
+  #channel :default
+
+  param :text
+  param :blob, :type => :blob
+end
+
+# Initialise the OML4R module for your application
+opts = {:appName => 'test_types',
+  :domain => 'foo', :nodeID => 'n1',
+  :collect => 'file:-'} 
+
+OML4R::init(ARGV, opts)
+
+# Now collect and inject some measurements
+blob = ""
+30.times {|i| blob << i}
+TestMP.inject(%{tab new line
+another two
+
+and that's it}, blob)
+
+# Don't forget to close when you are finished
+OML4R::close()
+
+# vim: sw=2

data/lib/oml4r/benchmark.rb

@@ -0,0 +1,240 @@
+# Copyright (c) 2013 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+# ------------------
+#
+# = benchmark.rb
+#
+# == Description
+#
+# Provides convenience functions to monitor long running services and 
+# report performance metrics through OML
+#
+require 'oml4r'
+
+module OML4R
+  #
+  # Monitor the CPU consumption of a block and report it to 
+  # OML
+  #
+  class Benchmark
+
+    def self.bm(label, opts = {}, &block) 
+      inst = self.new(label, opts)
+      inst.measure(&block) if block
+      inst
+    end
+
+    # Measure execution of 'block'. Benchmarking is assumed
+    # to be finished when block finished. Don't attempt to 
+    # call again
+    #
+    def measure(&block)
+      raise "Missing block" unless block
+      start
+      block.arity == 0 ? block.call() : block.call(self)
+      _stop
+    end
+
+    # Execute block and add execution time to overall 
+    # measurements. Can be called multiple time. Need
+    # to finally call '#stop' to report overall stats.
+    #
+    def task(&block)
+      raise "Missing block" unless block
+      resume
+      block.arity == 0 ? block.call() : block.call(self)
+      pause
+    end
+
+    def start()
+      @lock.synchronize do
+        raise "Don't call this directly" if @running
+        @running = true
+      end
+
+      if @monitor_interval > 0
+        Thread.new do
+          while @running 
+            sleep @monitor_interval
+            _report()
+          end
+        end
+      end
+      @t0, r0 = Process.times, Time.now
+      @t1 = @t0
+      @r1 = @r0 = r0.to_f
+    end
+
+    def pause()
+      t, r = Process.times, Time.now
+      @lock.synchronize do
+       return unless @running
+        return if @paused
+        @paused = true
+
+        @paused_t = t
+        @paused_r = r.to_f
+      end
+    end
+
+    def resume()
+      @lock.synchronize do
+        unless @running
+          # hasn't been kicked off yet
+          start
+          return
+        end
+
+        return unless @paused
+        t, r = Process.times, Time.now
+        off_u = t.utime - @paused_t.utime
+        off_s = t.stime - @paused_t.stime
+        off_t = r.to_f - @paused_r
+        @t0 = Struct::Tms.new(@t0.utime + off_u, @t0.stime + off_s)
+        @r0 = @r0 + off_t
+        if @t1
+          @t1 = Struct::Tms.new(@t1.utime + off_u, @t1.stime + off_s)
+          @r1 = @r1 + off_t
+        end
+        @paused = false
+      end
+    end
+
+    def stop
+      @lock.synchronize do
+        return unless @running
+      end
+      _stop
+    end
+
+    # Push out an intermediate report. Does
+    # nothing if already finished.
+    #
+    # NOTE: Not thread safe
+    #
+    def report(label = nil)
+      return unless @running
+      _report(label)
+    end
+
+    # Report a step in the processing. Used to calculate a
+    # progress rate
+    #
+    # NOTE: Not thread safe
+    #
+    def step(cnt = 1)
+      @step_cnt += cnt
+    end
+
+    private
+
+    class BenchmarkMP < OML4R::MPBase
+      name :benchmark
+      #channel :default
+
+      param :label
+      param :note
+      param :is_absolute, :type => :boolean
+      param :is_final, :type => :boolean
+      param :step_cnt, :type => :int32
+      param :rate_real, :type => :double
+      param :rate_usys, :type => :double
+      param :time_wall, :type => :double
+      param :time_user, :type => :double
+      param :time_sys, :type => :double
+    end
+
+    def initialize(name, opts)
+      @name = name
+      @running = false
+      @paused = false
+
+      @monitor_interval = opts[:periodic] || -1
+      @step_cnt = 0
+      @step_cnt1 = 0
+
+      @lock = Monitor.new
+      @first_report = true
+    end
+
+    def _stop
+      _report('done', true)
+      @lock.synchronize do
+        @running = false
+      end
+    end
+
+    def _report(label = '-', is_final = false)
+      t, r = Process.times, Time.now
+      @lock.synchronize do
+        if @paused
+          # report ONCE while paused
+          return if @paused_r == @last_paused_r
+          @last_paused_r = @paused_r
+          t = @paused_t
+          r = @paused_r
+        end
+        r = r.to_f
+        _inject(label, true, is_final, t, r, @t0, @r0, @step_cnt)
+        unless (is_final && @first_report)
+          # don't report incremental on final if this would be the first incr
+          _inject(label, false, is_final, t, r, @t1, @r1, @step_cnt - @step_cnt1)
+        end
+        @t1 = t
+        @r1 = r
+        @step_cnt1 = @step_cnt
+        @first_report = false
+      end
+    end
+
+    def _inject(label, is_absolute, is_final, t1, r1, t0, r0, step_cnt)
+      d_u = t1.utime - t0.utime
+      d_s = t1.stime - t0.stime
+      d_t = r1 - r0
+      #puts "INJECT0 #{d_u} #{d_s} #{d_t}"
+      return if (d_t <= 0 || (d_s + d_u) <= 0)
+      BenchmarkMP.inject @name, label, is_absolute, is_final, step_cnt, step_cnt / d_t, step_cnt / (d_u + d_s), d_t, d_u, d_s
+    end
+  end
+end
+
+if __FILE__ == $0
+  opts = {
+    :appName => 'bm_test',
+    :domain => 'foo', 
+    :nodeID => 'n1',
+    :collect => 'file:-'
+  } 
+  OML4R::init(ARGV, opts)
+
+  bm_i = OML4R::Benchmark.bm('inner_test', periodic: 0.1)
+  OML4R::Benchmark.bm('test', periodic: 0.1) do |bm|
+    20.times do |i|
+      10.times do
+        "a" * 1_000_000
+        bm.step
+      end
+
+      bm_i.task do
+        10.times do
+          "a" * 1_000_000
+          bm_i.step
+        end
+      end
+
+      sleep 0.02
+      if i == 10
+        bm.pause
+        sleep 2
+        bm.resume
+      end
+      #bm.report()
+    end
+  end
+  bm_i.stop
+  OML4R::close()
+  puts 'done'
+end
+

data/lib/oml4r/version.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2009 - 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+# ------------------
+
+module OML4R
+  VERSION = "2.9.1"
+  VERSION_STRING = "OML4R Client V#{VERSION}"
+  COPYRIGHT = "Copyright 2009-2013, NICTA"
+end

data/lib/oml4r.rb

@@ -1,24 +1,8 @@
-#
-# Copyright 2009-2012 National ICT Australia (NICTA), Australia
-#
-# 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.
-#
+# Copyright (c) 2009 - 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+# ------------------
 #
 # = oml4r.rb
 #
@@ -34,21 +18,28 @@ require 'monitor'
 require 'thread'
 require 'optparse'
 
+require 'oml4r/version'
+
 #
 # This is the OML4R module, which should be required by ruby applications
 # that want to collect measurements via OML
 #
 module OML4R
 
-  VERSION = "2.9.0.2"
-  VERSION_STRING = "OML4R Client V#{VERSION}"
-  COPYRIGHT = "Copyright 2009-2012, NICTA"
   DEF_SERVER_PORT = 3003
+  DEF_PROTOCOL = 3
 
-  PROTOCOL = 3
-  @loglevel = 0
-  class << self; attr_accessor :loglevel; end
-
+  # Overwrite the default logger
+  #
+  # @param logger Needs to respond to 'debug', 'info', ...
+  #
+  def self.logger=(logger)
+    @@logger = logger
+  end
+  
+  class OML4RExeption < Exception; end
+  class MissingArgumentException < OML4RExeption; end
+  class ArgumentMismatchException < OML4RExeption; end
   #
   # Measurement Point Class
   # Ruby applications using this module should sub-class this MPBase class
@@ -77,9 +68,9 @@ module OML4R
     # Returns the definition of this MP
     def self.__def__()
       unless (defs = @@defs[self])
-	defs = @@defs[self] = {}
-	defs[:p_def] = []
-	defs[:seq_no] = 0
+        defs = @@defs[self] = {}
+        defs[:p_def] = []
+        defs[:seq_no] = 0
       end
       defs
     end
@@ -105,9 +96,12 @@ module OML4R
       o = opts.dup
       o[:name] = name
       o[:type] ||= :string
-      if o[:type] == :long
-	$stderr.puts "WARN	:long is deprecated use, :int32 instead"
-	o[:type] = :int32
+      case o[:type] 
+      when :long
+        OML4R.logger.warn ":long is deprecated use, :int32 instead"
+        o[:type] = :int32
+      when :boolean
+        o[:type] = :int32  # TODO: Hopefully we can remove this soon
       end
       __def__()[:p_def] << o
       nil
@@ -124,23 +118,34 @@ module OML4R
       # definition of this Measurement Point
       defs = __def__()
       pdef = defs[:p_def]
+      types = defs[:types]
       if args.size != pdef.size
-	raise "OML4R: Size mismatch between the measurement (#{args.size}) and the MP definition (#{pdef.size})!"
+        raise ArgumentMismatchException.new "OML4R: Size mismatch between the measurement (#{args.size}) and the MP definition (#{pdef.size})!"
       end
 
       # Now prepare the measurement...
       t = Time.now - @@start_time
       a = []
       a << (defs[:seq_no] += 1)
-      args.each do |arg|
-	a << arg
+      args.each_with_index do |arg, i|
+        case types[i]
+        when :string
+          # Escape tabs and newlines
+          arg = arg.to_s.gsub("\n", "\\n").gsub("\t", "\\t")
+        when :boolean
+          # boolean
+          arg = arg ? 1 : 0
+        when :blob
+          arg = [arg].pack("m")
+        end
+        a << arg
       end
       # ...and inject it!
       msg = a.join("\t")
       @@channels[self].each do |ca|
-	channel = ca[0]
-	index = ca[1]
-	channel.send "#{t}\t#{index}\t#{msg}"
+        channel = ca[0]
+        index = ca[1]
+        channel.send "#{t}\t#{index}\t#{msg}"
       end
       args
     end
@@ -154,24 +159,28 @@ module OML4R
     def self.__freeze__(appName, start_time)
       return if @@frozen
       @@frozen = true
+      # create type array for easier processing in inject
+      @@defs.each do |name, descr|
+        descr[:types] = descr[:p_def].map {|h| h[:type]}
+      end
+
       # replace channel names with channel object
       self.each_mp do |klass, defs|
-	cna = @@channels[klass] || []
-	$stderr.puts "DEBUG	'#{cna.inspect}', '#{klass}'" if OML4R.loglevel > 0
-	ca = cna.collect do |cname, domain|
-	  # return it in an array as we need to add the channel specific index
-	  [Channel[cname.to_sym, domain.to_sym]]
-	end
-	$stderr.puts "DEBUG	Using channels '#{ca.inspect}" if OML4R.loglevel > 0
-	@@channels[klass] = ca.empty? ? [[Channel[]]] : ca
+        cna = @@channels[klass] || []
+        OML4R.logger.debug "'#{cna.inspect}', '#{klass}'"
+        ca = cna.collect do |cname, domain|
+          # return it in an array as we need to add the channel specific index
+          [Channel[cname.to_sym, domain.to_sym]]
+        end
+        OML4R.logger.debug "Using channels '#{ca.inspect}"
+        @@channels[klass] = ca.empty? ? [[Channel[]]] : ca
       end
       @@start_time = start_time
-
     end
 
     def self.__unfreeze__()
       self.each_mp do |klass, defs|
-	defs[:seq_no] = 0
+        defs[:seq_no] = 0
       end
       @@channels = {}
       @@start_time = nil
@@ -186,16 +195,16 @@ module OML4R
 
       # Do some sanity checks...
       unless (mp_name = defs[:name])
-	raise "Missing 'name' declaration for '#{self}'"
+        raise MissingArgumentException.new "Missing 'name' declaration for '#{self}'"
       end
       unless (name_prefix.nil?)
-	mp_name = "#{name_prefix}_#{mp_name}"
+        mp_name = "#{name_prefix}_#{mp_name}"
       end
 
       @@channels[self].each do |ca|
-	$stderr.puts "DEBUG	Setting up channel '#{ca.inspect}" if OML4R.loglevel > 0
-	index = ca[0].send_schema(mp_name, defs[:p_def])
-	ca << index
+        OML4R.logger.debug "Setting up channel '#{ca.inspect}"
+        index = ca[0].send_schema(mp_name, defs[:p_def])
+        ca << index
       end
     end
   end # class MPBase
@@ -215,12 +224,12 @@ module OML4R
   # - & block = a block which defines the additional application-specific arguments
   #
   def self.init(argv, opts = {}, &block)
-    $stderr.puts("INFO	#{VERSION_STRING} [Protocol V#{PROTOCOL}] #{COPYRIGHT}")
+    OML4R#{VERSION_STRING} [#{COPYRIGHT}")
 
     if d = (ENV['OML_EXP_ID'] || opts[:expID])
       # XXX: It is still too early to complain about that. We need to be sure
       # of the nomenclature before making user-visible changes.
-      $stderr.puts "WARN	opts[:expID] and ENV['OML_EXP_ID'] are getting deprecated; please use opts[:domain] or ENV['OML_DOMAIN']  instead"
+      OML4R.logger.warn "opts[:expID] and ENV['OML_EXP_ID'] are getting deprecated; please use opts[:domain] or ENV['OML_DOMAIN']  instead"
       opts[:domain] ||= d
     end
     domain ||= ENV['OML_DOMAIN'] || opts[:domain]
@@ -237,16 +246,17 @@ module OML4R
     #  raise 'OML4R: :app is not a valid option. Do you mean :appName?'
     #end
     appName = opts[:appName] || opts[:app]
+    protocol = opts[:protocol] = DEF_PROTOCOL
 
     if  ENV['OML_URL'] || opts[:omlURL] || opts[:url]
-      raise 'ERROR	neither OML_URL, :omlURL nor :url are valid. Do you mean OML_COLLECT or :omlCollect?'
+      raise MissingArgumentException.new 'neither OML_URL, :omlURL nor :url are valid. Do you mean OML_COLLECT or :omlCollect?'
     end
     if ENV['OML_SERVER'] || opts[:omlServer]
-	$stderr.puts "WARN	opts[:omlServer] and ENV['OML_SERVER'] are getting deprecated; please use opts[:collect] or ENV['OML_COLLECT'] instead"
+        OML4R.logger.warn "opts[:omlServer] and ENV['OML_SERVER'] are getting deprecated; please use opts[:collect] or ENV['OML_COLLECT'] instead"
     end
     omlCollectUri = ENV['OML_COLLECT'] || ENV['OML_SERVER'] || opts[:collect] || opts[:omlServer]
     noop = opts[:noop] || false
-    omlConfigFile = nil
+
 
     # Create a new Parser for the command line
     op = OptionParser.new
@@ -256,61 +266,69 @@ module OML4R
     op.on("--oml-id id", "Name to identify this app instance [#{nodeID || 'undefined'}]") { |name| nodeID = name }
     op.on("--oml-domain domain", "Name of experimental domain [#{domain || 'undefined'}] *EXPERIMENTAL*") { |name| domain = name }
     op.on("--oml-collect uri", "URI of server to send measurements to") { |u|  omlCollectUri = u }
-    op.on("--oml-log-level l", "Log level used (info: 0 .. debug: 1)") { |l| OML4R.loglevel = l.to_i }
+    op.on("--oml-protocol p", "Protocol number [#{OML4R::DEF_PROTOCOL}]") { |l| protocol = l.to_i }
+    op.on("--oml-log-level l", "Log level used (info: 1 .. debug: 0)") { |l| OML4R.logger.level = l.to_i }
     op.on("--oml-noop", "Do not collect measurements") { noop = true }
-    op.on("--oml-config file", "File holding OML configuration parameters") { |f| omlConfigFile = f }
     op.on("--oml-exp-id domain", "Obsolescent equivalent to --oml-domain domain") { |name|
       domain = name
-      $stderr.puts "WARN	Option --oml-exp-id is getting deprecated; please use '--oml-domain #{domain}' instead"
+      OML4R.logger.warn "Option --oml-exp-id is getting deprecated; please use '--oml-domain #{domain}' instead"
     }
     op.on("--oml-file localPath", "Obsolescent equivalent to --oml-collect file:localPath") { |name|
       omlCollectUri = "file:#{name}"
-      $stderr.puts "WARN	Option --oml-file is getting deprecated; please use '--oml-collect #{omlCollectUri}' instead"
+      OML4R.logger.warn "Option --oml-file is getting deprecated; please use '--oml-collect #{omlCollectUri}' instead"
     }
     op.on("--oml-server uri", "Obsolescent equivalent to --oml-collect uri") {|u|
       omlCollectUri = u
-      $stderr.puts "WARN	Option --oml-server is getting deprecated; please use '--oml-collect #{omlCollectUri}' instead"
+      OML4R.logger.warn "Option --oml-server is getting deprecated; please use '--oml-collect #{omlCollectUri}' instead"
     }
     op.on_tail("--oml-help", "Show this message") { $stderr.puts op; exit }
     # XXX: This should be set by the application writer, not the command line
     #op.on("--oml-appid APPID", "Application ID for OML [#{appName || 'undefined'}] *EXPERIMENTAL*") { |name| appID = name }
 
-    # Set a default collection URI if nothing has been specified
-    omlCollectUri ||= "file:#{appName}_#{nodeID}_#{domain}_#{Time.now.strftime("%Y-%m-%dt%H.%M.%S%z")}"
-
     # Now parse the command line
-    $stderr.puts "DEBUG	ARGV:>>> #{argv.inspect}" if OML4R.loglevel > 0
+    OML4R.logger.debug "ARGV:>>> #{argv.inspect}"
     rest = op.parse(argv)
     return if noop
 
-    # Parameters in OML config file takes precedence
-    unless omlConfigFile.nil? 
-      f = File.open(omlConfigFile, 'r')
-      f.each_line do |l|
-        d = l[/.*experiment='([^']*)/,1]
-        domain = d if d
-        i = l[/.*id='([^']*)/,1]
-        nodeID = i if i
-        u = l[/.*url='([^']*)/,1]
-        omlCollectUri = u if u
+    unless nodeID
+      begin
+        # Create a default nodeID by concatinating the local hostname with the process ID
+        hostname = nil
+        begin 
+          hostname = Socket.gethostbyname(Socket.gethostname)[0]
+        rescue Exception 
+          begin
+            hostname = `hostname`
+          rescue Exception; end           
         end
-      f.close
+        if hostname
+          nodeID = "#{hostname}-#{Process.pid}"
+        end
+      end
+      unless nodeID
+        raise MissingArgumentException.new 'OML4R: Missing values for parameter :nodeID (--oml-id)'        
+      end
     end
-
-    unless domain && nodeID && appName
-      raise 'OML4R: Missing values for parameters :domain (--oml-domain), :nodeID (--oml-id), or :appName (in code)!'
+    
+    unless domain && appName
+      raise MissingArgumentException.new 'OML4R: Missing values for parameters :domain (--oml-domain), :nodeID (--oml-id), or :appName (in code)!'
     end
 
-    Channel.create(:default, omlCollectUri) if omlCollectUri
+    # Set a default collection URI if nothing has been specified
+    omlCollectUri ||= "file:#{appName}_#{nodeID}_#{domain}_#{Time.now.strftime("%Y-%m-%dt%H.%M.%S%z")}"
+
+    create_channel(:default, omlCollectUri) if omlCollectUri
 
     # Handle the defined Measurement Points
     startTime = Time.now
-    Channel.init_all(domain, nodeID, appName, startTime)
-    msg = "Collection URI is #{omlCollectUri}"
-    Object.const_defined?(:MObject) ? MObject.debug(:oml4r, msg) : $stderr.puts("INFO	#{msg}")
-
+    Channel.init_all(domain, nodeID, appName, startTime, protocol)
+    OML4R.logger.info "Collection URI is #{omlCollectUri}"
     rest || []
   end
+  
+  def self.create_channel(name, url)
+    Channel.create(name, url)
+  end
 
   #
   # Close the OML collection. This will block until all outstanding data have been sent out.
@@ -330,14 +348,16 @@ module OML4R
   class Channel
     @@channels = {}
     @@default_domain = nil
+    
+    
 
     def self.create(name, url, domain = :default)
       key = "#{name}:#{domain}"
       if channel = @@channels[key]
-	if url != channel.url
-	  raise "OML4R: Channel '#{name}' already defined with different url"
-	end
-	return channel
+        if url != channel.url
+          raise OML4RException.new "OML4R: Channel '#{name}' already defined with different url"
+        end
+        return channel
       end
       return self._create(key, domain, url)
     end
@@ -349,15 +369,15 @@ module OML4R
 
     def self._connect(url)
       if url.start_with? 'file:'
-	proto, fname = url.split(':')
-	out = (fname == '-' ? $stdout : File.open(fname, "w+"))
+        proto, fname = url.split(':')
+        out = (fname == '-' ? $stdout : File.open(fname, "w+"))
       elsif url.start_with? 'tcp:'
-	#tcp:norbit.npc.nicta.com.au:3003
-	proto, host, port = url.split(':')
-	port ||= DEF_SERVER_PORT
-	out = TCPSocket.new(host, port)
+        #tcp:norbit.npc.nicta.com.au:3003
+        proto, host, port = url.split(':')
+        port ||= DEF_SERVER_PORT
+        out = TCPSocket.new(host, port)
       else
-	raise "OML4R: Unknown transport in server url '#{url}'"
+        raise OML4RException.new "OML4R: Unknown transport in server url '#{url}'"
       end
       out
     end
@@ -365,28 +385,28 @@ module OML4R
     def self.[](name = :default, domain = :default)
       key = "#{name}:#{domain}"
       unless (@@channels.key?(key))
-	# If domain != :default and we have one for :default, create a new one
-	if (domain != :default)
-	  if (dc = @@channels["#{name}:default"])
-	    return self._create(key, domain, dc.url)
-	  end
-	end
-	raise "OML4R: Unknown channel '#{name}'"
+        # If domain != :default and we have one for :default, create a new one
+        if (domain != :default)
+          if (dc = @@channels["#{name}:default"])
+            return self._create(key, domain, dc.url)
+          end
+        end
+        raise OML4RException.new "OML4R: Unknown channel '#{name}'"
       end
       @@channels[key]
     end
 
-    def self.init_all(domain, nodeID, appName, startTime)
+    def self.init_all(domain, nodeID, appName, startTime, protocol)
       @@default_domain = domain
 
       MPBase.__freeze__(appName, startTime)
 
       # send channel header
-      @@channels.values.each { |c| c.init(nodeID, appName, startTime) }
+      @@channels.values.each { |c| c.init(nodeID, appName, startTime, protocol) }
 
       # send schema definitions
       MPBase.each_mp do |klass, defs|
-	klass.__print_meta__(appName)
+        klass.__print_meta__(appName)
       end
 
       MPBase.__useOML__()
@@ -403,12 +423,13 @@ module OML4R
     def send_schema(mp_name, pdefs) # defs[:p_def]
       # Build the schema and send it
       @index += 1
-      line = ['schema:', @index, mp_name]
+      #line = ['schema:', @index, mp_name]
+      line = [@index, mp_name]
       pdefs.each do |d|
-	line << "#{d[:name]}:#{d[:type]}"
+        line << "#{d[:name]}:#{d[:type]}"
       end
       msg = line.join(' ')
-      @header << msg
+      @schemas << msg
       @index
     end
 
@@ -416,8 +437,8 @@ module OML4R
       @queue.push msg
     end
 
-    def init(nodeID, appName, startTime)
-      send_protocol_header(nodeID, appName, startTime)
+    def init(nodeID, appName, startTime, protocol)
+      @nodeID, @appName, @startTime, @protocol = nodeID, appName, startTime, protocol
     end
 
     def close()
@@ -431,67 +452,82 @@ module OML4R
       @url = url
       @out = out_channel
       @index = 0
-      @header = []
+      @schemas = []
       @header_sent = false
       @queue = Queue.new
       start_runner
     end
 
 
-    def send_protocol_header(nodeID, appName, startTime)
-      @header << "protocol: #{PROTOCOL}"
+    def _send_protocol_header(stream)
+      header = []
+      header << "protocol: #{@protocol}"
+      header << "content: text"
       d = (@domain == :default) ? @@default_domain : @domain
-      raise "Missing domain name" unless d
-      @header << "experiment-id: #{d}"
-      @header << "start_time: #{startTime.tv_sec}"
-      @header << "sender-id: #{nodeID}"
-      @header << "app-name: #{appName}"
-      @header << "content: text"
+      raise MissingArgumentException.new "Missing domain name" unless d
+      case @protocol || OML4R::DEF_PROTOCOL
+      when 3
+        header << "experiment-id: #{d}"
+        header << "start_time: #{@startTime.tv_sec}"
+        header << "sender-id: #{@nodeID}"
+        header << "app-name: #{@appName}"
+        @schemas.each do |s|
+          header << "schema: #{s}"
+        end
+        header << ""        
+      when 4
+        i = 0
+        header << ""        
+        header << "0\t0\t#{i += 1}\t.\texperiment-id\t#{d}"
+        header << "0\t0\t#{i += 1}\t.\tstart_time\t#{@startTime.tv_sec}"
+        header << "0\t0\t#{i += 1}\t.\tsender-id\t#{@nodeID}"
+        header << "0\t0\t#{i += 1}\t.\tapp-name\t#{@appName}"
+        @schemas.each do |s|
+          header << "0\t0\t#{i += 1}\t.\tschema\t#{s}"
+        end
+        
+      else
+        raise OML4RException.new "Unsupported protocol #{@protocol}"
+      end
+      stream.puts header
     end
 
     def start_runner
       header_sent = false
       @runner = Thread.new do
-	active = true
-	begin
-	  while (active)
-	    msg = @queue.pop
-	    active = !msg.nil?
-	    if !@queue.empty?
-	      ma = [msg]
-	      while !@queue.empty?
-		msg = @queue.pop
-		if (active = !msg.nil?)
-		  ma << msg
-		end
-	      end
-	      msg = ma.join("\n")
-	    end
-	    #$stderr.puts ">>>>>>#{@domain}: <#{msg}>"
+        active = true
+        begin
+          while (active)
+            msg = @queue.pop
+            active = !msg.nil?
+            if !@queue.empty?
+              ma = [msg]
+              while !@queue.empty?
+                msg = @queue.pop
+                if (active = !msg.nil?)
+                  ma << msg
+                end
+              end
+              msg = ma.join("\n")
+            end
+            #$stderr.puts ">>>>>>#{@domain}: <#{msg}>"
             unless msg.nil?
               _send msg
             end
-	  end
-	  @out.close
-	  @out = nil
-	rescue Exception => ex
-          msg = "Exception while sending message to channel '#{@url}' (#{ex.class})"
-	  Object.const_defined?(:MObject) ? MObject.warn(:oml4r, msg) : $stderr.puts("INFO	#{msg}")
-	end
-        info "Channel #{url} closed"
+          end
+          @out.close unless @out == $stdout
+          @out = nil
+        rescue Exception => ex
+          OML4R.logger.warn "Exception while sending message to channel '#{@url}' (#{ex})"
+        end
+        OML4R.logger.info "Channel #{url} closed"
       end
     end
 
-    def info(msg)
-      Object.const_defined?(:MObject) ? MObject.warn(:oml4r, msg) : $stderr.puts("INFO        #{msg}")
-    end
-
     def _send(msg)
       begin
         unless @header_sent
-          h = "#{@header.join("\n")}\n\n"
-	  $stderr.puts "DEBUG	'#{h}'" if OML4R.loglevel > 3
-          @out.puts h
+          _send_protocol_header(@out)
           @header_sent = true
         end
         @out.puts msg
@@ -499,16 +535,16 @@ module OML4R
 
       rescue Errno::EPIPE
         # Trying to reconnect
-        info "Trying to reconnect to '#{@url}'"
+        OML4R.logger.info "Trying to reconnect to '#{@url}'"
         loop do
           sleep 5
           begin
             @out = self.class._connect(@url)
             @header_sent = false
-            info "Reconnected to '#{@url}'"
+            OML4R.logger.info "Reconnected to '#{@url}'"
             return _send(msg)
           rescue Errno::ECONNREFUSED => ex
-            info "Exception while reconnect '#{@url}' (#{ex.class})"
+            OML4R.logger.warn "Exception while reconnect '#{@url}' (#{ex.class})"
           end
           #Errno::ECONNREFUSED
         end
@@ -516,7 +552,23 @@ module OML4R
     end
 
   end # Channel
-
+  
+  require 'logger'
+  
+  class Logger < ::Logger
+    def format_message(severity, time, progname, message)
+      "%5s oml4r: %s\n" % [severity, message]
+    end
+  end
+  
+  @@logger = Logger.new(STDERR)
+  @@logger.level = ::Logger::INFO
+  
+  def self.logger
+    @@logger
+  end
+  
+  
 end # module OML4R
 
 # vim: sw=2

data/oml4r.gemspec

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/oml4r.rb', __FILE__)
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "oml4r/version"
 
 Gem::Specification.new do |gem|
   gem.authors       = ["NICTA"]
@@ -10,18 +12,7 @@ Gem::Specification.new do |gem|
 
   # ls-files won't work in VPATH builds;
   # plus, we want lib/oml4r.rb rather than lib/oml4r.rb.in
-  #gem.files         = `git ls-files`.split($\)
-  gem.files	    = [
-	  ".yardopts",
-	  "Gemfile",
-	  "LICENSE",
-	  "README.md",
-	  "Rakefile",
-	  "lib/oml4r.rb",
-	  "lib/oml4r/oml4r-simple-example.rb",
-	  "lib/oml4r/oml4r-wlanconfig.rb",
-	  "oml4r.gemspec",
-  ]
+  gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "oml4r"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oml4r
 version: !ruby/object:Gem::Version
-  version: 2.9.0.2
+  version: 2.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies: []
 description: ! '["Simple OML client library for Ruby"]'
 email:
@@ -18,14 +18,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardopts
+- .gitignore
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
+- examples/oml4r-simple-example.rb
+- examples/oml4r-wlanconfig.rb
+- examples/oml4r-zabbix.rb
+- examples/test_types.rb
 - lib/oml4r.rb
-- lib/oml4r/oml4r-simple-example.rb
-- lib/oml4r/oml4r-wlanconfig.rb
+- lib/oml4r/benchmark.rb
+- lib/oml4r/version.rb
 - oml4r.gemspec
 homepage: http://oml.mytestbed.net
 licenses:
@@ -48,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ! '["This is a simple client library for OML which does not use liboml2 and

data/.yardopts

@@ -1,2 +0,0 @@
---title OML4R
-lib/*.rb

data/lib/oml4r/oml4r-simple-example.rb

@@ -1,69 +0,0 @@
-#
-# Copyright (c) 2012 National ICT Australia (NICTA), Australia
-#
-# 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.
-#
-#
-# = oml4r-simple-example.rb
-#
-# == Description
-#
-# A very simple straightforward example of OML4R.
-#
-require 'oml4r'
-
-# Define your own Measurement Points
-class SinMP < OML4R::MPBase
-  name :sin
-  #channel :default
-
-  param :label
-  param :angle, :type => :int32
-  param :value, :type => :double
-end
-
-class CosMP < OML4R::MPBase
-  name :cos
-  # channel :ch1
-  # channel :default
-
-  param :label
-  param :value, :type => :double
-end
-
-# Initialise the OML4R module for your application
-opts = {:appName => 'oml4rSimpleExample',
-  :expID => 'foo', :nodeID => 'n1',
-  :omlServer => 'file:-'} # Server could also be tcp:host:port
-#  OML4R::create_channel(:default, 'file:-')    
-
-OML4R::init(ARGV, opts)
-
-# Now collect and inject some measurements
-5.times do |i|
-  sleep 0.5
-  angle = 15 * i
-  SinMP.inject("label_#{angle}", angle, Math.sin(angle))
-  CosMP.inject("label_#{angle}", Math.cos(angle))    
-end
-
-# Don't forget to close when you are finished
-OML4R::close()
-
-# vim: sw=2