smart_proxy_monitoring 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e366cc37c357a3178a8d28262e1b177a384296778987df9b7107fb400a22dfae
-  data.tar.gz: 6f38e4e49c70adc11feee5bf495c00650dbe5aaf7f5187a5dca31e1c80edbc3e
+  metadata.gz: f5e92e5a9af2685d4f89adfae0b8327a53223a268a0eb1aee13957e8aac0311a
+  data.tar.gz: cd1edae1deef86f472486288c8cacac30608b493eab7bb6aad2c0d495dac303b
 SHA512:
-  metadata.gz: bbfbf8d19457f374c487630507cfd867aed6726bc3d84396e31596b648c26e047bc8ccf084d801edba5ea9667e3c17fb609f2cce47d6e033cf7c036c0c3df286
-  data.tar.gz: 846663a2a6aaee48323920970a3199326d888f45918ac575808699267f6b1af11181d3bd2d4f71db8bc5efb79aab13bc11a0798b02a540a014df04776cf1b13f
+  metadata.gz: 8acc9f33e0def4e55a560362df6e1e6ca4e7fbaf5d7513c3013757109753b30bc57db0574ae1aaefb8d937941570e243e271aac92661122eadcb92e4ca25712a
+  data.tar.gz: b2c3fbe6a6d4441ecb7657669283ac29d1785a75a4c2a0d59cabe7b3112a33d0b30f24e7f5480905bcc113e7eb05e4a51586eb506c6c716f88567f6707376e92

data/lib/smart_proxy_monitoring/monitoring_api.rb

@@ -58,7 +58,7 @@ module Proxy::Monitoring
       comment = params[:comment] || 'triggered by foreman'
       start_time = params[:start_time] || Time.now.to_i
       end_time = params[:end_time] || (Time.now.to_i + (24 * 3600))
-      all_services = params[:all_services]
+      all_services = params[:all_services].to_s == 'true'
 
       log_provider_errors do
         validate_dns_name!(host)
@@ -95,7 +95,7 @@ module Proxy::Monitoring
     end
 
     def validate_dns_name!(name)
-      raise Proxy::Monitoring::Error.new("Invalid DNS name #{name}") unless name =~ /^([a-zA-Z0-9]([-a-zA-Z0-9]+)?\.?)+$/
+      raise Proxy::Monitoring::Error, "Invalid DNS name #{name}" unless /^([a-zA-Z0-9]([-a-zA-Z0-9]+)?\.?)+$/.match?(name)
     end
 
     def strip_domain(name)

data/lib/smart_proxy_monitoring/monitoring_plugin.rb

@@ -14,8 +14,7 @@ module Proxy::Monitoring
     expose_setting :collect_status
     expose_setting :strip_domain
 
-    http_rackup_path File.expand_path('monitoring_http_config.ru', File.expand_path('../', __FILE__))
-    https_rackup_path File.expand_path('monitoring_http_config.ru', File.expand_path('../', __FILE__))
+    rackup_path File.expand_path('monitoring_http_config.ru', __dir__)
 
     load_classes ::Proxy::Monitoring::ConfigurationLoader
   end

data/lib/smart_proxy_monitoring/version.rb

@@ -1,5 +1,5 @@
 module Proxy
   module Monitoring
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/smart_proxy_monitoring_common/monitoring_common.rb

@@ -3,5 +3,29 @@ module Proxy::Monitoring
   class NotFound < RuntimeError; end
   class AuthenticationError < RuntimeError; end
 
-  class Provider; end
+  class Provider
+    def query_host(host)
+      raise NotImplementedError
+    end
+
+    def create_host(host, attributes)
+      raise NotImplementedError
+    end
+
+    def update_host(host, attributes)
+      raise NotImplementedError
+    end
+
+    def remove_host(host)
+      raise NotImplementedError
+    end
+
+    def remove_downtime_host(host, author, comment)
+      raise NotImplementedError
+    end
+
+    def set_downtime_host(host, author, comment, start_time, end_time, all_services: nil, **)
+      raise NotImplementedError
+    end
+  end
 end

