foreman_statistics 0.1.0

data/README.md

@@ -0,0 +1,40 @@
+![CI](https://github.com/theforeman/foreman_statistics/workflows/CI/badge.svg)
+
+# ForemanStatistics
+
+*Introdction here*
+
+## Installation
+
+See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
+for how to install Foreman plugins
+
+## Usage
+
+*Usage here*
+
+## TODO
+
+*Todo list here*
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) *year* *your name*
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanStatistics'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/controllers/concerns/foreman_statistics/parameters/trend.rb

@@ -0,0 +1,20 @@
+module ForemanStatistics
+  module Parameters::Trend
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def trend_params_filter
+        Foreman::ParameterFilter.new(Trend).tap do |filter|
+          filter.permit :fact_value, :fact_name,
+            :name,
+            :trendable_type, :trendable_id,
+            :type
+        end
+      end
+    end
+
+    def trend_params
+      self.class.trend_params_filter.filter_params(params, parameter_filter_context)
+    end
+  end
+end

data/app/controllers/foreman_statistics/api/v2/statistics_controller.rb

@@ -0,0 +1,33 @@
+module ForemanStatistics
+  module Api
+    module V2
+      class StatisticsController < ::Api::V2::BaseController
+        resource_description do
+          api_version 'v2'
+          api_base_url '/foreman_statistics/api'
+        end
+
+        api :GET, '/statistics/', N_('Get statistics')
+
+        def index
+          @os_count    = Host.authorized(:view_hosts).count_distribution :operatingsystem
+          @arch_count  = Host.authorized(:view_hosts).count_distribution :architecture
+          @env_count   = Host.authorized(:view_hosts).count_distribution :environment
+          @klass_count = Host.authorized(:view_hosts).count_habtm 'puppetclass'
+          @cpu_count   = FactValue.authorized(:view_facts).my_facts.count_each 'processorcount'
+          @model_count = FactValue.authorized(:view_facts).my_facts.count_each 'manufacturer'
+          @mem_size    = FactValue.authorized(:view_facts).my_facts.mem_average 'memorysize'
+          @mem_free    = FactValue.authorized(:view_facts).my_facts.mem_average 'memoryfree'
+          @swap_size   = FactValue.authorized(:view_facts).my_facts.mem_average 'swapsize'
+          @swap_free   = FactValue.authorized(:view_facts).my_facts.mem_average 'swapfree'
+          @mem_totsize = FactValue.authorized(:view_facts).my_facts.mem_sum 'memorysize'
+          @mem_totfree = FactValue.authorized(:view_facts).my_facts.mem_sum 'memoryfree'
+          render :json => { :os_count => @os_count, :arch_count => @arch_count, :swap_size => @swap_size,
+                            :env_count => @env_count, :klass_count => @klass_count, :cpu_count => @cpu_count,
+                            :model_count => @model_count, :mem_size => @mem_size, :mem_free => @mem_free,
+                            :swap_free => @swap_free, :mem_totsize => @mem_totsize, :mem_totfree => @mem_totfree }
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_statistics/api/v2/trends_controller.rb

@@ -0,0 +1,58 @@
+module ForemanStatistics
+  module Api
+    module V2
+      class TrendsController < ::Api::V2::BaseController
+        include ForemanStatistics::Parameters::Trend
+
+        before_action :find_resource, :only => %i[show destroy]
+
+        TRENDABLE_TYPES = %w[
+          Environment Operatingsystem Model FactName Hostgroup
+          ComputeResource
+        ].freeze
+
+        resource_description do
+          api_version 'v2'
+          api_base_url '/foreman_statistics/api'
+        end
+
+        api :GET, '/trends/', N_('List of trends counters')
+        def index
+          @trends = resource_scope_for_index
+        end
+
+        api :GET, '/trends/:id/', N_('Show a trend')
+        param :id, :identifier, :required => true
+        def show; end
+
+        api :POST, '/trends/', N_('Create a trend counter')
+        param :trendable_type, TRENDABLE_TYPES, :required => true
+        param :fact_name, String, :required => false
+        param :name, String, :required => false
+        def create
+          @trend = ForemanStatistics::Trend.build_trend(trend_params)
+          if @trend.save
+            process_success
+          else
+            process_resource_error
+          end
+        end
+
+        api :DELETE, '/trends/:id/', N_('Delete a trend counter')
+        param :id, :identifier, :required => true
+        def destroy
+          process_response @trend.destroy
+        end
+
+        # Overload this method to avoid using search_for method
+        def resource_scope_for_index(options = {})
+          resource_scope(options).paginate(paginate_options)
+        end
+
+        def resource_scope(options = {})
+          @resource_scope ||= scope_for(ForemanStatistics::Trend.types, options)
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_statistics/react_controller.rb

