foreman_monitoring 0.0.1

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    = 'ForemanMonitoring'
+  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', __FILE__)
+
+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 => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

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

@@ -0,0 +1,29 @@
+module Api
+  module V2
+    class MonitoringResultsController < V2::BaseController
+      include Api::Version2
+      include Foreman::Controller::SmartProxyAuth
+
+      add_smart_proxy_filters :create, :features => 'Monitoring'
+
+      def create
+        begin
+          MonitoringResult.import(monitoring_result_params.with_indifferent_access)
+        rescue => e
+          logger.error "Failed to import monitoring result: #{e.message}"
+          logger.debug e.backtrace.join("\n")
+          render :json => { 'message' => e.message }, :status => :unprocessable_entity
+          return
+        end
+
+        render :json => { 'message' => 'OK' }
+      end
+
+      private
+
+      def monitoring_result_params
+        params.permit(:host, :result, :service, :acknowledged, :downtime, :timestamp, :initial)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module ForemanMonitoring
+  module HostsHelperExt
+    extend ActiveSupport::Concern
+
+    # included do
+    #  alias_method_chain :host_title_actions, :monitoring
+    # 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_monitoring_result_icon_class(result)
+      icon_class = case result
+                   when :ok
+                     'pficon-ok'
+                   when :warning
+                     'pficon-info'
+                   when :critical
+                     'pficon-error-circle-o'
+                   else
+                     'pficon-help'
+                   end
+
+      "host-status #{icon_class} #{host_monitoring_result_class(result)}"
+    end
+
+    def host_monitoring_result_class(result)
+      case result
+      when :ok
+        'status-ok'
+      when :warning
+        'status-warn'
+      when :critical
+        'status-error'
+      else
+        'status-question'
+      end
+    end
+  end
+end

data/app/lib/proxy_api/monitoring.rb

@@ -0,0 +1,14 @@
+module ProxyAPI
+  class Monitoring < ProxyAPI::Resource
+    def initialize(args)
+      @url = args[:url] + '/monitoring'
+      super args
+    end
+
+    def create_host_downtime(host, args = {})
+      parse(post(args, "downtime/host/#{host}"))
+    rescue => e
+      raise ProxyException.new(url, e, N_('Unable to set downtime for %s') % host)
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module ForemanMonitoring
+  module HostExtensions
+    extend ActiveSupport::Concern
+    included do
+      before_destroy :downtime_host_destroy
+      after_build :downtime_host_build
+
+      has_many :monitoring_results, :foreign_key => 'host_id'
+    end
+
+    def monitoring_status(options = {})
+      @monitoring_status ||= get_status(HostStatus::MonitoringStatus).to_status(options)
+    end
+
+    def monitoring_status_label(options = {})
+      @monitoring_status_label ||= get_status(HostStatus::MonitoringStatus).to_label(options)
+    end
+
+    def refresh_monitoring_status
+      get_status(HostStatus::MonitoringStatus).refresh
+    end
+
+    def downtime_host_build
+      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?
+      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
+  end
+end

data/app/models/host_status/monitoring_status.rb

@@ -0,0 +1,72 @@
+module HostStatus
+  class MonitoringStatus < HostStatus::Status
+    OK = 0
+    WARNING = 1
+    CRITICAL = 2
+    UNKNOWN = 3
+
+    def relevant?(_options = {})
+      host_not_in_build? && host_known_in_monitoring?
+    end
+
+    def to_status(_options = {})
+      state = OK
+      grouped_results.each do |resultset, _count|
+        result, downtime, acknowledged = resultset
+        next if downtime
+        result = WARNING if acknowledged || result == UNKNOWN
+        state = result if result > state
+      end
+      state
+    end
+
+    def to_global(_options = {})
+      return HostStatus::Global::OK unless should_affect_global_status?
+      case status
+      when OK
+        HostStatus::Global::OK
+      when WARNING
+        HostStatus::Global::WARN
+      when CRITICAL
+        HostStatus::Global::ERROR
+      else
+        HostStatus::Global::WARN
+      end
+    end
+
+    def self.status_name
+      N_('Monitoring Status')
+    end
+
+    def to_label(_options = {})
+      case status
+      when OK
+        N_('OK')
+      when WARNING
+        N_('Warning')
+      when CRITICAL
+        N_('Critical')
+      else
+        N_('Unknown')
+      end
+    end
+
+    def host_not_in_build?
+      host && !host.build
+    end
+
+    def host_known_in_monitoring?
+      host.monitoring_results.any?
+    end
+
+    def should_affect_global_status?
+      Setting[:monitoring_affect_global_status]
+    end
+
+    private
+
+    def grouped_results
+      host.monitoring_results.group([:result, :downtime, :acknowledged]).count
+    end
+  end
+end

data/app/models/monitoring_result.rb