data/lib/smart_proxy_monitoring_icinga2/icinga2_api_observer.rb

@@ -1,4 +1,3 @@
-require 'thread'
 require 'socket'
 require 'json'
 
@@ -24,19 +23,17 @@ module ::Proxy::Monitoring::Icinga2
         logger.info 'Icinga event api monitoring started.'
 
         while line = ssl_socket.gets
-          next unless line.chars.first == '{'
+          next unless line[0] == '{'
 
           with_event_counter('Icinga2 Event API Monitor') do
-            begin
-              parsed = JSON.parse(line)
-              if @queue.size > 100_000
-                @queue.clear
-                logger.error 'Queue was full. Flushing. Events were lost.'
-              end
-              @queue.push(parsed)
-            rescue JSON::ParserError => e
-              logger.error "Icinga2 Event API Monitor: Malformed JSON: #{e.message}"
+            parsed = JSON.parse(line)
+            if @queue.size > 100_000
+              @queue.clear
+              logger.error 'Queue was full. Flushing. Events were lost.'
             end
+            @queue.push(parsed)
+          rescue JSON::ParserError => e
+            logger.error "Icinga2 Event API Monitor: Malformed JSON: #{e.message}"
           end
 
         end
@@ -51,7 +48,7 @@ module ::Proxy::Monitoring::Icinga2
       sleep 1
       retry
     ensure
-      ssl_socket.sysclose unless ssl_socket.nil?
+      ssl_socket&.sysclose
     end
 
     def do_start
@@ -61,7 +58,7 @@ module ::Proxy::Monitoring::Icinga2
     end
 
     def stop
-      @thread.terminate unless @thread.nil?
+      @thread&.terminate
     end
   end
 end

data/lib/smart_proxy_monitoring_icinga2/icinga2_client.rb

@@ -1,7 +1,6 @@
 require 'json'
 require 'uri'
 require 'rest-client'
-require 'thread'
 require 'socket'
 require 'base64'
 
@@ -10,36 +9,36 @@ module ::Proxy::Monitoring::Icinga2
     class << self
       def client(request_url)
         headers = {
-          'Accept' => 'application/json'
+          'Accept' => 'application/json',
         }
 
         options = {
           headers: headers,
           user: user,
           ssl_ca_file: cacert,
-          verify_ssl: ssl
+          verify_ssl: ssl,
         }
 
         auth_options = if certificate_request?
                          {
                            ssl_client_cert: cert,
-                           ssl_client_key: key
+                           ssl_client_key: key,
                          }
                        else
                          {
-                           password: password
+                           password: password,
                          }
                        end
         options.merge!(auth_options)
 
         RestClient::Resource.new(
-          [baseurl, request_url].join(''),
+          [baseurl, request_url].join,
           options
         )
       end
 
       def events_socket(endpoint)
-        uri = URI.parse([baseurl, endpoint].join(''))
+        uri = URI.parse([baseurl, endpoint].join)
         socket = TCPSocket.new(uri.host, uri.port)
 
         ssl_context = OpenSSL::SSL::SSLContext.new
@@ -90,12 +89,14 @@ module ::Proxy::Monitoring::Icinga2
       def cert
         file = Proxy::Monitoring::Icinga2::Plugin.settings.api_usercert
         return unless !file.nil? && File.file?(file)
+
         OpenSSL::X509::Certificate.new(File.read(file))
       end
 
       def key
         file = Proxy::Monitoring::Icinga2::Plugin.settings.api_userkey
         return unless !file.nil? && File.file?(file)
+
         OpenSSL::PKey::RSA.new(File.read(file))
       end
 

data/lib/smart_proxy_monitoring_icinga2/icinga2_initial_importer.rb

