Module: OvirtMetrics

Defined in:
lib/ovirt_metrics.rb,
lib/ovirt_metrics/version.rb,
lib/ovirt_metrics/nic_metrics.rb,
lib/ovirt_metrics/configurator.rb,
lib/ovirt_metrics/models/period.rb,
lib/ovirt_metrics/models/calendar.rb,
lib/ovirt_metrics/column_definitions.rb,
lib/ovirt_metrics/models/tag_details.rb,
lib/ovirt_metrics/models/disks_vm_map.rb,
lib/ovirt_metrics/models/ovirt_history.rb,
lib/ovirt_metrics/models/enum_translator.rb,
lib/ovirt_metrics/models/vm_configuration.rb,
lib/ovirt_metrics/models/vm_daily_history.rb,
lib/ovirt_metrics/models/vm_device_history.rb,
lib/ovirt_metrics/models/vm_hourly_history.rb,
lib/ovirt_metrics/models/host_configuration.rb,
lib/ovirt_metrics/models/host_daily_history.rb,
lib/ovirt_metrics/models/vm_samples_history.rb,
lib/ovirt_metrics/models/host_hourly_history.rb,
lib/ovirt_metrics/models/host_samples_history.rb,
lib/ovirt_metrics/models/cluster_configuration.rb,
lib/ovirt_metrics/models/history_configuration.rb,
lib/ovirt_metrics/models/tag_relations_history.rb,
lib/ovirt_metrics/models/vm_disk_configuration.rb,
lib/ovirt_metrics/models/vm_disk_daily_history.rb,
lib/ovirt_metrics/models/vm_disk_hourly_history.rb,
lib/ovirt_metrics/models/vm_disk_samples_history.rb,
lib/ovirt_metrics/models/datacenter_configuration.rb,
lib/ovirt_metrics/models/datacenter_daily_history.rb,
lib/ovirt_metrics/models/datacenter_hourly_history.rb,
lib/ovirt_metrics/models/datacenter_samples_history.rb,
lib/ovirt_metrics/models/vm_interface_configuration.rb,
lib/ovirt_metrics/models/vm_interface_daily_history.rb,
lib/ovirt_metrics/models/vm_interface_hourly_history.rb,
lib/ovirt_metrics/models/host_interface_configuration.rb,
lib/ovirt_metrics/models/host_interface_daily_history.rb,
lib/ovirt_metrics/models/storage_domain_configuration.rb,
lib/ovirt_metrics/models/storage_domain_daily_history.rb,
lib/ovirt_metrics/models/vm_disks_usage_daily_history.rb,
lib/ovirt_metrics/models/vm_interface_samples_history.rb,
lib/ovirt_metrics/models/datacenter_storage_domain_map.rb,
lib/ovirt_metrics/models/host_interface_hourly_history.rb,
lib/ovirt_metrics/models/storage_domain_hourly_history.rb,
lib/ovirt_metrics/models/vm_disks_usage_hourly_history.rb,
lib/ovirt_metrics/models/host_interface_samples_history.rb,
lib/ovirt_metrics/models/storage_domain_samples_history.rb,
lib/ovirt_metrics/models/vm_disks_usage_samples_history.rb

Defined Under Namespace

Modules: NicMetrics Classes: Calendar, ClusterConfiguration, Configurator, DatacenterConfiguration, DatacenterDailyHistory, DatacenterHourlyHistory, DatacenterSamplesHistory, DatacenterStorageDomainMap, DisksVmMap, EnumTranslator, HistoryConfiguration, HostConfiguration, HostDailyHistory, HostHourlyHistory, HostInterfaceConfiguration, HostInterfaceDailyHistory, HostInterfaceHourlyHistory, HostInterfaceSamplesHistory, HostSamplesHistory, OvirtHistory, Period, StorageDomainConfiguration, StorageDomainDailyHistory, StorageDomainHourlyHistory, StorageDomainSamplesHistory, TagDetails, TagRelationsHistory, VmConfiguration, VmDailyHistory, VmDeviceHistory, VmDiskConfiguration, VmDiskDailyHistory, VmDiskHourlyHistory, VmDiskSamplesHistory, VmDisksUsageDailyHistory, VmDisksUsageHourlyHistory, VmDisksUsageSamplesHistory, VmHourlyHistory, VmInterfaceConfiguration, VmInterfaceDailyHistory, VmInterfaceHourlyHistory, VmInterfaceSamplesHistory, VmSamplesHistory