@@ -0,0 +1,19 @@
+module ForemanStatistics
+  class ReactController < ::ApplicationController
+    layout 'foreman_statistics/layouts/application_react'
+
+    def index
+      render html: nil, layout: true
+    end
+
+    private
+
+    def controller_permission
+      :foreman_statistics
+    end
+
+    def action_permission
+      :view
+    end
+  end
+end

data/app/controllers/foreman_statistics/statistics_controller.rb

@@ -0,0 +1,24 @@
+module ForemanStatistics
+  class StatisticsController < ::ApplicationController
+    before_action :find_stat, :only => [:show]
+
+    def index
+      render :json => { :charts => charts.map(&:metadata) }
+    end
+
+    def show
+      render :json => @stat.metadata.merge(:data => @stat.calculate.map(&:values))
+    end
+
+    private
+
+    def find_stat
+      @stat = charts.detect { |ch| ch.id.to_s == params[:id] }
+      @stat || not_found
+    end
+
+    def charts
+      ForemanStatistics::Statistics.charts(Organization.current.try(:id), Location.current.try(:id))
+    end
+  end
+end

data/app/controllers/foreman_statistics/trends_controller.rb

@@ -0,0 +1,58 @@
+module ForemanStatistics
+  class TrendsController < ApplicationController
+    include Parameters::Trend
+
+    before_action :find_resource, :only => %i[show edit update destroy]
+
+    def index
+      @trends = Trend.types.includes(:trendable).sort_by { |e| e.type_name.downcase }.paginate(:page => params[:page], :per_page => params[:per_page])
+    end
+
+    def new
+      @trend = Trend.new
+    end
+
+    def show
+      render 'foreman_statistics/trends/_empty_data' if @trend.values.joins(:trend_counters).empty?
+    end
+
+    def create
+      @trend = Trend.build_trend(trend_params)
+      if @trend.save
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def update
+      filter = self.class.trend_params_filter
+      trend_attrs = params[:trend].values.map { |t| filter.filter_params(ActionController::Parameters.new(t), parameter_filter_context, :none) }
+      @trends = Trend.update(params[:trend].keys, trend_attrs).reject { |p| p.errors.empty? }
+      if @trends.empty?
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def edit; end
+
+    def destroy
+      if @trend.destroy
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def count
+      ForemanStatistics::TrendImporter.update!
+      redirect_to trends_url
+    end
+
+    def resource_class
+      ForemanStatistics::Trend
+    end
+  end
+end

data/app/helpers/foreman_statistics/trends_helper.rb

