oml4r 2.10.4 → 2.10.4.20.g6503629

data/bin/csv2oml

@@ -0,0 +1,190 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2009 - 2014 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.
+# ------------------
+#
+# = csv2oml
+#
+# == Description
+#
+# This tool associates an OML Measurement Point (MP) to a CSV file, then turns any
+# new line from that file into an OML Measurement sample and injects it into the
+# MP. It keeps monitoring the CSV file and inject any new line until it is stopped
+# by Ctrl-C (or any other relevant SIGNALs). The MP definition is dynamically
+# generated based on the head of CSV file (with or without header). In addition,
+# the version of this tool and its execution start and termination POSIX dates are
+# recorded as OML metadata to the defined MP.
+#
+# Example: csv2oml.rb --file X --app-name Y --mp-name Z --no-headers --interval 1
+#
+#   --file PATH           Path to the CSV file to process
+#   --app-name APPNAME    Name of the app which generates the CSV file to process (default to 'csv2oml')
+#   --mp-name MPNAME      Name of the Measurement Point for the CSV file to process (default to 'mp')
+#   --no-headers          When set then do not use the 1st line to name fields/metrics (default unset)
+#   --interval NUMBER     Interval period to check for new lines in the CSV (in second, default 1)
+#
+#   Below are OML4R options (https://github.com/mytestbed/oml4r)
+#
+#   --oml-id id           Name to identify this app instance [undefined]
+#   --oml-domain domain   Name of experimental domain [undefined] *EXPERIMENTAL*
+#   --oml-collect uri     URI of server to send measurements to
+#   --oml-protocol p      Protocol number [4]
+#   --oml-log-level l     Log level used (info: 0 .. debug: 1)
+#   --oml-noop            Do not collect measurements
+#   --oml-config file     File holding OML configuration parameters
+#   --oml-exp-id domain   Obsolescent equivalent to --oml-domain domain
+#   --oml-file localPath  Obsolescent equivalent to --oml-collect file:localPath
+#   --oml-server uri      Obsolescent equivalent to --oml-collect uri
+#   --oml-help            Show this message
+#
+require 'rubygems'
+require 'logger'
+require 'csv'
+
+NAME='csv2oml'
+VERSION="1.0"
+log = Logger.new(STDOUT)
+log.formatter = proc do |level, time, progname, msg|
+  "#{time.strftime('%y%m%d_%H%M%S')} #{NAME} - #{level} - #{msg}\n"
+end
+
+class CSV2OML
+
+  attr_reader :mp_class
+
+  def initialize(args,log)
+    @log = log
+    @app_name = NAME
+    @mp_name = 'mp'
+    @path = nil
+    @mp_class = nil
+    @headers = true
+    @interval = 1
+    @first_line = true
+    @metrics = []
+
+    # Unfortunately OML4R Policy is that the Application Name cannot be defined
+    # on the command line, and must be defined in the Application Code. While
+    # this makes sense for all other app, here we do not want OML to use csv2oml
+    # as the ID for this app, but rather use the ID of the app that generated
+    # the CSV. Thus we have to manually 'extract' the app name from the command
+    # line.
+    i = args.index('--app-name')
+    unless i.nil?
+      @app_name = args.delete_at(i+1)
+      args.delete_at(i)
+    end
+    @log.info "Using Application Name '#{@app_name}' for this OML data collection"
+
+    # Now let OML4R parse the remaining command line and do its init stuff
+    OML4R::init(args, :appName => @app_name) do |parser|
+      parser.banner=<<-text
+      
+      This tool associates an OML Measurement Point (MP) to a CSV file, then turns any
+      new line from that file into an OML Measurement sample and injects it into the
+      MP. It keeps monitoring the CSV file and inject any new line until it is stopped
+      by Ctrl-C (or any other relevant SIGNALs). The MP definition is dynamically
+      generated based on the head of CSV file (with or without header). In addition,
+      the version of this tool and its execution start and termination POSIX dates are
+      recorded as OML metadata to the defined MP.\n
+      Example: csv2oml.rb --file X --app-name Y --mp-name Z --no-headers --interval 1\n
+      text
+      parser.on("--file PATH", "Path to the CSV file to process") { |name| @path = name }
+      parser.on("--app-name APPNAME", "Name of the app which generates the CSV file to process (default to 'csv2oml')") { |name| @app_name = name }
+      parser.on("--mp-name MPNAME", "Name of the Measurement Point for the CSV file to process (default to 'mp')") { |name| @mp_name = name }
+      parser.on("--no-headers", "When set then do not use the 1st line to name fields/metrics (default unset)") { @headers = false }     
+      parser.on("--interval NUMBER", "Interval period to check for new lines in the CSV (in second, default 1)") { |i| @interval = i }     
+      parser.on_tail("--version", "Show version number") { $stderr.puts "#{NAME} - version #{VERSION}"; exit }
+    end
+  end
+
+  def start()
+    # Open the CSV file and monitor it
+    # This will continue until SIGTERM or Ctrl-C are received
+    raise "Missing CSV file path (option '--file')" if @path.nil?
+    @log.info "Monitoring CSV file '#{@path}' (SIGTERM or Ctrl-C to exit)"
+    File.open(@path) do |f|
+      f.extend(File::Tail)
+      f.interval = @interval
+      f.tail { |line| process(line) }
+    end
+  end
+
+  def process(line)
+    line = build_measurement_point(line) if @mp_class.nil?
+    unless line.nil?
+      parsed_line = CSV.parse(line,{:converters => :numeric})[0]
+      @mp_class.inject(*parsed_line)
+    end
+  end
+
+  def build_measurement_point(line)
+    # First line in the file and headers is true, so use this line as metrics
+    if (@headers && @first_line)
+      @metrics = line.chomp.split(',')
+      # Some checks: get rid of quotes, make sure fields are not numbers
+      @metrics = @metrics.map { |e| e.chomp('"').reverse.chomp('"').reverse } 
+      @metrics = @metrics.map { |e| e.chomp("'").reverse.chomp("'").reverse }
+      @metrics.each { |e| raise "Cannot create MP! Invalid metric name '#{e}' in CSV header '#{@metrics}'!" if e.match(/\A[+-]?\d+?(\.\d+)?\Z/) }
+      @first_line = false
+      return nil
+    end
+    # Second line in the file or First line but headers is false
+    # Then use this line to determine the OML types for the MP
+    types = []
+    parsed_line = CSV.parse(line,{:converters => :numeric})[0]
+    # Only support a subset of OML's supported type, as there is no standard
+    # way to tell from a CSV record if 'true' is meant to be a boolean or a 
+    # string, same goes for GUIDs which OML support 
+    parsed_line.each do |v|
+      case v.class.to_s.to_sym
+      when :Fixnum
+        types << :int32
+      when :Bignum
+        types << :int64 
+      when :Float
+        types << :double 
+      else
+        types << :string
+      end
+    end
+    # Make sure with have names for the metrics of this MP
+    parsed_line.length.times { |i| @metrics << "V#{i}"} if @metrics.empty?
+    # Sanity check
+    raise "Cannot create MP! Size of defined metrics do not match size of a sample!" if @metrics.length != types.length
+    # Now define the new MP
+    @mp_class = Class.new(OML4R::MPBase) 
+    @mp_class.name(@mp_name)
+    @metrics.each_index { |i| @mp_class.param(@metrics[i].to_sym, :type => types[i].to_sym) }
+    @first_line = false
+    @log.info "Defined MP '#{@mp_name}' (OML table name: '#{@app_name}_#{@mp_name}') "+
+              "with metrics: #{@metrics.map {|m| "#{m} (#{types[@metrics.index(m)]})" }.join(', ')}"
+    @mp_class.inject_metadata('csv2oml_version',VERSION)
+    @mp_class.inject_metadata('csvfile',@path)
+    @mp_class.inject_metadata('posix_start_date',Time.now.to_i)
+    return line
+  end
+end
+
+# Apps main entry...
+begin
+  require 'oml4r'
+  require 'file-tail'
+  app = CSV2OML.new(ARGV,log)
+  app.start
+rescue LoadError => ex
+  log.error "Missing library! Try running 'gem install #{ex.to_s.split[-1]}' (original error: #{ex}) "
+rescue SystemExit
+rescue SignalException
+  log.info "#{NAME} stopped."
+rescue Exception => ex
+  log.error "#{ex.class} - #{ex}\n\n"
+  # Uncomment the next line to get more info on errors
+  #log.error "Trace - #{ex.backtrace.join("\n\t")}"
+ensure
+  app.mp_class.inject_metadata('posix_end_date',Time.now.to_i) unless (app.nil? || app.mp_class.nil?)
+end
+OML4R::close()