Constant Summary collapse

DEFAULT_HISTORY_DATABASE_NAME = 
"ovirt_engine_history".freeze
DEFAULT_HISTORY_DATABASE_NAME_3_0 = 
"rhevm_history".freeze
VM_NOT_RUNNING = 
0
VERSION = 
"2.0.0"
COMMON_COLUMN_DEFINITIONS = 
{
  "cpu_usage_rate_average" => {
    :ovirt_key    => :cpu_usage_rate_average,
    :ovirt_method => lambda { |metrics| metrics[:metric].cpu_usage_percent.to_f },
    :counter      => {
      :counter_key           => "cpu_usage_rate_average",
      :instance              => "",
      :capture_interval      => "20",
      :precision             => 1,
      :rollup                => "average",
      :unit_key              => "percent",
      :capture_interval_name => "realtime"
    }
  },

  "cpu_usagemhz_rate_average" => {
    :ovirt_key    => :cpu_usagemhz_rate_average,
    :ovirt_method => lambda { |metrics| metrics[:metric].cpu_usagemhz_rate_average },
    :counter      => {
      :counter_key           => "cpu_usagemhz_rate_average",
      :instance              => "",
      :capture_interval      => "20",
      :precision             => 1,
      :rollup                => "average",
      :unit_key              => "megahertz",
      :capture_interval_name => "realtime"
    }
  },

  "mem_usage_absolute_average" => {
    :ovirt_key    => :mem_usage_absolute_average,
    :ovirt_method => lambda { |metrics| metrics[:metric].memory_usage_percent.to_f },
    :counter      => {
      :counter_key           => "mem_usage_absolute_average",
      :instance              => "",
      :capture_interval      => "20",
      :precision             => 1,
      :rollup                => "average",
      :unit_key              => "percent",
      :capture_interval_name => "realtime"
    }
  },
}
VM_COLUMN_DEFINITIONS = 
{
  "cpu_usage_rate_average"     => COMMON_COLUMN_DEFINITIONS["cpu_usage_rate_average"],
  "cpu_usagemhz_rate_average"  => COMMON_COLUMN_DEFINITIONS["cpu_usagemhz_rate_average"],
  "mem_usage_absolute_average" => COMMON_COLUMN_DEFINITIONS["mem_usage_absolute_average"],

  "disk_usage_rate_average" => {
    :ovirt_key    => :disk_usage_rate_average,
    :ovirt_method => lambda { |metrics| VmDiskSamplesHistory.disk_usage_rate_average_in_kilobytes_per_second(metrics[:disk]) },
    :counter      => {
      :counter_key           => "disk_usage_rate_average",
      :instance              => "",
      :capture_interval      => "20",
      :precision             => 1,
      :rollup                => "average",
      :unit_key              => "kilobytespersecond",
      :capture_interval_name => "realtime"
    }
  },

  "net_usage_rate_average" => {
    :ovirt_key    => :net_usage_rate_average,
    :ovirt_method => lambda { |metrics| VmInterfaceSamplesHistory.net_usage_rate_average_in_kilobytes_per_second(metrics[:nic]) },
    :counter      => {
      :counter_key           => "net_usage_rate_average",
      :instance              => "",
      :capture_interval      => "20",
      :precision             => 1,
      :rollup                => "average",
      :unit_key              => "kilobytespersecond",
      :capture_interval_name => "realtime"
    }
  }
}
HOST_COLUMN_DEFINITIONS = 
{
  "cpu_usage_rate_average"     => COMMON_COLUMN_DEFINITIONS["cpu_usage_rate_average"],
  "cpu_usagemhz_rate_average"  => COMMON_COLUMN_DEFINITIONS["cpu_usagemhz_rate_average"],
  "mem_usage_absolute_average" => COMMON_COLUMN_DEFINITIONS["mem_usage_absolute_average"],

  "net_usage_rate_average" => {
    :ovirt_key    => :net_usage_rate_average,
    :ovirt_method => lambda { |metrics| HostInterfaceSamplesHistory.net_usage_rate_average_in_kilobytes_per_second(metrics[:nic]) },
    :counter      => {
      :counter_key           => "net_usage_rate_average",
      :instance              => "",
      :capture_interval      => "20",
      :precision             => 1,
      :rollup                => "average",
      :unit_key              => "kilobytespersecond",
      :capture_interval_name => "realtime"
    }
  }
}

Class Method Summary collapse

Class Method Details

.config {|@config| ... } ⇒ Object

Yields:



16
17
18
19
20
 
# File 'lib/ovirt_metrics.rb', line 16

def self.config
  @config ||= Configurator.new
  yield @config if block_given?
  @config
end

.connect(opts) ⇒ Object

Raises:

  • (ArgumentError) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/ovirt_metrics.rb', line 26

def self.connect(opts)
  opts            ||= {}
  opts[:port]     ||= 5432
  opts[:database] ||= DEFAULT_HISTORY_DATABASE_NAME
  opts[:adapter]    = begin
                        if ActiveRecord::VERSION::MAJOR > 4
                          require "active_record/connection_adapters/ovirt_legacy_postgresql_adapter"
                          'ovirt_legacy_postgresql'
                        else
                          'postgresql'
                        end
                      end

  # 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

.connected? ⇒ Boolean

Note: This method is expected to raise PGErrors and other exceptions



49
50
51
52
53
54
55
56
57
 
# File 'lib/ovirt_metrics.rb', line 49

def self.connected?
  OvirtHistory.connection.active? && OvirtHistory.connected?
rescue ActiveRecord::ConnectionNotEstablished => e
  if e.message =~ /No connection pool.+found/
    false
  else
    raise
  end
end

.disconnect ⇒ Object 



59
60
61
 
# File 'lib/ovirt_metrics.rb', line 59

def self.disconnect
  OvirtHistory.remove_connection
end

.establish_connection(opts) ⇒ Object 



22
23
24
 
# File 'lib/ovirt_metrics.rb', line 22

def self.establish_connection(opts)
  self.connect(opts)
end

.host_metric_to_href(metric) ⇒ Object 



135
136
137
 
# File 'lib/ovirt_metrics.rb', line 135

def self.host_metric_to_href(metric)
  "/api/hosts/#{metric.host_id}"
end

.host_realtime(host_id, start_time = nil, end_time = nil) ⇒ Object 



70
71
72
73
74
 
# File 'lib/ovirt_metrics.rb', line 70

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)
  host_realtime_metrics_to_hashes(metrics, nic_metrics)
end

.host_realtime_metrics_to_hashes(metrics, nic_metrics) ⇒ Object 



94
95
96
97
98
99
 
# File 'lib/ovirt_metrics.rb', line 94

def self.host_realtime_metrics_to_hashes(metrics, nic_metrics)
  related_metrics = { }
  related_metrics[:nic]  = nic_metrics.group_by  { |m| m.history_datetime }

  metrics_to_hashes(metrics, related_metrics, HOST_COLUMN_DEFINITIONS, :host_metric_to_href)
end

.metrics_to_hashes(metrics, related_metrics, column_definitions, href_method) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/ovirt_metrics.rb', line 143

def self.metrics_to_hashes(metrics, related_metrics, column_definitions, href_method)
  counters_by_id              = {}
  counter_values_by_id_and_ts = {}

  metrics.each do |metric|
    options = { :metric => metric }
    related_metrics.each { |key, related_metric| options[key] = related_metric[metric.history_datetime] }

    href = self.send(href_method, metric)

    counters_by_id[href] ||= {}
    values = {}

    column_definitions.each do |evm_col, info|
      next if column_definitions == VM_COLUMN_DEFINITIONS && options[:metric].vm_status.to_i == VM_NOT_RUNNING

      counters_by_id[href][info[:ovirt_key]] ||= info[:counter]
      values[info[:ovirt_key]] = info[:ovirt_method].call(options)
    end

    counter_values_by_id_and_ts[href] ||= {}
    counter_values_by_id_and_ts[href][(metric.history_datetime).utc.iso8601] = values
    offsets = record_duplication_required?(metric) ? [0, 20, 40] : [0]
    offsets.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

.query_host_nic_realtime_metrics(host_id, start_time = nil, end_time = nil) ⇒ Object 



89
90
91
92
 