@@ -0,0 +1,53 @@
+module ForemanStatistics
+  module TrendsHelper
+    include ::CommonParametersHelper
+
+    def trendable_types
+      options = { _('Environment') => 'Environment', _('Operating system') => 'Operatingsystem',
+                  _('Model') => 'Model', _('Facts') => 'FactName', _('Host group') => 'Hostgroup', _('Compute resource') => 'ComputeResource' }
+      existing = ForemanTrend.types.pluck(:trendable_type)
+      options.delete_if { |_k, v| existing.include?(v) }
+    end
+
+    def trend_days_filter(trend)
+      form_tag trend, :id => 'days_filter', :method => :get, :class => 'form form-inline' do
+        content_tag(:span, (_('Trend of the last %s days.') %
+                            select(nil, 'range', 1..Setting[:max_trend], { :selected => range },
+                              { :onchange => "$('#days_filter').submit();$(this).attr('disabled','disabled');;" })).html_safe)
+      end
+    end
+
+    def trend_title(trend)
+      if trend.fact_value.blank?
+        trend.to_label
+      else
+        "#{trend.type_name} - #{trend.to_label}"
+      end
+    end
+
+    def chart_data(trend, from = Setting[:max_trend], _to = Time.now.utc)
+      chart_colors = ['#4572A7', '#AA4643', '#89A54E', '#80699B', '#3D96AE', '#DB843D', '#92A8CD', '#A47D7C', '#B5CA92']
+      values = trend.values
+      labels = {}
+      values.includes(:trendable).each { |v| labels[v.id] = [CGI.escapeHTML(v.to_label), trend_path(:id => v)] }
+      values.includes(:trend_counters).where(['trend_counters.interval_end > ? or trend_counters.interval_end is null', from])
+            .reorder('trend_counters.interval_start')
+            .each_with_index.map do |value, idx|
+        data = []
+        value.trend_counters.each do |counter|
+          # cut the left side of the graph
+          interval_start = (counter.interval_start || from) > from ? counter.interval_start : from
+          next_timestamp = counter.try(:interval_end) || Time.now.utc
+          # transform the timestamp values to flot format - from seconds in Ruby to milliseconds in flot
+          data << [interval_start.to_i * 1000, counter.count]
+          data << [next_timestamp.to_i * 1000 - 1, counter.count]
+        end
+        { :label => labels[value.id][0], :href => labels[value.id][1], :data => data, :color => chart_colors[idx % chart_colors.size] } unless data.empty?
+      end.compact
+    end
+
+    def range
+      params['range'].empty? ? Setting[:max_trend] : params['range'].to_i
+    end
+  end
+end

data/app/models/concerns/foreman_statistics/compute_resource_decorations.rb

@@ -0,0 +1,9 @@
+module ForemanStatistics
+  module ComputeResourceDecorations
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :trends, :as => :trendable, :class_name => 'ForemanStatistics::ForemanTrend'
+    end
+  end
+end

data/app/models/concerns/foreman_statistics/environment_decorations.rb

@@ -0,0 +1,9 @@
+module ForemanStatistics
+  module EnvironmentDecorations
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :trends, :as => :trendable, :class_name => 'ForemanStatistics::ForemanTrend'
+    end
+  end
+end

data/app/models/concerns/foreman_statistics/general_setting_decorations.rb

@@ -0,0 +1,17 @@
+module ForemanStatistics
+  module GeneralSettingDecorations
+    def self.prepended(base)
+      class << base
+        prepend ClassMethodsPrepend
+      end
+    end
+
+    module ClassMethodsPrepend
+      def default_settings
+        super.concat([
+                       set('max_trend', N_('Max days for Trends graphs'), 30, N_('Max trends'))
+                     ])
+      end
+    end
+  end
+end

data/app/models/concerns/foreman_statistics/hostgroup_decorations.rb

@@ -0,0 +1,9 @@
+module ForemanStatistics
+  module HostgroupDecorations
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :trends, :as => :trendable, :class_name => 'ForemanStatistics::ForemanTrend'
+    end
+  end
+end

data/app/models/concerns/foreman_statistics/model_decorations.rb

@@ -0,0 +1,9 @@
+module ForemanStatistics
+  module ModelDecorations
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :trends, :as => :trendable, :class_name => 'ForemanStatistics::ForemanTrend'
+    end
+  end
+end

data/app/models/concerns/foreman_statistics/operatingsystem_decorations.rb

@@ -0,0 +1,9 @@
+module ForemanStatistics
+  module OperatingsystemDecorations
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :trends, :as => :trendable, :class_name => 'ForemanStatistics::ForemanTrend'
+    end
+  end
+end

data/app/models/concerns/foreman_statistics/setting_decorations.rb

@@ -0,0 +1,9 @@
+module ForemanStatistics
+  module SettingDecorations
+    extend ActiveSupport::Concern
+
+    included do
+      Setting::NONZERO_ATTRS.push('max_trend')
+    end
+  end
+end