data/bin/ntpq-oml2

@@ -0,0 +1,200 @@
+#!/usr/bin/env ruby
+#
+# OML4R wrapper for ntpq
+#
+# This application runs the system ntpq -p -n, parses its output and reports the
+# measurements via OML
+#
+# Author: Olivier Mehani  <olivier.mehani@nicta.com.au>, (C) 2014
+# Copyright (c) 2014 National ICT Australia (NICTA)
+#
+# 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.
+#
+
+require 'rubygems'
+require 'oml4r'
+
+@@bin = "ntpq"
+@@binopt = "-p -n"
+@@appname = @@bin + "-oml2"
+# XXX: if when is expressed in days, we need to rescale it, see MP.cleanup
+@@regex = /^(?<rtype>\*|#|o|\+|x|.|-| )(?<remote>[^\s]+)\s+(?<refid>[^\s]+)\s+(?<stratum>\d+)\s+(?<type>l|u|m|b|-)\s+(?<when>\d+d?|-})\s+(?<poll>\d+)\s+(?<reach>\d+)\s+(?<delay>(\d|\.)+)\s+(?<offset>-?(\d|\.)+)\s+(?<jitter>(\d|\.)+)$/ 
+
+# See [0] for explanations of the fields
+# [rtype]remote, refid, st[ratum], t[ype], when, poll, reach, delay, offset, jitter [or dispersion]
+# [0] http://h30499.www3.hp.com/t5/System-Administration/Interpreting-NTPQ-output/m-p/3616540/highlight/true#M235154
+class MP < OML4R::MPBase
+  name @@bin
+
+  param :rtype, :type => :string	# 
+  # Character that may be before hostname:
+  # * indicates the current synchronization source.
+  # # indicates that the host is selected for synchronization, but distance from the
+  #   host to the server exceeds the maximum value.
+  # o indicates that the host is selected for synchronization, and the PPS signal is
+  #   in use.
+  # + indicates the host included in the final synchronization selection set.
+  # x indicates that the host is the designated false ticker by the intersection
+  #   algorithm.
+  # . indicates that the host is selected from the end of the candidate list.
+  # - indicates a host discarded by the clustering algorithm.
+  # blank indicates a host is discarded due to high stratum and/or failed sanity
+  #   checks.
+
+  param :remote, :type => :string	# IP address of host
+  param :refid, :type => :string	# source of synchronisation
+  param :stratum, :type => :uint32	# stratum level of the host
+
+  param :type, :type => :string		# type of host
+  # l local (such as a GPS clock)
+  # u unicast (this is the common type)
+  # m multicast
+  # b broadcast
+  # - netaddr (usually 0)
+
+  param :when, :type => :uint32		# number of seconds passed since the remote host response [s]
+  param :poll, :type => :uint32		# polling interval to the remote host [s]
+  param :reach, :type => :uint32	# 8-bit shift register of reach attempts
+  param :delay, :type => :double	# round trip time [ms]
+  param :offset, :type => :double	# time difference between server and client [ms]
+  param :jitter, :type => :double	# difference in the offset measurement between two samples [ms]
+end
+
+# XXX: OML4R should allow support for REs, and create a match function per MP
+if not defined? MP.match
+  def MP.match(row)
+    cleanup(@@regex.match(row))
+  end
+end
+if not defined? MP.cleanup
+  def MP.cleanup(match)
+    return if match.nil?
+    if match["when"].include? "d"
+      # Convert the MatchData into a Hash so we can overwrite it; this conserves
+      # the assumption that match[0] is the full string that matched; if other
+      # cleanup is needed, this should be done outside of this conditional
+      match = { :MatchData => match[0] }.merge(Hash[match.names.zip(match.captures)])
+
+      match["when"] = "#{match["when"].to_i * 86400}"
+      match.values
+    else
+      match
+    end
+  end
+end
+
+class Wrapper
+  attr_accessor  :loop_interval
+
+  def initialize(args)
+    @binio = nil
+    @verbose = true
+    @leftover = []
+    @loop_interval = 0
+
+    begin
+      @leftover = OML4R::init(args, :appName => @@bin) do |argParser|
+	argParser.banner = "Runs the system #{@@bin}#{(@@binopt.nil?)?"":" (#{@@binopt})"} and reports measurements via OML\n Use -h or --help for a list of options\n\n"
+	argParser.on("-l","--loop-interval NUMBER","Interval between runs (seconds)"){ |interval| @loop_interval = interval.to_i()}
+	argParser.on("-q","--[no]-quiet ","Don't show #{@@bin} output on the console"){ @verbose = false }
+      end
+
+    rescue OML4R::MissingArgumentException => ex
+      OML4R.logger.warn "#{@@appname}: #{ex}"
+    end
+
+  end
+
+  def process_output(row)
+    if not (parse = MP.match(row)).nil?  # One sample
+	   MP.inject(*parse[1..-1])
+    end
+  end
+
+  def run()
+    @binio = IO.popen("#{@@bin} #{@@binopt} #{(@leftover.nil?)?"":@leftover.join(' ')}")
+    while true
+      row = @binio.readline
+      puts row if @verbose
+      process_output(row)
+    end
+  end
+
+  def start()
+    return if not @binio.nil?
+
+    begin
+      run
+    rescue EOFError
+      @binio.close
+      @binio = nil
+    end
+  end
+
+  def stop()
+    @loop_interval = 0
+    return if @binio.nil?
+    # Kill the ping process, which will result in EOFError from ping()
+    Process.kill("INT", @binio.pid)
+    @binio.close
+    @binio = nil
+  end
+
+end #end of class
+
+begin
+  OML4R.logger.info "#{@@appname} #{OML4R::VERSION}"
+
+  app = Wrapper.new(ARGV)
+
+  # Handle Ctrl+C and OMF's SIGTERM
+  Signal.trap("INT") { app.stop }
+  Signal.trap("TERM") { app.stop }
+
+  # Handle for OMF's 'exit' command
+  a = Thread.new do
+    $stdin.each do |line|
+      if /^exit/ =~ line
+	Process.kill("INT", 0)
+      end
+    end
+  end
+
+  while true
+    app.start
+    if app.loop_interval > 0
+      sleep app.loop_interval
+    else
+      exit
+    end
+  end
+  # XXX: Sleep for one second to let OML4R send the remaining data (see comments
+  # in #1485)
+  sleep 1
+rescue Interrupt
+rescue SystemExit
+  OML4R.close
+rescue Exception => ex
+  OML4R.logger.error "#{@@appname}: #{ex}"
+end
+
+# Local Variables:
+# mode:ruby
+# End:
+# vim: ft=ruby:sw=2

data/bin/oml4r-multiple-channel-example

@@ -63,7 +63,7 @@ begin
     op.on("--oml-ch2 URL", "Set destination for Channel 2 [#{ch2.url}]") { |url| ch2.url = url }
   end
 rescue OML4R::MissingArgumentException => mex
-  $stderr.puts mex
+  OML4R.logger.error "oml4r-multiple-channel-example: #{mex}"
   exit
 end
 

data/bin/oml4r-simple-example

@@ -48,7 +48,7 @@ opts = {:appName => 'oml4rSimpleExample',
 begin
   OML4R::init(ARGV, opts)
 rescue OML4R::MissingArgumentException => mex
-  $stderr.puts mex
+  OML4R.logger.error "oml4r-simple-example: #{mex}"
   exit
 end
 

data/bin/ping-oml2

@@ -6,9 +6,9 @@
 # measurements via OML
 #
 # Author: Christoph Dwertmann <christoph.dwertmann@nicta.com.au>, (C) 2012-2013
-# Author: Olivier Mehani  <olivier.mehani@nicta.com.au>, (C) 2012-2013
+# Author: Olivier Mehani  <olivier.mehani@nicta.com.au>, (C) 2012-2014
 #
-# Copyright (c) 2012 National ICT Australia (NICTA)
+# Copyright (c) 2012--2014 National ICT Australia (NICTA)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -32,8 +32,11 @@
 require 'rubygems'
 require 'oml4r'
 
+@@bin = "ping"
+@@appname = @@bin + "-oml2"
+
 class MPStat < OML4R::MPBase
-  name :ping
+  name @@bin
   param :dest_addr, :type => :string
   param :ttl, :type => :uint32
   param :rtt, :type => :double
@@ -62,24 +65,32 @@ class PingWrapper
 
   def initialize(args)
     @addr = nil
+    @broadcast = nil
     @count = ''
     @interval = ''
     @verbose = true
     @inet6 = ''
     @numeric = ''
-    @pingio = nil
-
-    leftover = OML4R::init(args, :appName => 'ping') do |argParser|
-      argParser.banner = "Runs the system ping and reports measurements via OML\n Use -h or --help for a list of options\n\n"
-      argParser.on("-a","--dest_addr ADDRESS","Address to ping (the -a switch is optional)") { |address| @addr = address.to_s() }
-      argParser.on("-c","--count NUMBER","Number of pings (default: infinite)"){ |count| @count = "-c #{count.to_i()}"}
-      argParser.on("-i","--interval NUMBER","Interval between pings (seconds)"){ |interval| @interval = "-i #{interval.to_i()}"}
-      argParser.on("-q","--[no]-quiet ","Don't show ping output on the console"){ @verbose = false }
-      argParser.on("-6","--[no]-inet6 ","Use ping6 rather than ping"){ @inet6 = "6"}
-      argParser.on("-n","--[no]-numeric ","No attempt will be made to lookup symbolic names for host addresses"){ @numeric = '-n' }
+    @binio = nil
+
+    begin
+      leftover = OML4R::init(args, :appName => @@bin) do |argParser|
+	argParser.banner = "Runs the system ping and reports measurements via OML\n Use -h or --help for a list of options\n\n"
+	argParser.on("-a","--dest_addr ADDRESS","Address to ping (the -a switch is optional)") { |address| @addr = address.to_s() }
+	argParser.on("-b","--broadcast","Allow pinging a broadcast address") { @broadcast ='-b' }
+	argParser.on("-c","--count NUMBER","Number of pings (default: infinite)"){ |count| @count = "-c #{count.to_i()}"}
+	argParser.on("-i","--interval NUMBER","Interval between pings (seconds)"){ |interval| @interval = "-i #{interval.to_i()}"}
+	argParser.on("-q","--[no]-quiet ","Don't show ping output on the console"){ @verbose = false }
+	argParser.on("-6","--[no]-inet6 ","Use ping6 rather than ping"){ @inet6 = "6"}
+	argParser.on("-n","--[no]-numeric ","No attempt will be made to lookup symbolic names for host addresses"){ @numeric = '-n' }
+      end
+
+    rescue OML4R::MissingArgumentException => ex
+      OML4R.logger.warn "#{@@appname}: #{ex}"
+      leftover = []
     end
 
-    if @addr.nil?
+    if @addr.nil? and not leftover.nil?
       if leftover.length > 0
         @addr = leftover[0]
       else
@@ -110,56 +121,59 @@ class PingWrapper
     end
   end
 
-  def ping()
-    @pingio = IO.popen("ping#{@inet6} #{@numeric} #{@count} #{@interval} #{@addr}")
+  def run()
+    @binio = IO.popen("#{@@bin}#{@inet6} #{@numeric} #{@count} #{@interval} #{@broadcast} #{@addr}")
     while true
-      row = @pingio.readline
+      row = @binio.readline
       puts row if @verbose
       process_output(row)
     end
   end
 
   def start()
-    return if not @pingio.nil?
-
-    # Handle for OMF's 'exit' command
-    a = Thread.new do
-      $stdin.each do |line|
-	if /^exit/ =~ line
-	  Process.kill("INT", 0)
-	end
-      end
-    end
-
-    # Handle Ctrl+C and OMF's SIGTERM
-    Signal.trap("INT", stop )
-    Signal.trap("TERM", stop)
-
+    return if not @binio.nil?
     begin
-      ping
+      run
     rescue EOFError
       # This error is expected
     end
   end
 
   def stop()
-    return if @pingio.nil?
+    return if @binio.nil?
     # Kill the ping process, which will result in EOFError from ping()
-    Process.kill("INT", @pingio.pid)
+    Process.kill("INT", @binio.pid)
   end
 
 end #end of class
 
 begin
-  $stderr.puts " INFO ping-oml2: V#{OML4R::VERSION}\n"
+  OML4R.logger.info "#{@@appname} #{OML4R::VERSION}"
+
   app = PingWrapper.new(ARGV)
+
+  # Handle Ctrl+C and OMF's SIGTERM
+  Signal.trap("INT") { app.stop }
+  Signal.trap("TERM") { app.stop }
+ 
+  # Handle for OMF's 'exit' command
+  a = Thread.new do
+    $stdin.each do |line|
+      if /^exit/ =~ line
+	Process.kill("INT", 0)
+      end
+    end
+  end
+
   app.start()
   # XXX: Sleep for one second to let OML4R send the remaining data (see comments
   # in #1485)
   sleep 1
 rescue Interrupt
+rescue SystemExit
+  OML4R.close
 rescue Exception => ex
-  $stderr.puts " ERROR ping-oml2: #{ex}\n"
+  OML4R.logger.error "#{@@appname}: #{ex}"
 end
 
 # Local Variables:

data/examples/oml4r-multiple-channel-example.rb

@@ -63,7 +63,7 @@ begin
     op.on("--oml-ch2 URL", "Set destination for Channel 2 [#{ch2.url}]") { |url| ch2.url = url }
   end
 rescue OML4R::MissingArgumentException => mex
-  $stderr.puts mex
+  OML4R.logger.error "oml4r-multiple-channel-example: #{mex}"
   exit
 end
 

data/examples/oml4r-simple-example.rb

@@ -48,7 +48,7 @@ opts = {:appName => 'oml4rSimpleExample',
 begin
   OML4R::init(ARGV, opts)
 rescue OML4R::MissingArgumentException => mex
-  $stderr.puts mex
+  OML4R.logger.error "oml4r-simple-example: #{mex}"
   exit
 end
 

data/lib/oml4r.rb

@@ -366,6 +366,7 @@ module OML4R
     omlConfigFile = nil
 
     if argv
+      OML4R.logger.debug "ARGV: #{argv.inspect}"
       # Create a new Parser for the command line
       op = OptionParser.new
       # Include the definition of application's specific arguments
@@ -376,7 +377,8 @@ module OML4R
       op.on("--oml-collect uri", "URI of server to send measurements to") { |u|  opts[:omlCollectUri] = u }
       op.on("--oml-protocol p", "Protocol number [#{OML4R::DEF_PROTOCOL}]") { |l| opts[:protocol] = l.to_i }
       op.on("--oml-log-level l", "Log level used (info: 0 .. debug: 1)") { |l| OML4R.logger.level = 1 - l.to_i }
-      op.on("--oml-noop", "Do not collect measurements") { noop = true }
+      op.on("--oml-noop", "Do not collect measurements") { OML4R.logger.info "OML reporting disabled from command line"
+							   return  }
       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|
         opts[:domain] = name
@@ -390,9 +392,12 @@ module OML4R
         opts[:omlCollectUri] = "#{u}"
         OML4R.logger.warn "Option --oml-server is getting deprecated; please use '--oml-collect #{opts[:omlCollectUri]}' instead"
       }
-      op.on_tail("--oml-help", "Show this message") { $stderr.puts op; exit }
+      op.on_tail("--oml-help", "Show this message") { $stderr.puts op }
       # 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 }
+      unless opts[:appName]
+	raise MissingArgumentException.new 'OML4R: Missing :appName in application code!'
+      end
 
       # Now parse the command line
       rest = op.parse(argv)
@@ -400,28 +405,27 @@ module OML4R
         # give the app a chance to fix missing parameters
         opts[:afterParse].call(opts)
       end
-     OML4R.logger.debug "ARGV: #{argv.inspect}"
-     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]
-         opts[:domain] = d if d
-         d = l[/.*domain=["']([^"']*)/,1]
-         opts[:domain] = d if d
-         i = l[/.*id=["']([^"']*)/,1]
-         opts[:nodeID] = i if i
-         u = l[/.*url=["']([^"']*)/,1]
-         opts[:omlCollectUri] = u if u
-       end
-       f.close
-     end
+      
+      # Parameters in OML config file takes precedence
+      unless omlConfigFile.nil? 
+	f = File.open(omlConfigFile, 'r')
+	f.each_line do |l|
+	  d = l[/.*experiment=["']([^"']*)/,1]
+	  opts[:domain] = d if d
+	  d = l[/.*domain=["']([^"']*)/,1]
+	  opts[:domain] = d if d
+	  i = l[/.*id=["']([^"']*)/,1]
+	  opts[:nodeID] = i if i
+	  u = l[/.*url=["']([^"']*)/,1]
+	  opts[:omlCollectUri] = u if u
+	end
+	f.close
+      end
     end
  
-   unless opts[:nodeID]
+    unless opts[:nodeID]
       begin
-        # Create a default nodeID by concatinating the local hostname with the process ID
+        # Create a default nodeID by concatenating the local hostname with the process ID
         hostname = nil
         begin
           #hostname = Socket.gethostbyname(Socket.gethostname)[0]
@@ -436,12 +440,11 @@ module OML4R
         end
       end
       unless opts[:nodeID]
-        raise MissingArgumentException.new 'OML4R: Missing values for parameter :nodeID (--oml-id)'
+        raise MissingArgumentException.new 'OML4R: Missing values for parameter :nodeID (--oml-id, OML_ID)'
       end
     end
-
-    unless opts[:domain] && opts[:appName]
-      raise MissingArgumentException.new 'OML4R: Missing values for parameters :domain (--oml-domain) or :appName (in code)!'
+    unless opts[:domain]
+      raise MissingArgumentException.new 'OML4R: Missing values for parameter :domain (--oml-domain, OML_DOMAIN)!'
     end
 
     # Set a default collection URI if nothing has been specified

data/lib/oml4r/version.rb

@@ -5,7 +5,23 @@
 # ------------------
 
 module OML4R
-  VERSION = "2.10.4"
+
+  def self.version_of(name)
+    git_tag  = `git describe --tags 2> /dev/null`.chomp
+    git_root = `git rev-parse --show-toplevel 2> /dev/null`.chomp
+    gem_v = Gem.loaded_specs[name].version.to_s rescue '0.0.0'
+
+    # Not in a development environment or git not present
+    if git_root != File.absolute_path("#{File.dirname(__FILE__)}/../../") || git_tag.empty?
+      gem_v
+    else
+      git_tag.gsub(/-/, '.').gsub(/^v/, '')
+    end
+  end
+
+  VERSION = version_of('oml4r')
   VERSION_STRING = "OML4R Client V#{VERSION}"
   COPYRIGHT = "Copyright 2009-2014, NICTA"
 end
+
+# vim: ft=ruby:sw=2

data/omf/README

@@ -1 +1,3 @@
-This directory contains OMF application definitions for the applications that ship with the oml4r gem. To use it, copy the application definition file into the ame directory as your OEDL experiment and run the EC from there.
+This directory contains OMF application definitions for the applications that
+ship with the oml4r gem. To use it, copy the application definition file into
+the ame directory as your OEDL experiment and run the EC from there.

data/omf/ntpq-oml2.rb

@@ -0,0 +1,70 @@
+# Copyright 2014 National ICT Australia (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
+# COPYING or at http://opensource.org/licenses/MIT. By downloading or
+# using this software you accept the terms and the liability disclaimer
+# in the License.
+#
+defApplication('oml:app:ntpq', 'ntpq') do |a|
+
+  a.version(2, 10, 4)
+  a.shortDescription = "Wrapper around ntpq -p -n"
+  a.description = %{This application runs the system ntpq, parses its output and
+reports the measurements via OML
+  }
+  a.path = "/usr/local/bin/ntpq-oml2"
+
+  # XXX: -n and -p are implied, and -i is irrelevant for automated use
+  a.defProperty('force-v4', 'Force DNS resolution of following host names on the command line to the IPv4 namespace',
+		-4, :type => :boolean)
+  a.defProperty('force-v6', 'Force DNS resolution of following host names on the command line to the IPv6 namespace',
+		-6, :type => :boolean)
+  a.defProperty('count', 'Interactive format command and added to the list of commands to be executed on the specified host',
+		'-c', :type => :string)
+  # These options are specific to the instrumentation
+  a.defProperty('loop-interval', 'Interval between runs (seconds)',
+		'-l', :type => :integer, :unit => 'seconds')
+  a.defProperty('quiet', 'Don\'t show ntpq output on the console',
+		'-q', :type => :boolean)
+
+  a.defMeasurement('ntpq') do |m|
+    m.defMetric('rtype',:string)
+    m.defMetric('remote',:string)
+    m.defMetric('refid',:string)
+    m.defMetric('stratum',:uint32)
+    m.defMetric('type',:string)
+    m.defMetric('when',:uint32)
+    m.defMetric('poll',:uint32)
+    m.defMetric('reach',:uint32)
+    m.defMetric('delay',:double)
+    m.defMetric('offset',:double)
+    m.defMetric('jitter',:double)
+  end
+
+end
+
+# Example use with OMF:
+#defProperty('node', "node1-1.grid.orbit-lab.org", "ID of a resource")
+#
+#defGroup('Source', property.node) do |node|
+#  node.addApplication("oml:app:ntpq") do |app|
+#    app.setProperty('loop-interval', 10)
+#    app.setProperty('quiet', true)
+#    app.measure('ntpq', :samples => 1)
+#  end
+#end
+#
+#onEvent(:ALL_UP_AND_INSTALLED) do |event|
+#  info "Starting ntpq"
+#  group('Source').startApplications
+#  wait 6
+#  info "Stopping ntpq"
+#  group('Source').stopApplications
+#  Experiment.done
+#end
+
+# Local Variables:
+# mode:ruby
+# End:
+# vim: ft=ruby:sw=2

data/oml4r.gemspec

@@ -5,9 +5,9 @@ require "oml4r/version"
 
 Gem::Specification.new do |gem|
   gem.authors       = ["NICTA"]
-  gem.email         = ["oml-user@lists.nicta.com.au"]
-  gem.description   = ["Simple OML client library and applications for Ruby"]
-  gem.summary       = ["This is a simple client library for OML which does not use liboml2 and its filters, but connects directly to the server using the +text+ protocol.  User can use this library to create ruby applications which can send measurement to the OML collection server. The gem ships with some example applications."]
+  gem.email         = "oml-user@lists.nicta.com.au"
+  gem.summary= "Simple OML client library and applications for Ruby"
+  gem.description= "This is a simple client library for OML which does not use liboml2 and its filters, but connects directly to the server using the +text+ protocol.  User can use this library to create ruby applications which can send measurement to the OML collection server. The gem ships with some example applications."
   gem.homepage      = "http://oml.mytestbed.net"
 
   # ls-files won't work in VPATH builds;

metadata

@@ -1,20 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: oml4r
 version: !ruby/object:Gem::Version
-  version: 2.10.4
-  prerelease: 
+  version: 2.10.4.20.g6503629
+  prerelease: 10
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies: []
-description: ! '["Simple OML client library and applications for Ruby"]'
-email:
-- oml-user@lists.nicta.com.au
+description: This is a simple client library for OML which does not use liboml2 and
+  its filters, but connects directly to the server using the +text+ protocol.  User
+  can use this library to create ruby applications which can send measurement to the
+  OML collection server. The gem ships with some example applications.
+email: oml-user@lists.nicta.com.au
 executables:
+- csv2oml
+- ntpq-oml2
 - oml4r-multiple-channel-example
 - oml4r-neuca-beacon
 - oml4r-orca-beacon
@@ -32,6 +36,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/csv2oml
+- bin/ntpq-oml2
 - bin/oml4r-multiple-channel-example
 - bin/oml4r-neuca-beacon
 - bin/oml4r-orca-beacon
@@ -56,7 +62,8 @@ files:
 - lib/oml4r/logging/oml4r_appender.rb
 - lib/oml4r/version.rb
 - omf/README
-- omf/ping-oml2.app.rb
+- omf/ntpq-oml2.rb
+- omf/ping-oml2.rb
 - oml4r.gemspec
 homepage: http://oml.mytestbed.net
 licenses:
@@ -74,17 +81,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: ! '["This is a simple client library for OML which does not use liboml2 and
-  its filters, but connects directly to the server using the +text+ protocol.  User
-  can use this library to create ruby applications which can send measurement to the
-  OML collection server. The gem ships with some example applications."]'
+summary: Simple OML client library and applications for Ruby
 test_files: []
-has_rdoc: