ManageIQ/manageiq

View on GitHub
app/models/vm_or_template/right_sizing.rb

Summary

Maintainability
A
55 mins
Test Coverage
B
86%
module VmOrTemplate::RightSizing
  extend ActiveSupport::Concern

  included do
    virtual_column :aggressive_recommended_vcpus,              :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :aggressive_recommended_mem,                :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :aggressive_vcpus_recommended_change_pct,   :type => :float,      :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :aggressive_vcpus_recommended_change,       :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :aggressive_mem_recommended_change_pct,     :type => :float,      :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :aggressive_mem_recommended_change,         :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]

    virtual_column :moderate_recommended_vcpus,                :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :moderate_recommended_mem,                  :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :moderate_vcpus_recommended_change_pct,     :type => :float,      :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :moderate_vcpus_recommended_change,         :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :moderate_mem_recommended_change_pct,       :type => :float,      :uses => [:hardware, :vim_performance_operating_ranges]
    virtual_column :moderate_mem_recommended_change,           :type => :integer,    :uses => [:hardware, :vim_performance_operating_ranges]

    virtual_column :conservative_recommended_vcpus,            :type => :integer,    :uses => [:hardware]
    virtual_column :conservative_recommended_mem,              :type => :integer,    :uses => [:hardware]
    virtual_column :conservative_vcpus_recommended_change_pct, :type => :float,      :uses => [:hardware]
    virtual_column :conservative_vcpus_recommended_change,     :type => :integer,    :uses => [:hardware]
    virtual_column :conservative_mem_recommended_change_pct,   :type => :float,      :uses => [:hardware]
    virtual_column :conservative_mem_recommended_change,       :type => :integer,    :uses => [:hardware]

    # TODO: For backward compatibility - remove once reports are converted not to use these
    virtual_column :recommended_vcpus,                    :type => :integer,    :uses => :aggressive_recommended_vcpus
    virtual_column :recommended_mem,                      :type => :integer,    :uses => :aggressive_recommended_mem
    virtual_column :overallocated_vcpus_pct,              :type => :float,      :uses => :aggressive_vcpus_recommended_change_pct
    virtual_column :overallocated_mem_pct,                :type => :float,      :uses => :aggressive_mem_recommended_change_pct

    virtual_column :max_cpu_usage_rate_average_max_over_time_period,     :type => :float
    virtual_column :max_mem_usage_absolute_average_max_over_time_period, :type => :float

    virtual_attribute :cpu_usagemhz_rate_average_max_over_time_period,
                      :float, :arel => metric_rollup_vattr_arel(:cpu_usagemhz_rate_average)
    virtual_attribute :derived_memory_used_max_over_time_period,
                      :float, :arel => metric_rollup_vattr_arel(:derived_memory_used)
  end

  module ClassMethods
    def metric_rollup_vattr_arel(col)
      lambda do |t|
        metric_rollup_table = MetricRollup.arel_table
        select_clause = metric_rollup_table[col].maximum

        now       = Time.now.utc
        timestamp = (now - 30.days).utc..now
        tp_ids    = TimeProfile.default_time_profile(nil)
                               .profile_for_each_region
                               .pluck(:id)

        where_clause =
          metric_rollup_table[:time_profile_id].in(tp_ids)
            .and(metric_rollup_table[:capture_interval_name].eq("daily"))
            .and(metric_rollup_table[:timestamp].between(timestamp))
            .and(metric_rollup_table[:resource_type].eq("VmOrTemplate"))
            .and(metric_rollup_table[:resource_id].eq(t[:id]))

        t.grouping(
          metric_rollup_table.project(select_clause)
                             .where(where_clause)
        )
      end
    end

    def cpu_recommendation_minimum
      ::Settings.recommendations.cpu_minimum
    end

    def mem_recommendation_minimum
      min = ::Settings.recommendations.mem_minimum.to_i_with_method
      min / 1.megabyte
    end
  end

  RIGHT_SIZING_VCOLS = [
    :aggressive_recommended_vcpus,
    :aggressive_recommended_mem,
    :aggressive_vcpus_recommended_change_pct,
    :aggressive_vcpus_recommended_change,
    :aggressive_mem_recommended_change_pct,
    :aggressive_mem_recommended_change,

    :moderate_recommended_vcpus,
    :moderate_recommended_mem,
    :moderate_vcpus_recommended_change_pct,
    :moderate_vcpus_recommended_change,
    :moderate_mem_recommended_change_pct,
    :moderate_mem_recommended_change,

    :conservative_recommended_vcpus,
    :conservative_recommended_mem,
    :conservative_vcpus_recommended_change_pct,
    :conservative_vcpus_recommended_change,
    :conservative_mem_recommended_change_pct,
    :conservative_mem_recommended_change,

    :recommended_vcpus,
    :recommended_mem,
    :overallocated_vcpus_pct,
    :overallocated_mem_pct,

    :max_cpu_usage_rate_average_max_over_time_period,
    :max_mem_usage_absolute_average_max_over_time_period,
    :cpu_usagemhz_rate_average_max_over_time_period,
    :derived_memory_used_max_over_time_period
  ]

  RIGHT_SIZING_MODES = {
    :aggressive   => {:mem => :max_mem_usage_absolute_average_avg_over_time_period,  :cpu => :max_cpu_usage_rate_average_avg_over_time_period},
    :moderate     => {:mem => :max_mem_usage_absolute_average_high_over_time_period, :cpu => :max_cpu_usage_rate_average_high_over_time_period},
    :conservative => {:mem => :max_mem_usage_absolute_average_max_over_time_period,  :cpu => :max_cpu_usage_rate_average_max_over_time_period},
  }
  MEMORY_RECOMMENDATION_ROUND_TO_NEAREST = 4

  RIGHT_SIZING_MODES.each do |mode, meth|
    define_method(:"#{mode}_recommended_vcpus") do
      base_recommended(send(meth[:cpu]), cpu_total_cores, self.class.cpu_recommendation_minimum)  unless cpu_total_cores.nil?
    end

    define_method(:"#{mode}_recommended_mem") do
      base_recommended(send(meth[:mem]), ram_size, self.class.mem_recommendation_minimum, MEMORY_RECOMMENDATION_ROUND_TO_NEAREST) unless ram_size.nil?
    end

    define_method(:"#{mode}_vcpus_recommended_change_pct") do
      base_change_percentage(send(:"#{mode}_recommended_vcpus"), cpu_total_cores) unless cpu_total_cores.nil?
    end

    define_method(:"#{mode}_mem_recommended_change_pct") do
      base_change_percentage(send(:"#{mode}_recommended_mem"), ram_size) unless ram_size.nil?
    end

    define_method(:"#{mode}_vcpus_recommended_change") do
      base_change(send(:"#{mode}_recommended_vcpus"), cpu_total_cores) unless cpu_total_cores.nil?
    end

    define_method(:"#{mode}_mem_recommended_change") do
      base_change(send(:"#{mode}_recommended_mem"), ram_size) unless ram_size.nil?
    end
  end

  #####################################################
  # BACKWARD COMPATIBILITY for REPORTS THAT USE THESE
  #####################################################
  alias_method :recommended_vcpus,       :aggressive_recommended_vcpus
  alias_method :recommended_mem,         :aggressive_recommended_mem
  alias_method :overallocated_vcpus_pct, :aggressive_vcpus_recommended_change_pct
  alias_method :overallocated_mem_pct,   :aggressive_mem_recommended_change_pct

  def max_cpu_usage_rate_average_max_over_time_period
    end_date = Time.now.utc.beginning_of_day - 1
    perfs = VimPerformanceAnalysis.find_perf_for_time_period(self, "daily", :end_date => end_date, :days => Metric::LongTermAverages::AVG_DAYS)
    perfs.collect do |p|
      # Ignore any CPU bursts to 100% 15 minutes after VM booted
      next if (p.abs_max_cpu_usage_rate_average_value == 100.0) && boot_time && (p.abs_max_cpu_usage_rate_average_timestamp <= (boot_time + 15.minutes))

      p.abs_max_cpu_usage_rate_average_value
    end.compact.max
  end
  alias_method :cpu_usage_rate_average_max_over_time_period, :max_cpu_usage_rate_average_max_over_time_period

  def max_mem_usage_absolute_average_max_over_time_period
    end_date = Time.now.utc.beginning_of_day - 1
    perfs = VimPerformanceAnalysis.find_perf_for_time_period(self, "daily", :end_date => end_date, :days => Metric::LongTermAverages::AVG_DAYS)
    perfs.collect(&:abs_max_mem_usage_absolute_average_value).compact.max
  end
  alias_method :mem_usage_absolute_average_max_over_time_period, :max_mem_usage_absolute_average_max_over_time_period

  def cpu_usagemhz_rate_average_max_over_time_period
    end_date = Time.now.utc.beginning_of_day - 1
    perfs = VimPerformanceAnalysis.find_perf_for_time_period(self, "daily", :end_date => end_date, :days => Metric::LongTermAverages::AVG_DAYS)
    perfs.collect(&:abs_max_cpu_usagemhz_rate_average_value).compact.max
  end

  def derived_memory_used_max_over_time_period
    end_date = Time.now.utc.beginning_of_day - 1
    perfs = VimPerformanceAnalysis.find_perf_for_time_period(self, "daily", :end_date => end_date, :days => Metric::LongTermAverages::AVG_DAYS)
    perfs.collect(&:abs_max_derived_memory_used_value).compact.max
  end

  private

  def base_recommended(max, actual, min = nil, round_to_nearest = nil)
    return if actual.nil? || max.nil?

    recommendation = ((actual * max / 100.0) + 0.1).ceil
    recommendation = recommendation.round_up(round_to_nearest) if round_to_nearest.kind_of?(Numeric)
    recommendation = [recommendation, min].max if min.kind_of?(Numeric)
    recommendation
  end

  def base_change(recommended, actual)
    return if actual.nil? || recommended.nil?

    actual - recommended
  end

  def base_change_percentage(recommended, actual)
    return if actual.nil? || recommended.nil?
    return 0 if recommended == 0

    div = (actual.to_f / recommended.to_f)
    return 0 if div == 0

    ((1 - (1 / div)) * 1000).round / 10.0
  end
end