@@ -1,4 +1,3 @@
-require 'thread'
 require 'socket'
 require 'json'
 
@@ -35,14 +34,15 @@ module ::Proxy::Monitoring::Icinga2
       results = Icinga2Client.get('/objects/hosts?attrs=name&attrs=last_check_result&attrs=acknowledgement')
       results = JSON.parse(results)
       results['results'].each do |result|
-        next if result['attrs']['last_check_result'] == nil
+        next if result['attrs']['last_check_result'].nil?
+
         parsed = {
           host: result['attrs']['name'],
           result: result['attrs']['last_check_result']['state'],
           timestamp: result['attrs']['last_check_result']['schedule_end'],
           acknowledged: (result['attrs']['acknowledgement'] != 0),
           initial: true,
-          type: '_parsed'
+          type: '_parsed',
         }
         @queue.push(parsed)
       end
@@ -52,7 +52,8 @@ module ::Proxy::Monitoring::Icinga2
       results = Icinga2Client.get('/objects/services?attrs=name&attrs=last_check_result&attrs=acknowledgement&attrs=host_name')
       results = JSON.parse(results)
       results['results'].each do |result|
-        next if result['attrs']['last_check_result'] == nil
+        next if result['attrs']['last_check_result'].nil?
+
         parsed = {
           host: result['attrs']['host_name'],
           service: result['attrs']['name'],
@@ -60,7 +61,7 @@ module ::Proxy::Monitoring::Icinga2
           timestamp: result['attrs']['last_check_result']['schedule_end'],
           acknowledged: (result['attrs']['acknowledgement'] != 0),
           initial: true,
-          type: '_parsed'
+          type: '_parsed',
         }
         @queue.push(parsed)
       end
@@ -71,12 +72,13 @@ module ::Proxy::Monitoring::Icinga2
       results = JSON.parse(results)
       results['results'].each do |result|
         next unless result['attrs']['trigger_time'] != 0
+
         parsed = {
           host: result['attrs']['host_name'],
           service: result['attrs']['service_name'],
           downtime: true,
           initial: true,
-          type: '_parsed'
+          type: '_parsed',
         }
         @queue.push(parsed)
       end
@@ -89,7 +91,7 @@ module ::Proxy::Monitoring::Icinga2
     end
 
     def stop
-      @thread.terminate unless @thread.nil?
+      @thread&.terminate
     end
 
     private

data/lib/smart_proxy_monitoring_icinga2/icinga2_result_uploader.rb

@@ -1,5 +1,3 @@
-require 'thread'
-
 module ::Proxy::Monitoring::Icinga2
   class MonitoringResult < Proxy::HttpRequest::ForemanRequest
     def push_result(result)
@@ -60,7 +58,7 @@ module ::Proxy::Monitoring::Icinga2
           rescue Errno::ECONNREFUSED => e
             logger.error "Foreman refused connection when tried to upload monitoring result: #{e.message}"
             sleep 10
-          rescue => e
+          rescue StandardError => e
             logger.error "Error while uploading monitoring results to Foreman: #{e.message}"
             sleep 1
             retry
@@ -76,13 +74,13 @@ module ::Proxy::Monitoring::Icinga2
     end
 
     def stop
-      @thread.terminate unless @thread.nil?
+      @thread&.terminate
     end
 
     private
 
     def symbolize_keys_deep!(h)
-      h.keys.each do |k|
+      h.each_key do |k|
         ks    = k.to_sym
         h[ks] = h.delete k
         symbolize_keys_deep! h[ks] if h[ks].is_a? Hash

data/lib/smart_proxy_monitoring_icinga2/icinga2_upload_queue.rb

@@ -1,5 +1,3 @@
-require 'thread'
-
 module ::Proxy::Monitoring::Icinga2
   class Icinga2UploadQueue
     def queue

data/lib/smart_proxy_monitoring_icinga2/monitoring_icinga2_main.rb