@@ -0,0 +1,74 @@
+class MonitoringResult < ActiveRecord::Base
+  enum :result => [:ok, :warning, :critical, :unknown]
+
+  belongs_to_host
+
+  def self.import(result)
+    host = Host.find_by_name(result[:host])
+
+    if host.nil?
+      logger.error "Unable to find host #{result[:host]}"
+      return false
+    end
+
+    start_time = Time.now.utc
+    logger.info "Processing monitoring result for #{host}"
+
+    updates = {
+      :result => result[:result],
+      :acknowledged => result[:acknowledged],
+      :downtime => result[:downtime],
+      :timestamp => (Time.at(result[:timestamp]).utc rescue nil)
+    }.compact
+
+    if result[:initial] && result[:service] == 'Host Check'
+      logger.info "Removing all monitoring results for #{host} on initial import"
+      MonitoringResult.where(:host => host).destroy_all
+    end
+
+    created = MonitoringResult.where(:host => host, :service => result[:service]).first_or_create
+    if created.timestamp.blank? || updates[:timestamp].blank? || created.timestamp < updates[:timestamp]
+      created.update_attributes(updates)
+
+      if created.persisted?
+        logger.info("Imported monitoring result for #{host} in #{(Time.now.utc - start_time).round(2)} seconds")
+        host.refresh_statuses
+      end
+    else
+      logger.debug "Skipping monitoring result import for #{host} as it is older than what we have."
+    end
+  end
+
+  def status
+    return :ok if downtime
+    return :warning if acknowledged
+    result.to_sym
+  end
+
+  def to_label
+    label_mapper(status)
+  end
+
+  def to_full_label
+    options = []
+    options << _('acknowledged') if acknowledged
+    options << _('in downtime') if downtime
+    suffix = options.any? ? " (#{options.join(', ')})" : ''
+    "#{label_mapper(result.to_sym)}#{suffix}"
+  end
+
+  private
+
+  def label_mapper(value)
+    case value
+    when :ok
+      _('OK')
+    when :warning
+      _('Warning')
+    when :critical
+      _('Critical')
+    else
+      _('Unknown')
+    end
+  end
+end

data/app/models/setting/monitoring.rb

@@ -0,0 +1,16 @@
+class Setting
+  class Monitoring < ::Setting
+    def self.load_defaults
+      # Check the table exists
+      return unless super
+
+      Setting.transaction do
+        [
+          set('monitoring_affect_global_status',
+              _("Monitoring status will affect a host's global status when enabled"),
+              true, N_('Monitoring status should affect global status'))
+        ].compact.each { |s| create! s.update(:category => 'Setting::Monitoring') }
+      end
+    end
+  end
+end

data/app/overrides/add_host_monitoring_result_tab.rb

@@ -0,0 +1,11 @@
+Deface::Override.new(:virtual_path  => 'hosts/show',
+                     :name          => 'add_monitoring_result_tab',
+                     :insert_bottom => 'ul.nav-tabs',
+                     :partial       => 'monitoring_results/host_tab'
+                    )
+
+Deface::Override.new(:virtual_path  => 'hosts/show',
+                     :name          => 'add_monitoring_result_tab_pane',
+                     :insert_bottom => 'div.tab-content',
+                     :partial       => 'monitoring_results/host_tab_pane'
+                    )

data/app/services/monitoring.rb

@@ -0,0 +1,13 @@
+class Monitoring
+  delegate :logger, :to => :Rails
+  attr_reader :proxy, :proxy_api
+
+  def initialize
+    @proxy = SmartProxy.with_features('Monitoring').first
+    @proxy_api = ProxyAPI::Monitoring.new(:url => proxy.url)
+  end
+
+  def set_downtime_host(host, options = {})
+    proxy_api.create_host_downtime(host.fqdn, { :author => 'Foreman', :comment => 'triggered by Foreman' }.merge(options))
+  end
+end

data/app/views/monitoring_results/_host_tab.html.erb

@@ -0,0 +1 @@
+<li><a href="#monitoring" data-toggle="tab"><%= _("Monitoring") %></a></li>

data/app/views/monitoring_results/_host_tab_pane.html.erb

@@ -0,0 +1,25 @@
+<div class="tab-pane" id="monitoring">
+<% if @host.monitoring_results.any? %>
+  <table class="table table-bordered table-striped">
+    <thead
+      <tr>
+        <th colspan="2">Monitoring</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @host.monitoring_results.order(:service).each do |result| %>
+        <tr>
+          <td>
+            <%= result.service %>
+          </td>
+          <td>
+            <span class="<%= host_monitoring_result_icon_class(result.status) %>" title="<%= result.to_label %>"></span> <%= result.to_full_label %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="alert alert-success"> <%= _('No monitoring results for this host') %> </div>
+<% end %>
+</div>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  namespace :api, :defaults => { :format => 'json' } do
+    scope '(:apiv)', :module => :v2,
+                     :defaults => { :apiv => 'v2' },
+                     :apiv => /v1|v2/,
+                     :constraints => ApiConstraints.new(:version => 2) do
+      resources :monitoring_results, :only => [:create]
+    end
+  end
+end

data/db/migrate/20160817135723_create_monitoring_results.rb

