foreman_monitoring 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64c6df30e7204048fc85d7ce4e6de17ba28d14c5
-  data.tar.gz: 3e14672d74d600a9e05aff1a92846b804c07aa0b
+  metadata.gz: 3d9186b9fa48b695bea2617e3c589b22d0df22bd
+  data.tar.gz: f3dd5db766d37990e59d09ffdf9881a830abc134
 SHA512:
-  metadata.gz: 8e37b4565ae23bc25f9319ce81737751eb95cf1ebe11840aad9499cbacf37445447eb784d6c95a8022702effc2cf751748ee109b41f621960daf8a245d88eb52
-  data.tar.gz: ceb07dd17ccef4baf8311faa60afbfb8ad03a73c2b842eb7fb9dcfeb1865de4feebb9448292cc1e5c46f43f76db08c877a0484c56d63b53ee4d20e3c6c6e7b7a
+  metadata.gz: 25700b1a96cebf6cfb1e829b54dfef9f6fd6f934ffbbd1e8a9fa753ee9e51f0a406c478c0bdba8e8cd2b46bbeaf5ae3d2be0a06da9524ea77740b8e042e32f61
+  data.tar.gz: 1f714e3081f6adeb50b7f01f30c6855dc237f3613210993719fc0f0d97ed34828190f58c784e9ac93a6afb6c54d2049c1bd5b82f7e76d088553b3af7ae8f1479

data/README.md

@@ -1,14 +1,41 @@
 # Foreman Monitoring Plugin
 
 This is a Foreman plugin for monitoring system integration.