# File 'lib/ovirt_metrics.rb', line 89

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)
  HostInterfaceSamplesHistory.where(:host_interface_id => nic_ids).with_time_range(start_time, end_time)
end

.query_host_realtime_metrics(host_id, start_time = nil, end_time = nil) ⇒ Object

The methods below this line are PRIVATE not meant to be used out of the scope of this class. TODO refactor to force privacy or remove this line.



85
86
87
 
# File 'lib/ovirt_metrics.rb', line 85

def self.query_host_realtime_metrics(host_id, start_time = nil, end_time = nil)
  HostSamplesHistory.where(:host_id => host_id).includes(:host_configuration).with_time_range(start_time, end_time)
end

.query_vm_disk_realtime_metrics(vm_id, start_time = nil, end_time = nil) ⇒ Object 



105
106
107
108
 
# File 'lib/ovirt_metrics.rb', line 105

def self.query_vm_disk_realtime_metrics(vm_id, start_time = nil, end_time = nil)
  disk_ids = vms_disk_ids_for(vm_id)
  VmDiskSamplesHistory.where(:vm_disk_id => disk_ids).with_time_range(start_time, end_time)
end

.query_vm_nic_realtime_metrics(vm_id, start_time = nil, end_time = nil) ⇒ Object 



118
119
120
121
 
# File 'lib/ovirt_metrics.rb', line 118

def self.query_vm_nic_realtime_metrics(vm_id, start_time = nil, end_time = nil)
  nic_ids = vms_nic_ids_for(vm_id)
  VmInterfaceSamplesHistory.where(:vm_interface_id => nic_ids).with_time_range(start_time, end_time)
end

.query_vm_realtime_metrics(vm_id, start_time = nil, end_time = nil) ⇒ Object 



101
102
103
 
# File 'lib/ovirt_metrics.rb', line 101

def self.query_vm_realtime_metrics(vm_id, start_time = nil, end_time = nil)
  VmSamplesHistory.where(:vm_id => vm_id).includes(:host_configuration).with_time_range(start_time, end_time)
end

.record_duplication_required?(metric) ⇒ Boolean 



139
140
141
 
# File 'lib/ovirt_metrics.rb', line 139

def self.record_duplication_required?(metric)
  metric.try(:seconds_in_status) != 20
end

.vm_metric_to_href(metric) ⇒ Object 



131
132
133
 
# File 'lib/ovirt_metrics.rb', line 131

def self.vm_metric_to_href(metric)
  "/api/vms/#{metric.vm_id}"
end

.vm_realtime(vm_id, start_time = nil, end_time = nil) ⇒ Object 



63
64
65
66
67
68
 
# File 'lib/ovirt_metrics.rb', line 63

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)
  vm_realtime_metrics_to_hashes(metrics, disk_metrics, nic_metrics)
end

.vm_realtime_metrics_to_hashes(metrics, disk_metrics, nic_metrics) ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/ovirt_metrics.rb', line 123

def self.vm_realtime_metrics_to_hashes(metrics, disk_metrics, nic_metrics)
  related_metrics = { }
  related_metrics[:disk] = disk_metrics.group_by { |m| m.history_datetime }
  related_metrics[:nic]  = nic_metrics.group_by  { |m| m.history_datetime }

  metrics_to_hashes(metrics, related_metrics, VM_COLUMN_DEFINITIONS, :vm_metric_to_href)
end

.vms_disk_ids_for(vm_id) ⇒ Object 



110
111
112
 
# File 'lib/ovirt_metrics.rb', line 110

def self.vms_disk_ids_for(vm_id)
  VmDeviceHistory.where(:vm_id => vm_id).disks.attached.pluck('DISTINCT device_id')
end

.vms_nic_ids_for(vm_id) ⇒ Object 



114
115
116
 
# File 'lib/ovirt_metrics.rb', line 114

def self.vms_nic_ids_for(vm_id)
  VmDeviceHistory.where(:vm_id => vm_id).nics.attached.pluck("DISTINCT device_id")
end

.warn(message) ⇒ Object 



76
77
78
79
80
 
# File 'lib/ovirt_metrics.rb', line 76

def self.warn(message)
  unless config.suppress_warnings
    puts "#{message}  To hide this warning, use OvirtMetrics.config.suppress_warnings = true"
  end
end