ovirt_metrics 1.0.0

data/lib/ovirt_metrics.rb

@@ -0,0 +1,149 @@
+require "ovirt_metrics/version"
+require "ovirt_metrics/constants"
+
+$:.push File.expand_path(File.dirname(__FILE__))
+require 'models/ovirt_history'
+Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), "models", "*.rb"))) { |f| require "models/#{File.basename(f, ".*")}" }
+
+module OvirtMetrics
+  DEFAULT_HISTORY_DATABASE_NAME = "ovirt_engine_history".freeze
+
+  def self.establish_connection(opts)
+    self.connect(opts)
+  end
+
+  def self.connect(opts)
+    opts            ||= {}
+    opts[:port]     ||= 5432
+    opts[:database] ||= DEFAULT_HISTORY_DATABASE_NAME
+    opts[:adapter]    = 'postgresql'
+
+    # Don't allow accidental connections to localhost.  A blank host will
+    # connect to localhost, so don't allow that at all.
+    host = opts[:host].to_s.strip
+    raise ArgumentError, "host cannot be blank"            if host.empty?
+    raise ArgumentError, "host cannot be set to localhost" if ["localhost", "localhost.localdomain", "127.0.0.1", "0.0.0.0"].include?(host)
+
+    OvirtHistory.establish_connection(opts)
+  end
+
+  def self.connected?
+    OvirtHistory.connection.active?
+  end
+
+  def self.disconnect
+    OvirtHistory.connection.disconnect!
+  end
+
+  def self.vm_realtime(vm_id, start_time = nil, end_time = nil)
+    metrics      = query_vm_realtime_metrics(vm_id, start_time, end_time)
+    disk_metrics = query_vm_disk_realtime_metrics(vm_id, start_time, end_time)
+    nic_metrics  = query_vm_nic_realtime_metrics(vm_id, start_time, end_time)
+    hashes       = vm_realtime_metrics_to_hashes(metrics, disk_metrics, nic_metrics)
+  end
+
+  def self.host_realtime(host_id, start_time = nil, end_time = nil)
+    metrics      = query_host_realtime_metrics(host_id, start_time, end_time).all
+    nic_metrics  = query_host_nic_realtime_metrics(host_id, start_time, end_time)
+    hashes       = host_realtime_metrics_to_hashes(metrics, nic_metrics)
+  end
+
+  private
+
+  def self.query_host_realtime_metrics(host_id, start_time = nil, end_time = nil)
+    query = HostSamplesHistory.where(:host_id => host_id).includes(:host_configuration)
+    query = query.where(:history_datetime => (start_time..(end_time || Time.now.utc))) unless start_time.nil?
+    query
+  end
+
+  def self.query_host_nic_realtime_metrics(host_id, start_time = nil, end_time = nil)
+    nic_ids = HostInterfaceConfiguration.where(:host_id => host_id).collect(&:host_interface_id)
+    query = HostInterfaceSamplesHistory.where(:host_interface_id => nic_ids)
+    query = query.where(:history_datetime => (start_time..(end_time || Time.now.utc))) unless start_time.nil?
+    query
+  end
+
+  def self.host_realtime_metrics_to_hashes(metrics, nic_metrics)
+    counters_by_id              = {}
+    counter_values_by_id_and_ts = {}
+
+    nic_metrics = nic_metrics.group_by { |m| m.history_datetime }
+
+    metrics.each do |metric|
+      options = {
+        :metric => metric,
+        :nic    => nic_metrics[metric.history_datetime]
+      }
+
+      href = "/api/hosts/#{metric.host_id}"
+      counters_by_id[href] ||= {}
+      values = {}
+
+      HOST_COLUMN_DEFINITIONS.each do |evm_col, info|
+        counters_by_id[href][info[:ovirt_key]] ||= info[:counter]
+        values[info[:ovirt_key]] = info[:ovirt_method].call(options)
+      end
+
+      # For (temporary) symmetry with VIM API having 20-second intervals
+      counter_values_by_id_and_ts[href] ||= {}
+      [0, 20, 40].each do |t|
+        counter_values_by_id_and_ts[href][(metric.history_datetime + t).utc.iso8601] = values
+      end
+    end
+
+    return counters_by_id, counter_values_by_id_and_ts
+  end
+
+  def self.query_vm_realtime_metrics(vm_id, start_time = nil, end_time = nil)
+    query = VmSamplesHistory.where(:vm_id => vm_id).includes(:host_configuration)
+    query = query.where(:history_datetime => (start_time..(end_time || Time.now.utc))) unless start_time.nil?
+    query
+  end
+
+  def self.query_vm_disk_realtime_metrics(vm_id, start_time = nil, end_time = nil)
+    disk_ids = DisksVmMap.where(:vm_id => vm_id).collect(&:vm_disk_id)
+    query = VmDiskSamplesHistory.where(:vm_disk_id => disk_ids)
+    query = query.where(:history_datetime => (start_time..(end_time || Time.now.utc))) unless start_time.nil?
+    query
+  end
+
+  def self.query_vm_nic_realtime_metrics(vm_id, start_time = nil, end_time = nil)
+    nic_ids = VmInterfaceConfiguration.where(:vm_id => vm_id).collect(&:vm_interface_id)
+    query = VmInterfaceSamplesHistory.where(:vm_interface_id => nic_ids)
+    query = query.where(:history_datetime => (start_time..(end_time || Time.now.utc))) unless start_time.nil?
+    query
+  end
+
+  def self.vm_realtime_metrics_to_hashes(metrics, disk_metrics, nic_metrics)
+    counters_by_id              = {}
+    counter_values_by_id_and_ts = {}
+
+    disk_metrics = disk_metrics.group_by { |m| m.history_datetime }
+    nic_metrics  = nic_metrics.group_by { |m| m.history_datetime }
+
+    metrics.each do |metric|
+      options = {
+        :metric => metric,
+        :disk   => disk_metrics[metric.history_datetime],
+        :nic    => nic_metrics[metric.history_datetime]
+      }
+
+      href = "/api/vms/#{metric.vm_id}"
+      counters_by_id[href] ||= {}
+      values = {}
+
+      VM_COLUMN_DEFINITIONS.each do |evm_col, info|
+        counters_by_id[href][info[:ovirt_key]] ||= info[:counter]
+        values[info[:ovirt_key]] = info[:ovirt_method].call(options)
+      end
+
+      # For (temporary) symmetry with VIM API having 20-second intervals
+      counter_values_by_id_and_ts[href] ||= {}
+      [0, 20, 40].each do |t|
+        counter_values_by_id_and_ts[href][(metric.history_datetime + t).utc.iso8601] = values
+      end
+    end
+
+    return counters_by_id, counter_values_by_id_and_ts
+  end
+end