@@ -0,0 +1,12 @@
+class CreateMonitoringResults < ActiveRecord::Migration
+  def change
+    create_table :monitoring_results do |t|
+      t.references :host, :null => false
+      t.string :service, :null => false
+      t.integer :result, :default => 0, :null => false
+      t.boolean :downtime, :default => false, :null => false
+      t.boolean :acknowledged, :default => false, :null => false
+      t.datetime :timestamp
+    end
+  end
+end

data/db/seeds.d/60-monitoring_proxy_feature.rb

@@ -0,0 +1,2 @@
+f = Feature.where(:name => 'Monitoring').first_or_create
+raise "Unable to create proxy feature: #{format_errors f}" if f.nil? || f.errors.any?

data/lib/foreman_monitoring/engine.rb

@@ -0,0 +1,51 @@
+module ForemanMonitoring
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_monitoring'
+
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/overrides"]
+    config.autoload_paths += Dir["#{config.root}/app/services"]
+
+    # Add any db migrations
+    initializer 'foreman_monitoring.load_app_instance_data' do |app|
+      ForemanMonitoring::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_monitoring.load_default_settings',
+      :before => :load_config_initializers do |_app|
+      if begin
+        Setting.table_exists?
+      rescue
+        false
+      end
+        require_dependency File.expand_path('../../../app/models/setting/monitoring.rb', __FILE__)
+      end
+    end
+
+    initializer 'foreman_monitoring.register_plugin', :before => :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_monitoring do
+        requires_foreman '>= 1.11'
+        register_custom_status HostStatus::MonitoringStatus
+      end
+    end
+
+    config.to_prepare do
+      begin
+        Host::Managed.send :include, ForemanMonitoring::HostExtensions
+        HostsHelper.send(:include, ForemanMonitoring::HostsHelperExt)
+      rescue => e
+        Rails.logger.warn "ForemanMonitoring: skipping engine hook (#{e})"
+      end
+    end
+
+    initializer 'foreman_monitoring.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_domain = 'foreman_monitoring'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+end

data/lib/foreman_monitoring/version.rb

@@ -0,0 +1,3 @@
+module ForemanMonitoring
+  VERSION = '0.0.1'.freeze
+end

data/lib/foreman_monitoring.rb

@@ -0,0 +1,4 @@
+require 'foreman_monitoring/engine'
+
+module ForemanMonitoring
+end

data/lib/tasks/foreman_monitoring_tasks.rake

@@ -0,0 +1,35 @@
+# Tests
+namespace :test do
+  desc 'Test ForemanMonitoring'
+  Rake::TestTask.new(:foreman_monitoring) do |t|
+    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    t.libs << ['test', test_dir]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_monitoring do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_monitoring) do |task|
+        task.patterns = ["#{ForemanMonitoring::Engine.root}/app/**/*.rb",
+                         "#{ForemanMonitoring::Engine.root}/lib/**/*.rb",
+                         "#{ForemanMonitoring::Engine.root}/test/**/*.rb"]
+      end
+    rescue
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_monitoring'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_monitoring']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_monitoring', 'foreman_monitoring:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,62 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = foreman_monitoring
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '*.po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+check: $(POXFILES)
+	msgfmt -c ${POTFILE}
+
+# Merge PO files
+update-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msgmerge -N --backup=none -U $$f ${POTFILE} ; \
+	done
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull:
+	tx pull -f
+	for f in $(POFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+	-git commit -a -m "i18n - pulling from tx"
+
+reset-po:
+	# merging po files is unnecessary when using transifex.com
+	git checkout -- ../locale/*/*po
+
+tx-update: tx-pull reset-po $(MOFILES)
+	# amend mo files
+	git add ../locale/*/LC_MESSAGES
+	git commit -a --amend -m "i18n - pulling from tx"
+	-echo Changes commited!

data/locale/en/foreman_monitoring.po

@@ -0,0 +1,19 @@
+# foreman_monitoring
+#
+# This file is distributed under the same license as foreman_monitoring.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+

data/locale/foreman_monitoring.pot

@@ -0,0 +1,19 @@
+# foreman_monitoring
+#
+# This file is distributed under the same license as foreman_monitoring.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:46+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+

data/locale/gemspec.rb

@@ -0,0 +1,2 @@
+# Matches foreman_monitoring.gemspec
+_('Set a downtime for hosts after they are deleted in Foreman.')

data/test/factories/feature.rb

@@ -0,0 +1,7 @@
+FactoryGirl.modify do
+  factory :feature do
+    trait :monitoring do
+      name 'Monitoring'
+    end
+  end
+end

data/test/factories/host.rb

@@ -0,0 +1,14 @@
+FactoryGirl.modify do
+  factory :host do
+    trait :with_monitoring_results do
+      transient do
+        monitoring_result_count 20
+      end
+      after(:create) do |host, evaluator|
+        evaluator.monitoring_result_count.times do
+          FactoryGirl.create(:monitoring_result, :host => host)
+        end
+      end
+    end
+  end
+end