+It allows to manage hosts and downtimes and to display status
+information from the monitoring solution.
+
+It requires the Smart Proxy plugin [monitoring](https://github.com/theforeman/smart_proxy_monitoring)
+for communication with the monitoring system. See its documentation
+for supported monitoring solutions and detailed configuration instructions.
 
 # 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
+for how to install Foreman plugins.
+
+The gem name is `foreman_monitoring`.
+
+RPM users can install the `tfm-rubygem-foreman_monitoring` package.
+
+This plug-in has not been packaged for Debian, yet.
 
 # Usage
 
+For managing a host in the monitoring solution a Smart Proxy providing
+the `monitoring` feature has to be assigned. This can be done during
+provisioning or as a bulk action from the host overview.
+
+You can configure the default action which will be done during host
+provisioning and deprovisioning. Provisioning allows to create a monitoring
+object or take no action while deprovisioing allows to delete the monitoring
+object, set a downtime or take no action. For rebuild it will by default
+set a downtime.
+
+The plugin will show you the monitoring status as a sub-status and a detail
+panel. You can configure if the sub-status should affect the global status.
+
+Furthermore it allows to individually set a downtime at the host detail view
+or as a bulk action from the host overview.
 
 ## Contributing
 

data/app/controllers/api/v2/monitoring_results_controller.rb

@@ -6,6 +6,14 @@ module Api
 
       add_smart_proxy_filters :create, :features => 'Monitoring'
 
+      api :POST, '/monitoring_results', N_('Import monitoring result')
+      param :host, String, :desc => N_('FQDN of the host that the results are for'), :required => true
+      param :service, String, :desc => N_('Name of the service the results belong to'), :required => true
+      param :timestamp, String, :desc => N_('Timestamp of the results')
+      param :acknowledged, [true, false], :desc => N_('Is the result acknowledged?')
+      param :downtime, [true, false], :desc => N_('Is the result in downtime?')
+      param :result, [0, 1, 2, 3], :desc => N_('State of the monitoring result (0 -> ok, 1 -> warning, 2 -> critical, 3 -> unknown)')
+
       def create
         begin
           MonitoringResult.import(monitoring_result_params.with_indifferent_access)

data/app/controllers/concerns/foreman_monitoring/hosts_controller_extensions.rb

@@ -0,0 +1,140 @@
+module ForemanMonitoring
+  module HostsControllerExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :find_resource_with_monitoring, :only => [:downtime]
+      before_action :find_multiple_with_monitoring, :only => [:select_multiple_downtime, :update_multiple_downtime,
+                                                              :select_multiple_monitoring_proxy, :update_multiple_monitoring_proxy]
+      before_action :validate_host_downtime_params, :only => [:downtime]
+      before_action :validate_hosts_downtime_params, :only => [:update_multiple_downtime]
+      before_action :validate_multiple_monitoring_proxy, :only => :update_multiple_monitoring_proxy
+
+      alias_method :find_resource_with_monitoring, :find_resource
+      alias_method :find_multiple_with_monitoring, :find_multiple
+      alias_method_chain :update_multiple_power_state, :monitoring
+    end
+
+    def downtime
+      unless @host.downtime_host(downtime_options)
+        process_error(:redirect => host_path, :error_msg => @host.errors.full_messages.to_sentence)
+        return false
+      end
+      process_success :success_msg => _('Created downtime for %s') % (@host), :success_redirect => :back
+    end
+
+    def select_multiple_downtime
+    end
+
+    def update_multiple_downtime
+      failed_hosts = {}
+
+      @hosts.each do |host|
+        unless host.monitored?
+          failed_hosts[host.name] = _('is not monitored')
+          next
+        end
+        begin
+          unless host.downtime_host(downtime_options)
+            error_message = host.errors.full_messages.to_sentence
+            failed_hosts[host.name] = error_message
+            logger.error "Failed to set a host downtime for #{host}: #{error_message}"
+          end
+        rescue => error
+          failed_hosts[host.name] = error
+          Foreman::Logging.exception(_('Failed to set a host downtime for %s.') % host, error)
+        end
+      end
+
+      if failed_hosts.empty?
+        notice _('A downtime was set for the selected hosts.')
+      else
+        error n_('A downtime clould not be set for host: %s.',
+                 'A downtime could not be set for hosts: %s.',
+                 failed_hosts.count) % failed_hosts.map { |h, err| "#{h} (#{err})" }.to_sentence
+      end
+      redirect_back_or_to hosts_path
+    end
+
+    def validate_multiple_monitoring_proxy
+      validate_multiple_proxy(select_multiple_monitoring_proxy_hosts_path)
+    end
+
+    def select_multiple_monitoring_proxy
+    end
+
+    def update_multiple_monitoring_proxy
+      update_multiple_proxy(_('Monitoring'), :monitoring_proxy=)
+    end
+
+    def update_multiple_power_state_with_monitoring
+      options = {
+        :comment => 'Power state changed in Foreman',
+        :author => "Foreman User #{User.current}",
+        :start_time => DateTime.now.to_time.to_i,
+        :end_time => DateTime.now.advance(:minutes => 30).to_time.to_i
+      }
+      if User.current.allowed_to?(:controller => :hosts, :action => :select_multiple_downtime) && params[:power][:set_downtime]
+        @hosts.each do |host|
+          unless host.monitored?
+            logger.debug "Not setting a downtime for #{host} as it is not monitored."
+            next
+          end
+          if host.downtime_host(options)
+            logger.debug "Set a host downtime for #{host}."
+          else
+            logger.error "Failed to set a host downtime for #{host}: #{host.errors.full_messages.to_sentence}"
+          end
+        end
+      end
+      update_multiple_power_state_without_monitoring
+    end
+
+    private
+
+    def downtime_options
+      {
+        :comment => params[:downtime][:comment],
+        :author => "Foreman User #{User.current}",
+        :start_time => DateTime.parse(params[:downtime][:starttime]).to_time.to_i,
+        :end_time => DateTime.parse(params[:downtime][:endtime]).to_time.to_i
+      }
+    end
+
+    def validate_host_downtime_params
+      validate_downtime_params(host_path)
+    end
+
+    def validate_hosts_downtime_params
+      validate_downtime_params(hosts_path)
+    end
+
+    def validate_downtime_params(redirect_url)
+      if params[:downtime].blank? || (params[:downtime][:comment]).blank?
+        process_error(:redirect => redirect_url, :error_msg => 'No comment for downtime set!')
+        return false
+      end
+      if (params[:downtime][:starttime]).blank? || (params[:downtime][:endtime]).blank?
+        process_error(:redirect => redirect_url, :error_msg => 'No start/endtime for downtime!')
+        return false
+      end
+      begin
+        DateTime.parse(params[:downtime][:starttime])
+        DateTime.parse(params[:downtime][:endtime])
+      rescue ArgumentError
+        process_error(:redirect => redirect_url, :error_msg => 'Invalid start/endtime for downtime!')
+        return false
+      end
+    end
+
+    def action_permission
+      case params[:action]
+      when 'downtime', 'select_multiple_downtime', 'update_multiple_downtime',
+        'select_multiple_monitoring_proxy', 'update_multiple_monitoring_proxy'
+        :downtime
+      else
+        super
+      end
+    end
+  end
+end

data/app/helpers/concerns/foreman_monitoring/hosts_helper_ext.rb

@@ -2,18 +2,35 @@ module ForemanMonitoring
   module HostsHelperExt
     extend ActiveSupport::Concern
 
-    # included do
-    #  alias_method_chain :host_title_actions, :monitoring
-    # end
+    included do
+      alias_method_chain :host_title_actions, :monitoring
+      alias_method_chain :multiple_actions, :monitoring
+    end
+
+    def multiple_actions_with_monitoring
+      return multiple_actions_without_monitoring unless authorized_for(:controller => :hosts, :action => :select_multiple_downtime)
+      multiple_actions_without_monitoring + [[_('Set downtime'), select_multiple_downtime_hosts_path], [_('Change Monitoring Proxy'), select_multiple_monitoring_proxy_hosts_path]]
+    end
 
-    # def host_title_actions_with_monitoring(host)
-    #  title_actions(
-    #    button_group(
-    #      link_to(_('Monitoring'), monitoring_show_host_path(host), :target => '_blank', :class => 'btn btn-default')
-    #    )
-    #  )
-    #  host_title_actions_without_monitoring(host)
-    # end
+    def host_title_actions_with_monitoring(host)
+      title_actions(
+        button_group(
+          display_link_if_authorized(_('Downtime'),
+                                     hash_for_host_path(:id => host).merge(:auth_object => host,
+                                                                           :permission => :manage_host_downtimes,
+                                                                           :anchor => 'set_host_downtime'),
+                                     :class => 'btn btn-default',
+                                     :disabled => !host.monitored?,
+                                     :title    => _('Set a downtime for this host'),
+                                     :id       => 'host-downtime',
+                                     :data     => { :toggle => 'modal',
+                                                    :target => '#set_host_downtime'
+                                                  }
+                                    )
+        )
+      )
+      host_title_actions_without_monitoring(host)
+    end
 
     def host_monitoring_result_icon_class(result)
       icon_class = case result
@@ -42,5 +59,12 @@ module ForemanMonitoring
         'status-question'
       end
     end
+
+    def datetime_f(f, attr, options = {})
+      field(f, attr, options) do
+        addClass options, 'form-control'
+        f.datetime_local_field attr, options
+      end
+    end
   end
 end

data/app/lib/proxy_api/monitoring.rb

@@ -10,5 +10,40 @@ module ProxyAPI
     rescue => e
       raise ProxyException.new(url, e, N_('Unable to set downtime for %s') % host)
     end
+
+    def remove_host_downtime(host, args = {})
+      parse(delete("downtime/host/#{host}?#{args.to_query}"))
+    rescue => e
+      raise ProxyException.new(url, e, N_('Unable to remove downtime for %s') % host)
+    end
+
+    def create_host(host, attributes = {})
+      parse(put({:attributes => attributes}, "host/#{host}"))
+    rescue => e
+      raise ProxyException.new(url, e, N_('Unable to create monitoring host object for %s') % host)
+    end
+
+    def update_host(host, attributes = {})
+      parse(post({:attributes => attributes}, "host/#{host}"))
+    rescue => e
+      raise ProxyException.new(url, e, N_('Unable to update monitoring host object for %s') % host)
+    end
+
+    def delete_host(host)
+      raise Foreman::Exception.new('Missing hostname.') if host.blank?
+      parse(delete("host/#{host}"))
+    rescue RestClient::ResourceNotFound
+      true
+    rescue => e
+      raise ProxyException.new(url, e, N_('Unable to delete monitoring host object for %s') % host)
+    end
+
+    def query_host(host)
+      parse(get("host/#{host}"))
+    rescue RestClient::ResourceNotFound
+      nil
+    rescue => e
+      raise ProxyException.new(url, e, N_('Unable to query monitoring host object for %s') % host)
+    end
   end
 end

data/app/models/concerns/foreman_monitoring/host_extensions.rb

@@ -2,10 +2,14 @@ module ForemanMonitoring
   module HostExtensions
     extend ActiveSupport::Concern
     included do
-      before_destroy :downtime_host_destroy
+      include Orchestration::Monitoring
+
       after_build :downtime_host_build
 
-      has_many :monitoring_results, :foreign_key => 'host_id'
+      alias_method_chain :smart_proxy_ids, :monitoring_proxy
+      alias_method_chain :hostgroup_inherited_attributes, :monitoring
+
+      has_many :monitoring_results, :dependent => :destroy, :foreign_key => 'host_id'
     end
 
     def monitoring_status(options = {})
@@ -24,19 +28,55 @@ module ForemanMonitoring
       downtime_host(:comment => _('Host rebuilt in Foreman'))
     end
 
-    def downtime_host_destroy
-      downtime_host(:comment => _('Host deleted in Foreman'))
-    end
-
     def downtime_host(options)
-      return unless monitoring_results.any?
+      return unless monitored?
       begin
-        monitoring = Monitoring.new
         monitoring.set_downtime_host(self, options)
       rescue ProxyAPI::ProxyException => e
         errors.add(:base, _("Error setting downtime: '%s'") % e.message)
       end
       errors.empty?
     end
+
+    def monitored?
+      monitoring_proxy.present?
+    end
+
+    def hostgroup_inherited_attributes_with_monitoring
+      hostgroup_inherited_attributes_without_monitoring + ['monitoring_proxy_id']
+    end
+
+    def smart_proxy_ids_with_monitoring_proxy
+      ids = smart_proxy_ids_without_monitoring_proxy
+      [monitoring_proxy, hostgroup.try(:monitoring_proxy)].compact.each do |proxy|
+        ids << proxy.id
+      end
+      ids
+    end
+
+    def monitoring_attributes
+      {
+        :ip => ip,
+        :ip6 => ip6,
+        :architecture => architecture.try(:name),
+        :os => operatingsystem.try(:to_label),
+        :osfamily => operatingsystem.try(:family),
+        :virtual => provider != 'BareMetal',
+        :provider => provider,
+        :compute_resource => compute_resource.try(:to_label),
+        :hostgroup => hostgroup.try(:to_label),
+        :organization => organization.try(:name),
+        :location => organization.try(:name),
+        :comment => comment,
+        :environment => environment.try(:to_s),
+        :owner_name => owner.try(:name)
+      }
+    end
+
+    private
+
+    def monitoring
+      Monitoring.new(:monitoring_proxy => monitoring_proxy)
+    end
   end
 end

data/app/models/concerns/foreman_monitoring/hostgroup_extensions.rb

@@ -0,0 +1,15 @@
+module ForemanMonitoring
+  module HostgroupExtensions
+    extend ActiveSupport::Concern
+
+    def monitoring_proxy
+      return super unless ancestry.present?
+      SmartProxy.find_by_id(inherited_monitoring_proxy_id)
+    end
+
+    def inherited_monitoring_proxy_id
+      return monitoring_proxy_id unless ancestry.present?
+      self[:monitoring_proxy_id] || self.class.sort_by_ancestry(ancestors.where('monitoring_proxy_id is not NULL')).last.try(:monitoring_proxy_id)
+    end
+  end
+end

data/app/models/concerns/orchestration/monitoring.rb

@@ -0,0 +1,105 @@
+module Orchestration::Monitoring
+  extend ActiveSupport::Concern
+
+  included do
+    after_validation :queue_monitoring
+    before_destroy :queue_monitoring_destroy
+  end
+
+  protected
+
+  def queue_monitoring
+    return unless monitored? && errors.empty?
+    clear_monitoring_object
+    !monitoring_object.has_key?(:attrs) ? queue_monitoring_create : queue_monitoring_update
+  end
+
+  def queue_monitoring_create
+    queue.create(:name   => _("Create monitoring object for %s") % self, :priority => 20,
+                 :action => [self, :setMonitoring]) if ::Monitoring.create_action?(:create)
+  end
+
+  def queue_monitoring_update
+    return unless monitoring_update_required?(monitoring_object[:attrs], monitoring_attributes)
+    Rails.logger.debug("Detected a change to the monitoring object is required.")
+    queue.create(:name   => _("Monitoring update for %s") % old, :priority => 2,
+                 :action => [self, :setMonitoringUpdate]) if ::Monitoring.create_action?(:create)
+  end
+
+  def queue_monitoring_destroy
+    return unless monitored? && errors.empty?
+    queue.create(:name   => _("Removing monitoring object for %s") % self, :priority => 2,
+                 :action => [self, :delMonitoring]) if ::Monitoring.delete_action?(:delete)
+    queue.create(:name   => _("Set monitoring downtime for %s") % self, :priority => 2,
+                 :action => [self, :setMonitoringDowntime]) if ::Monitoring.delete_action?(:downtime)
+  end
+
+  def setMonitoring
+    Rails.logger.info "Adding Monitoring object for #{name}"
+    monitoring.create_host(self)
+  rescue => e
+    failure _("Failed to create a monitoring object %{name}: %{message}\n ") % { :name => name, :message => e.message }, e
+  end
+
+  def delMonitoring
+    Rails.logger.info "Deleting Monitoring object for #{name}"
+    monitoring.delete_host(self)
+  rescue => e
+    failure _("Failed to delete a monitoring object %{name}: %{message}\n ") % { :name => name, :message => e.message }, e
+  end
+
+  def setMonitoringUpdate
+    Rails.logger.info "Updating Monitoring object for #{name}"
+    monitoring.update_host(self)
+  rescue => e
+    failure _("Failed to update a monitoring object %{name}: %{message}\n ") % { :name => name, :message => e.message }, e
+  end
+
+  def delMonitoringUpdate; end
+
+  def setMonitoringDowntime
+    Rails.logger.info "Setting Monitoring downtime for #{name}"
+    monitoring.set_downtime_host(self, monitoring_downtime_defaults)
+  rescue => e
+    failure _("Failed to set a monitoring downtime for %{name}: %{message}\n ") % { :name => name, :message => e.message }, e
+  end
+
+  def delMonitoringDowntime
+    Rails.logger.info "Deleting Monitoring downtime for #{name}"
+    monitoring.del_downtime_host(self, monitoring_downtime_defaults)
+  rescue => e
+    failure _("Failed to set a monitoring downtime for %{name}: %{message}\n ") % { :name => name, :message => e.message }, e
+  end
+
+  def monitoring_object
+    @monitoring_object || monitoring.query_host(self)
+  end
+
+  def clear_monitoring_object
+    @monitoring_object = nil
+    true
+  end
+
+  private
+
+  def monitoring_downtime_defaults
+    {
+      :comment => _('Host deleted in Foreman')
+    }
+  end
+
+  def monitoring_update_required?(actual_attrs, desired_attrs)
+    return true if actual_attrs.deep_symbolize_keys.keys != desired_attrs.deep_symbolize_keys.keys
+    actual_attrs.deep_symbolize_keys.merge(desired_attrs.deep_symbolize_keys) do |k, actual_v, desired_v|
+      if actual_v.is_a?(Hash) && desired_v.is_a?(Hash)
+        return true if monitoring_update_required?(actual_v, desired_v)
+      elsif actual_v.to_s != desired_v.to_s
+        Rails.logger.debug "Scheduling monitoring host object update because #{k} changed it's value from '#{actual_v}' (#{actual_v.class}) to '#{desired_v}' (#{desired_v.class})"
+        return true
+      end
+      desired_v
+    end
+    Rails.logger.debug "No monitoring update required."
+    false
+  end
+end