data/ovirt_metrics.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ovirt_metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ovirt_metrics"
+  spec.version       = OvirtMetrics::VERSION
+  spec.authors       = ["Oleg Barenboim", "Jason Frey"]
+  spec.email         = ["chessbyte@gmail.com", "fryguy9@gmail.com"]
+  spec.description   = %q{OvirtMetrics is an ActiveRecord-based gem for reading the oVirt History database.}
+  spec.summary       = %q{OvirtMetrics is an ActiveRecord-based gem for reading the oVirt History database.}
+  spec.homepage      = "http://github.com/ManageIQ/ovirt_metrics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_dependency "activerecord", "~> 3.2.0"
+end

data/spec/models/host_configuration_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w{.. spec_helper}))
+
+require 'ovirt_metrics'
+
+describe OvirtMetrics::HostConfiguration do
+  shared_examples_for "HostConfiguration" do
+    context "#speed_in_mhz" do
+      it "when cpu_model is nil" do
+        described_class.new(:cpu_model => nil).speed_in_mhz.should be_nil
+      end
+
+      it "when cpu_model is in GHz" do
+        described_class.new(:cpu_model => "Intel(R) Xeon(R) CPU E5506 @ 2.00GHz").speed_in_mhz.should == 2048.0
+      end
+
+      it "when cpu_model is in MHz" do
+        described_class.new(:cpu_model => "Intel(R) Xeon(R) CPU E5506 @ 2.00MHz").speed_in_mhz.should == 2.0
+      end
+
+      it "when cpu_model is some other string" do
+        described_class.new(:cpu_model => "XXX").speed_in_mhz.should be_nil
+      end
+    end
+  end
+
+  context "RHEV 3.0" do
+    before(:each) { load_rhev_30 }
+    it_should_behave_like "HostConfiguration"
+  end
+
+  context "RHEV 3.1" do
+    before(:each) { load_rhev_31 }
+    it_should_behave_like "HostConfiguration"
+  end
+end