@@ -5,7 +5,7 @@ module Proxy::Monitoring::Icinga2
     include Proxy::Log
     include Proxy::Util
 
-    ICINGA_HOST_ATTRS = %w(display_name address address6 templates)
+    ICINGA_HOST_ATTRS = %w[display_name address address6 templates].freeze
 
     ICINGA_ATTR_MAPPING = {
       'ip' => 'address',
@@ -39,7 +39,7 @@ module Proxy::Monitoring::Icinga2
       result.to_json
     end
 
-  def remove_host(host)
+    def remove_host(host)
       request_url = "/objects/hosts/#{host}?cascade=1"
 
       result = with_errorhandling("Remove #{host}") do
@@ -49,8 +49,13 @@ module Proxy::Monitoring::Icinga2
     end
 
     def remove_downtime_host(host, author, comment)
-      request_url = "/actions/remove-downtime?type=Host&filter=#{uri_encode_filter("host.name==\"#{host}\"\&\&author==\"#{author}\"\&\&comment=\"#{comment}\"")}"
-      data = {}
+      request_url = "/actions/remove-downtime"
+      data = {
+        type: 'Host',
+        filter: "host.name==\"#{host}\"",
+        author: author,
+        comment: comment,
+      }
 
       result = with_errorhandling("Remove downtime from #{host}") do
         Icinga2Client.post(request_url, data.to_json)
@@ -59,13 +64,15 @@ module Proxy::Monitoring::Icinga2
     end
 
     def set_downtime_host(host, author, comment, start_time, end_time, all_services: nil, **)
-      request_url = "/actions/schedule-downtime?type=Host&filter=#{uri_encode_filter("host.name==\"#{host}\"")}"
+      request_url = "/actions/schedule-downtime"
       data = {
+        'type' => 'Host',
+        'filter' => "host.name==\"#{host}\"",
         'author' => author,
         'comment' => comment,
         'start_time' => start_time,
         'end_time' => end_time,
-        'duration' => 1000
+        'duration' => 1000,
       }
       data['all_services'] = all_services unless all_services.nil?
 
@@ -77,15 +84,11 @@ module Proxy::Monitoring::Icinga2
 
     private
 
-    def uri_encode_filter(filter)
-      URI.encode(filter)
-    end
-
     def host_attributes(host, data)
       attributes = {}
 
       data['templates'].delete(host)
-      data.delete('templates') if data['templates'] == [ 'foreman-host' ]
+      data.delete('templates') if data['templates'] == ['foreman-host']
       if data['vars'].nil?
         data.delete('vars')
       else
@@ -103,7 +106,7 @@ module Proxy::Monitoring::Icinga2
     def host_data(attributes)
       data = {}
 
-      data['templates'] = [ 'foreman-host' ] unless attributes.has_key?('templates')
+      data['templates'] = ['foreman-host'] unless attributes.key?('templates')
       data['attrs'] = {}
 
       attributes.each do |key, value|
@@ -120,31 +123,33 @@ module Proxy::Monitoring::Icinga2
       logger.debug "Monitoring - Action successful: #{action}"
       result = JSON.parse(response.body)
       if result.key?('error') && result['status'] == "No objects found."
-        raise Proxy::Monitoring::NotFound.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned no objects found.")
+        raise Proxy::Monitoring::NotFound, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned no objects found."
       end
+
       unless result.key?('results')
         logger.error "Invalid Icinga result or result with errors: #{result.inspect}"
-        raise Proxy::Monitoring::Error.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an invalid result.")
+        raise Proxy::Monitoring::Error, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an invalid result."
       end
       unless result['results'].first
-        raise Proxy::Monitoring::NotFound.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an empty result.")
+        raise Proxy::Monitoring::NotFound, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an empty result."
       end
       if result['results'][0]['code'] && result['results'][0]['code'] != 200