data/spec/models/host_interface_samples_history_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w{.. spec_helper}))
+
+require 'ovirt_metrics'
+
+describe OvirtMetrics::HostInterfaceSamplesHistory do
+  shared_examples_for "HostInterfaceSamplesHistory" do
+    context ".net_usage_rate_average_in_kilobytes_per_second" do
+      it "when nic_metrics array is empty" do
+        described_class.net_usage_rate_average_in_kilobytes_per_second([]).should == 0.0
+      end
+
+      it "when nic_metrics array has one element with 90% receiving and 10% transmitting" do
+        nic_metric = double("nic_metric")
+        nic_metric.stub(:receive_rate_percent => 90, :transmit_rate_percent => 10)
+        described_class.net_usage_rate_average_in_kilobytes_per_second([nic_metric]).should == (described_class::GIGABYTE_PER_SECOND / 2) / 1024
+      end
+
+      it "when nic_metrics array has two elements with 90% receiving and 10% transmitting each" do
+        nic_metric1 = double("nic_metric")
+        nic_metric1.stub(:receive_rate_percent => 90, :transmit_rate_percent => 10)
+        nic_metric2 = double("nic_metric")
+        nic_metric2.stub(:receive_rate_percent => 90, :transmit_rate_percent => 10)
+        described_class.net_usage_rate_average_in_kilobytes_per_second([nic_metric1, nic_metric2]).should == (described_class::GIGABYTE_PER_SECOND / 2) / 1024
+      end
+    end
+  end
+
+  context "RHEV 3.0" do
+    before(:each) { load_rhev_30 }
+    it_should_behave_like "HostInterfaceSamplesHistory"
+  end
+
+  context "RHEV 3.1" do
+    before(:each) { load_rhev_31 }
+    it_should_behave_like "HostInterfaceSamplesHistory"
+  end
+end

data/spec/models/host_samples_history_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w{.. spec_helper}))
+
+require 'ovirt_metrics'
+
+describe OvirtMetrics::HostSamplesHistory do
+  shared_examples_for "HostSamplesHistory" do
+    context "#cpu_usagemhz_rate_average" do
+      before(:each) { @host_configuration = OvirtMetrics::HostConfiguration.new }
+      context "when host_configuration exists" do
+        it "and speed_in_mhz and number_of_cores is nil" do
+          host_history = described_class.new(:host_configuration => @host_configuration)
+          host_history.cpu_usagemhz_rate_average.should == 0
+        end
+
+        it "and speed_in_mhz is nil and number_of_cores is numeric" do
+          host_history = described_class.new(:host_configuration => @host_configuration)
+          @host_configuration.stub(:number_of_cores => 1)
+          host_history.cpu_usagemhz_rate_average.should == 0
+        end
+
+        it "and speed_in_mhz is numeric and number_of_cores is nil" do
+          host_history = described_class.new(:host_configuration => @host_configuration)
+          @host_configuration.stub(:speed_in_mhz => 2048.0)
+          host_history.cpu_usagemhz_rate_average.should == 0
+        end
+
+        it "and speed_in_mhz is numeric and number_of_cores is numeric" do
+          host_configuration = OvirtMetrics::HostConfiguration.new
+          @host_configuration.stub(:speed_in_mhz => 2048.0)
+          @host_configuration.stub(:number_of_cores => 2)
+
+          host_history = described_class.new(
+            :cpu_usage_percent  => 50,
+            :host_configuration => @host_configuration
+          )
+          host_history.cpu_usagemhz_rate_average.should == 2048.0
+        end
+      end
+    end
+  end
+
+  context "RHEV 3.0" do
+    before(:each) { load_rhev_30 }
+    it_should_behave_like "HostSamplesHistory"
+  end
+
+  context "RHEV 3.1" do
+    before(:each) { load_rhev_31 }
+    it_should_behave_like "HostSamplesHistory"
+  end
+end

data/spec/models/vm_disk_samples_history_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w{.. spec_helper}))
+
+require 'ovirt_metrics'
+
+describe OvirtMetrics::VmDiskSamplesHistory do
+  KILOBYTE = 1024
+  MEGABYTE = KILOBYTE * 1024
+
+  shared_examples_for "VmDiskSamplesHistory" do
+    context ".disk_usage_rate_average_in_kilobytes_per_second" do
+      it "when disk_metrics array is empty" do
+        described_class.disk_usage_rate_average_in_kilobytes_per_second([]).should == 0.0
+      end
+
+      it "when disk_metrics array has one element" do
+        disk_metric = double("disk_metric")
+        disk_metric.stub(:read_rate_bytes_per_second => 2.0 * MEGABYTE, :write_rate_bytes_per_second => 1.0 * MEGABYTE)
+        expected_result = (disk_metric.read_rate_bytes_per_second + disk_metric.write_rate_bytes_per_second) / KILOBYTE
+        described_class.disk_usage_rate_average_in_kilobytes_per_second([disk_metric]).should == expected_result
+      end
+
+      it "when disk_metrics array has two elements" do
+        disk_metric1 = double("disk_metric")
+        disk_metric1.stub(:read_rate_bytes_per_second => 2.0 * MEGABYTE, :write_rate_bytes_per_second => 1.0 * MEGABYTE)
+
+        disk_metric2 = double("disk_metric")
+        disk_metric2.stub(:read_rate_bytes_per_second => 2.0 * MEGABYTE, :write_rate_bytes_per_second => 5.0 * MEGABYTE)
+
+        sum_m1 = disk_metric1.read_rate_bytes_per_second + disk_metric1.write_rate_bytes_per_second
+        sum_m2 = disk_metric2.read_rate_bytes_per_second + disk_metric2.write_rate_bytes_per_second
+        expected_result = (sum_m1 + sum_m2) / KILOBYTE / 2
+        described_class.disk_usage_rate_average_in_kilobytes_per_second([disk_metric1, disk_metric2]).should == expected_result
+      end
+    end
+  end
+
+  context "RHEV 3.0" do
+    before(:each) { load_rhev_30 }
+    it_should_behave_like "VmDiskSamplesHistory"
+  end
+
+  context "RHEV 3.1" do
+    before(:each) { load_rhev_31 }
+    it_should_behave_like "VmDiskSamplesHistory"
+  end
+end