-        raise Proxy::Monitoring::Error.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an error: #{result['results'][0]['code']} #{result['results'][0]['status']}")
+        raise Proxy::Monitoring::Error, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an error: #{result['results'][0]['code']} #{result['results'][0]['status']}"
       end
+
       result
     rescue JSON::ParserError => e
-      raise Proxy::Monitoring::Error.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned invalid JSON: '#{e.message}'")
+      raise Proxy::Monitoring::Error, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned invalid JSON: '#{e.message}'"
     rescue RestClient::Unauthorized => e
-      raise Proxy::Monitoring::AuthenticationError.new("Error authenicating to Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server}: #{e.message}.")
+      raise Proxy::Monitoring::AuthenticationError, "Error authenicating to Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server}: #{e.message}."
     rescue RestClient::ResourceNotFound => e
-      raise Proxy::Monitoring::NotFound.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned: #{e.message}.")
+      raise Proxy::Monitoring::NotFound, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned: #{e.message}."
     rescue RestClient::Exception => e
-      raise Proxy::Monitoring::Error.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an error: '#{e.response}'")
-    rescue Errno::ECONNREFUSED => e
-      raise Proxy::Monitoring::ConnectionError.new("Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} is not responding")
-    rescue SocketError => e
-      raise Proxy::Monitoring::ConnectionError.new("Icinga server '#{::Proxy::Monitoring::Icinga2::Plugin.settings.server}' is unknown")
+      raise Proxy::Monitoring::Error, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} returned an error: '#{e.response}'"
+    rescue Errno::ECONNREFUSED
+      raise Proxy::Monitoring::ConnectionError, "Icinga server at #{::Proxy::Monitoring::Icinga2::Plugin.settings.server} is not responding"
+    rescue SocketError
+      raise Proxy::Monitoring::ConnectionError, "Icinga server '#{::Proxy::Monitoring::Icinga2::Plugin.settings.server}' is unknown"
     end
   end
 end

data/lib/smart_proxy_monitoring_icingadirector/director_client.rb

@@ -54,12 +54,13 @@ module ::Proxy::Monitoring::IcingaDirector
       {
         headers: request_headers,
         ssl_ca_file: cacert,
-        verify_ssl: verify_ssl?
+        verify_ssl: verify_ssl?,
       }.merge(auth_options)
     end
 
     def auth_options
       return {} unless basic_auth?
+
       {
         user: user,
         password: password,
@@ -72,7 +73,7 @@ module ::Proxy::Monitoring::IcingaDirector
 
     def request_headers
       {
-        'Accept' => 'application/json'
+        'Accept' => 'application/json',
       }
     end
 
@@ -90,7 +91,7 @@ module ::Proxy::Monitoring::IcingaDirector
     end
 
     def baseurl
-      Proxy::Monitoring::IcingaDirector::Plugin.settings.director_url + '/'
+      "#{Proxy::Monitoring::IcingaDirector::Plugin.settings.director_url}/"
     end
 
     def user

data/lib/smart_proxy_monitoring_icingadirector/monitoring_icingadirector_main.rb

@@ -50,7 +50,7 @@ module Proxy::Monitoring::IcingaDirector
         :address => attributes.delete('ip'),
         :address6 => attributes.delete('ip6'),
         :imports => attributes.delete('templates') || ['foreman_host'],
-        :vars => attributes
+        :vars => attributes,
       }
     end
 
@@ -63,7 +63,7 @@ module Proxy::Monitoring::IcingaDirector
         'ip' => ip,
         'ip6' => ip6,
       }
-      result.merge!('templates' => templates) if templates != ['foreman_host']
+      result['templates'] = templates if templates != ['foreman_host']
       result.merge!(response['vars'] || {})
       result
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_monitoring
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Timo Goebel
@@ -9,22 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -40,41 +26,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -133,14 +91,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Monitoring plug-in for Foreman's smart proxy