data/spec/models/vm_interface_samples_history_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w{.. spec_helper}))
+
+require 'ovirt_metrics'
+
+describe OvirtMetrics::VmInterfaceSamplesHistory do
+  shared_examples_for "VmInterfaceSamplesHistory" do
+    context ".net_usage_rate_average_in_kilobytes_per_second" do
+      it "when nic_metrics array is empty" do
+        described_class.net_usage_rate_average_in_kilobytes_per_second([]).should == 0.0
+      end
+
+      it "when nic_metrics array has one element with 90% receiving and 10% transmitting" do
+        nic_metric = double("nic_metric")
+        nic_metric.stub(:receive_rate_percent => 90, :transmit_rate_percent => 10)
+        described_class.net_usage_rate_average_in_kilobytes_per_second([nic_metric]).should == (described_class::GIGABYTE_PER_SECOND / 2) / 1024
+      end
+
+      it "when nic_metrics array has two elements with 90% receiving and 10% transmitting each" do
+        nic_metric1 = double("nic_metric")
+        nic_metric1.stub(:receive_rate_percent => 90, :transmit_rate_percent => 10)
+        nic_metric2 = double("nic_metric")
+        nic_metric2.stub(:receive_rate_percent => 90, :transmit_rate_percent => 10)
+        described_class.net_usage_rate_average_in_kilobytes_per_second([nic_metric1, nic_metric2]).should == (described_class::GIGABYTE_PER_SECOND / 2) / 1024
+      end
+    end
+  end
+
+  context "RHEV 3.0" do
+    before(:each) { load_rhev_30 }
+    it_should_behave_like "VmInterfaceSamplesHistory"
+  end
+
+  context "RHEV 3.1" do
+    before(:each) { load_rhev_31 }
+    it_should_behave_like "VmInterfaceSamplesHistory"
+  end
+end

data/spec/models/vm_samples_history_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w{.. spec_helper}))
+
+require 'ovirt_metrics'
+
+describe OvirtMetrics::VmSamplesHistory do
+  shared_examples_for "VmSamplesHistory" do
+    context "#cpu_usagemhz_rate_average" do
+      it "when host_configuration is nil" do
+        vm_history = described_class.new
+        vm_history.stub(:host_configuration => nil)
+
+        vm_history.cpu_usagemhz_rate_average.should == 0
+      end
+
+      context "when host_configuration exists" do
+        it "and speed_in_mhz is nil" do
+          vm_history = described_class.new(:host_configuration => OvirtMetrics::HostConfiguration.new)
+          vm_history.cpu_usagemhz_rate_average.should == 0
+        end
+
+        it "and speed_in_mhz is not nil" do
+          host_configuration = OvirtMetrics::HostConfiguration.new
+          host_configuration.stub(:speed_in_mhz => 2048.0)
+
+          vm_history = described_class.new(
+            :cpu_usage_percent  => 50,
+            :host_configuration => host_configuration
+          )
+          vm_history.cpu_usagemhz_rate_average.should == 1024.0
+        end
+      end
+    end
+  end
+
+  context "RHEV 3.0" do
+    before(:each) { load_rhev_30 }
+    it_should_behave_like "VmSamplesHistory"
+  end
+
+  context "RHEV 3.1" do
+    before(:each) { load_rhev_31 }
+    it_should_behave_like "VmSamplesHistory"
+  end
+end

data/spec/ovirt_metrics_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+require 'ovirt_metrics'
+
+describe OvirtMetrics do
+end