icinga2 0.7.0.1 → 0.8.1.2

data/lib/icinga2.rb

@@ -1,9 +1,4 @@
-
 # frozen_string_literal: true
-#
-#
-#
-#
 
 require 'rest-client'
 require 'openssl'
@@ -15,7 +10,7 @@ require 'uri'
 require_relative 'logging'
 require_relative 'icinga2/version'
 require_relative 'icinga2/network'
-require_relative 'icinga2/status'
+require_relative 'icinga2/statistics'
 require_relative 'icinga2/converts'
 require_relative 'icinga2/tools'
 require_relative 'icinga2/downtimes'
@@ -28,11 +23,20 @@ require_relative 'icinga2/users'
 require_relative 'icinga2/usergroups'
 
 # -------------------------------------------------------------------------------------------------------------------
-# Namespace for classes and modules that handle all Icinga2 API calls
+#
+# @abstract # Namespace for classes and modules that handle all Icinga2 API calls
+#
+# @author Bodo Schulz <bodo@boone-schulz.de>
+#
+#
 module Icinga2
 
   # static variable for hosts down
-  HOSTS_DOWN = 1
+  HOSTS_DOWN     = 1
+  # static variable for hosts critical
+  HOSTS_CRITICAL = 2
+  # static variable for hosts unknown
+  HOSTS_UNKNOWN  = 3
 
   # static variables for handled warning
   SERVICE_STATE_WARNING  = 1
@@ -48,22 +52,11 @@ module Icinga2
   #
   class Client
 
-    attr_reader :version, :revision, :node_name, :start_time, :uptime
-    attr_reader :avg_latency, :avg_execution_time
-    attr_reader :hosts_up, :hosts_down, :hosts_in_downtime, :hosts_acknowledged
-    attr_reader :hosts_all, :hosts_problems, :hosts_problems_down, :hosts_handled_warning_problems, :hosts_handled_critical_problems, :hosts_handled_unknown_problems
-    attr_reader :hosts_handled_problems, :hosts_down_adjusted
-
-    attr_reader :services_ok, :services_warning, :services_critical, :services_unknown, :services_in_downtime, :services_acknowledged
-    attr_reader :services_all, :services_problems, :services_handled_warning_problems, :services_handled_critical_problems, :services_handled_unknown_problems
-    attr_reader :services_warning_adjusted, :services_critical_adjusted, :services_unknown_adjusted
-    attr_reader :hosts_active_checks_1min, :hosts_passive_checks_1min, :services_active_checks_1min, :services_passive_checks_1min
-
     include Logging
 
     include Icinga2::Version
     include Icinga2::Network
-    include Icinga2::Status
+    include Icinga2::Statistics
     include Icinga2::Converts
     include Icinga2::Tools
     include Icinga2::Downtimes
@@ -78,12 +71,13 @@ module Icinga2
     # Returns a new instance of Client
     #
     # @param [Hash, #read] settings the settings for Icinga2
-    # @option settings [String] :icinga, :host the Icinga2 Hostname (default: 'localhost')
-    # @option settings [Integer] :icinga, :api, :port the Icinga2 API Port (default: 5665)
-    # @option settings [String] :icinga, :api, :user the Icinga2 API User
-    # @option settings [String] :icinga, :api, :password the Icinga2 API Password
-    # @option settings [Bool] :icinga, :cluster Icinga2 Cluster Mode
-    # @option settings [Bool] :icinga, :notifications enable Icinga2 Host Notifications (default: false)
+    # @option settings [String] :host ('localhost') the Icinga2 Hostname
+    # @option settings [Integer] :port (5665) the Icinga2 API Port
+    # @option settings [String] :user the Icinga2 API User
+    # @option settings [String] :password the Icinga2 API Password
+    # @option settings [Integer] :version (1) the Icinga2 API Version
+    # @option settings [Bool] :cluster Icinga2 Cluster Mode
+    # @option settings [Bool] :notifications (false) enable Icinga2 Host Notifications
     #
     # @example to create an new Instance
     #    config = {
@@ -92,7 +86,8 @@ module Icinga2
     #        api: {
     #          port: 5665,
     #          user: 'root',
-    #          password: 'icinga'
+    #          password: 'icinga',
+    #          version: 1
     #        },
     #        cluster: false,
     #        satellite: true
@@ -103,70 +98,72 @@ module Icinga2
     #
     # @return [instance, #read]
     #
-    def initialize( settings = {} )
-
-      @icinga_host           = settings.dig(:icinga, :host)           || 'localhost'
-      @icinga_api_port       = settings.dig(:icinga, :api, :port)     || 5665
-      @icinga_api_user       = settings.dig(:icinga, :api, :user)
-      @icinga_api_pass       = settings.dig(:icinga, :api, :password)
-      @icinga_api_pki_path   = settings.dig(:icinga, :api, :pki_path)
-      @icinga_api_node_name  = settings.dig(:icinga, :api, :node_name)
-
-      @icinga_cluster        = settings.dig(:icinga, :cluster)        || false
-      @icinga_satellite      = settings.dig(:icinga, :satellite)
-      @icinga_notifications  = settings.dig(:icinga, :notifications)  || false
-
-      @icinga_api_url_base   = format( 'https://%s:%d', @icinga_host, @icinga_api_port )
-
-      if( @icinga_api_node_name.nil? )
-        @icinga_api_node_name = Socket.gethostbyname( Socket.gethostname ).first
-      end
-
-      @has_cert, @options = cert?(
-        pki_path: @icinga_api_pki_path,
-        node_name: @icinga_api_node_name,
-        user: @icinga_api_user,
-        password: @icinga_api_pass
+    def initialize( settings )
+
+      raise ArgumentError.new('only Hash are allowed') unless( settings.is_a?(Hash) )
+      raise ArgumentError.new('missing settings') if( settings.size.zero? )
+
+      icinga_host           = settings.dig(:icinga, :host)           || 'localhost'
+      icinga_api_port       = settings.dig(:icinga, :api, :port)     || 5665
+      icinga_api_user       = settings.dig(:icinga, :api, :user)
+      icinga_api_pass       = settings.dig(:icinga, :api, :password)
+      icinga_api_version    = settings.dig(:icinga, :api, :version)  || 1
+      icinga_api_pki_path   = settings.dig(:icinga, :api, :pki_path)
+      icinga_api_node_name  = settings.dig(:icinga, :api, :node_name)
+      @icinga_cluster       = settings.dig(:icinga, :cluster)        || false
+      @icinga_satellite     = settings.dig(:icinga, :satellite)
+      @icinga_notifications = settings.dig(:icinga, :notifications)  || false
+
+      @icinga_api_url_base  = format( 'https://%s:%d/v%s', icinga_host, icinga_api_port, icinga_api_version )
+
+      _has_cert, @options = cert?(
+        pki_path: icinga_api_pki_path,
+        node_name: icinga_api_node_name,
+        user: icinga_api_user,
+        password: icinga_api_pass
       )
 
       @headers    = { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
 
-
-      @version = @revision = 0
-      @node_name = @start_time = @uptime = ''
-      @avg_latency = @avg_execution_time = 0
-      @hosts_up = @hosts_down = @hosts_in_downtime = @hosts_acknowledged = 0
-      @hosts_all = @hosts_problems = @hosts_handled_warning_problems = @hosts_handled_critical_problems = @hosts_handled_unknown_problems = 0
-      @hosts_handled_problems = @hosts_down_adjusted = 0
-      @services_ok = @services_warning = @services_critical = @services_unknown = @services_in_downtime = @services_acknowledged = 0
-      @services_all = @services_problems = @services_handled_warning_problems = @services_handled_critical_problems = @services_handled_unknown_problems = 0
-      @services_warning_adjusted = @services_critical_adjusted = @services_unknown_adjusted = 0
-      @hosts_active_checks_1min = @hosts_passive_checks_1min = @services_active_checks_1min = @services_passive_checks_1min = 0
-
-      extract_data
-
       self
     end
 
-    # @param [Hash, #read] params create a HTTP Header based on a Icinga2 Certificate or an User PAI Login
-    # @option params [String] :node_name the Icinga2 Hostname (default: 'localhost')
-    # @option params [Integer] :user the Icinga2 API User
-    # @option params [Integer] :password the Icinga2 API Password
+    # create a HTTP Header based on a Icinga2 Certificate or an User API Login
+    #
+    # @param [Hash, #read] params
+    # @option params [String] :pki_path the location of the Certificate Files
+    # @option params [String] :node_name the Icinga2 Hostname
+    # @option params [String] :user the Icinga2 API User
+    # @option params [String] :password the Icinga2 API Password
+    #
     # @example with Certificate
-    #    @icinga.cert?(pki_path: '/etc/icinga2', name_name: 'icinga2-dashing')
+    #    @icinga.cert?(pki_path: '/etc/icinga2', node_name: 'icinga2-dashing')
     #
     # @example with User
     #    @icinga.cert?(user: 'root', password: 'icinga')
     #
     # @return [Bool, #read]
     #
-    def cert?( params = {} )
+    def cert?( params )
+
+      raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
 
       pki_path     = params.dig(:pki_path)
       node_name    = params.dig(:node_name)
       user         = params.dig(:user)
       password     = params.dig(:password)
 
+      if( node_name.nil? )
+        begin
+          node_name = Socket.gethostbyname(Socket.gethostname).first
+          logger.debug(format('node name: %s', node_name))
+        rescue SocketError => e
+
+          raise format("can't resolve hostname (%s)", e)
+        end
+      end
+
       ssl_cert_file = format( '%s/%s.crt', pki_path, node_name )
       ssl_key_file  = format( '%s/%s.key', pki_path, node_name )
       ssl_ca_file   = format( '%s/ca.crt', pki_path )
@@ -193,6 +190,9 @@ module Icinga2
 
         logger.debug( 'PKI not found, using basic auth for connection to Icinga 2 API' )
 
+        raise ArgumentError.new('Missing user_name') if( user.nil? )
+        raise ArgumentError.new('Missing password')  if( password.nil? )
+
         [false, {
           user: user,
           password: password,
@@ -202,6 +202,191 @@ module Icinga2
 
     end
 
+
+    # return Icinga2 Application data
+    #
+    # @example
+    #    @icinga.application_data
+    #
+    # @return [Hash]
+    #
+    def application_data
+
+      data = Network.application_data(
+        url: format( '%s/status/IcingaApplication', @icinga_api_url_base ),
+        headers: @headers,
+        options: @options
+      )
+
+      return nil if( data.nil? )
+
+      app_data = data.dig('icingaapplication','app')
+
+      # version and revision
+      @version, @revision = parse_version(app_data.dig('version'))
+
+      #   - node_name
+      @node_name = app_data.dig('node_name')
+
+      #   - start_time
+      @start_time = Time.at(app_data.dig('program_start').to_f)
+
+      data
+    end
+
+    # return Icinga2 CIB
+    #
+    # @example
+    #    @icinga.cib_data
+    #
+    # @return [Hash]
+    #
+    def cib_data
+
+      data = Network.application_data(
+        url: format( '%s/status/CIB', @icinga_api_url_base ),
+        headers: @headers,
+        options: @options
+      )
+
+      unless( data.nil? )
+
+        cib_data = data.clone
+
+        # extract
+        #   - uptime
+        uptime   = cib_data.dig('uptime').round(2)
+        @uptime  = Time.at(uptime).utc.strftime('%H:%M:%S')
+
+        #   - avg_latency / avg_execution_time
+        @avg_latency        = cib_data.dig('avg_latency').round(2)
+        @avg_execution_time = cib_data.dig('avg_execution_time').round(2)
+
+        #   - hosts
+        @hosts_up           = cib_data.dig('num_hosts_up').to_i
+        @hosts_down         = cib_data.dig('num_hosts_down').to_i
+        @hosts_pending      = cib_data.dig('num_hosts_pending').to_i
+        @hosts_unreachable  = cib_data.dig('num_hosts_unreachable').to_i
+        @hosts_in_downtime  = cib_data.dig('num_hosts_in_downtime').to_i
+        @hosts_acknowledged = cib_data.dig('num_hosts_acknowledged').to_i
+
+        #   - services
+        @services_ok           = cib_data.dig('num_services_ok').to_i
+        @services_warning      = cib_data.dig('num_services_warning').to_i
+        @services_critical     = cib_data.dig('num_services_critical').to_i
+        @services_unknown      = cib_data.dig('num_services_unknown').to_i
+        @services_pending      = cib_data.dig('num_services_pending').to_i
+        @services_in_downtime  = cib_data.dig('num_services_in_downtime').to_i
+        @services_acknowledged = cib_data.dig('num_services_acknowledged').to_i
+
+        #   - check stats
+        @hosts_active_checks_1min     = cib_data.dig('active_host_checks_1min')
+        @hosts_passive_checks_1min    = cib_data.dig('passive_host_checks_1min')
+        @services_active_checks_1min  = cib_data.dig('active_service_checks_1min')
+        @services_passive_checks_1min = cib_data.dig('passive_service_checks_1min')
+
+      end
+
+      data
+    end
+
+    # return Icinga2 Status Data
+    #
+    # @example
+    #    @icinga.status_data
+    #
+    # @return [Hash]
+    #
+    def status_data
+
+      Network.application_data(
+        url: format( '%s/status', @icinga_api_url_base ),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    # return Icinga2 API Listener
+    #
+    # @example
+    #    @icinga.api_listener
+    #
+    # @return [Hash]
+    #
+    def api_listener
+
+      Network.application_data(
+        url: format( '%s/status/ApiListener', @icinga_api_url_base ),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    # return Icinga2 version and revision
+    #
+    # @example
+    #    @icinga.application_data
+    #    @icinga.version.values
+    #
+    #    v = @icinga.version
+    #    version = v.dig(:version)
+    #
+    # @return [Hash]
+    #    * version
+    #    * revision
+    #
+    def version
+      version  = @version.nil?  ? 0 : @version
+      revision = @revision.nil? ? 0 : @revision
+
+      {
+        version: version.to_s,
+        revision: revision.to_s
+      }
+    end
+
+    # return Icinga2 node_name
+    #
+    # @example
+    #    @icinga.application_data
+    #    @icinga.node_name
+    #
+    # @return [String]
+    #
+    def node_name
+      return @node_name if( @node_name )
+
+      nil
+    end
+
+    # return Icinga2 start time
+    #
+    # @example
+    #    @icinga.application_data
+    #    @icinga.start_time
+    #
+    # @return [String]
+    #
+    def start_time
+      return @start_time if( @start_time )
+
+      nil
+    end
+
+    # return Icinga2 uptime
+    #
+    # @example
+    #    @icinga.cib_data
+    #    @icinga.uptime
+    #
+    # @return [String]
+    #
+    def uptime
+      return @uptime if( @uptime )
+
+      nil
+    end
+
   end
 end
 

data/lib/icinga2/converts.rb

@@ -11,9 +11,10 @@ module Icinga2
     # convert a Icinga2 state into a human readable state
     #
     # @param [String] state the Icinga2 State
-    # @param [Bool] is_host if this a Host or a Service Check
+    # @param [Bool] is_host (false) if this a Host or a Service Check
     #
     # @return [String]
+    #
     def self.state_to_string( state, is_host = false )
 
       state =
@@ -46,9 +47,10 @@ module Icinga2
     # convert a Icinga2 state into a named color
     #
     # @param [String] state the Icinga2 State
-    # @param [Bool] is_host if this a Host or a Service Check
+    # @param [Bool] is_host (false) if this a Host or a Service Check
     #
     # @return [String]
+    #
     def self.state_to_color( state, is_host = false )
 
       state =
@@ -83,6 +85,7 @@ module Icinga2
     # @param [String] name
     #
     # @return [String]
+    #
     def self.format_service( name )
       service_map = name.split('!', 2)
       service_map.join( ' - ' )

data/lib/icinga2/downtimes.rb

@@ -32,7 +32,10 @@ module Icinga2
     #
     # @return [Hash]
     #
-    def add_downtime( params = {} )
+    def add_downtime( params )
+
+      raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
 
       name            = params.dig(:name)
       host_name       = params.dig(:host)
@@ -46,29 +49,14 @@ module Icinga2
 
       # sanitychecks
       #
-      if( name.nil? )
-        return {
-          status: 404,
-          message: 'missing downtime name'
-        }
-      end
-
-      if( %w[host service].include?(type.downcase) == false )
-        return {
-          status: 404,
-          message: "wrong downtype type. only 'host' or' service' allowed ('#{type}' giving"
-        }
-      else
-        # we need the first char as Uppercase
-        type = type.capitalize
-      end
-
-      if( !host_group.nil? && !host_name.nil? )
-        return {
-          status: 404,
-          message: 'choose host or host_group, not both'
-        }
-      end
+      raise ArgumentError.new('Missing name') if( name.nil? )
+      raise ArgumentError.new("wrong downtype type. only 'host' or' service' allowed ('#{type}' giving)") if( %w[host service].include?(type.downcase) == false )
+      raise ArgumentError.new('choose host or host_group, not both') if( !host_group.nil? && !host_name.nil? )
+      raise ArgumentError.new('Missing downtime author') if( author.nil? )
+      raise ArgumentError.new("these author ar not exists: #{author}") unless( exists_user?( author ) )
+      raise ArgumentError.new('Missing downtime comment') if( comment.nil? )
+      raise ArgumentError.new('Missing downtime end_time') if( end_time.nil? )
+      raise ArgumentError.new('end_time are equal or smaller then start_time') if( end_time.to_i <= start_time )
 
       if( !host_name.nil? )
 
@@ -78,47 +66,10 @@ module Icinga2
         # check if hostgroup available ?
         #
         filter = format( '"%s" in host.groups', host_group )
-      else
-
-        return {
-          status: 404,
-          message: 'missing host or host_group for downtime'
-        }
-      end
-
-      if( comment.nil? )
-        return {
-          status: 404,
-          message: 'missing downtime comment'
-        }
-      end
-
-      if( author.nil? )
-        return {
-          status: 404,
-          message: 'missing downtime author'
-        }
-      elsif( exists_user?( author ) == false )
-        return {
-          status: 404,
-          message: "these author ar not exists: #{author}"
-        }
-      end
-
-      if( end_time.nil? )
-        return {
-          status: 404,
-          message: 'missing end_time'
-        }
-      elsif( end_time.to_i <= start_time )
-        return {
-          status: 404,
-          message: 'end_time are equal or smaller then start_time'
-        }
       end
 
       payload = {
-        'type'        => type,
+        'type'        => type.capitalize, # we need the first char as Uppercase
         'start_time'  => start_time,
         'end_time'    => end_time,
         'author'      => author,
@@ -128,45 +79,32 @@ module Icinga2
         'filter'      => filter
       }
 
-      Network.post(         host: name,
-        url: format( '%s/v1/actions/schedule-downtime', @icinga_api_url_base ),
+      Network.post(
+        url: format( '%s/actions/schedule-downtime', @icinga_api_url_base ),
         headers: @headers,
         options: @options,
-        payload: payload )
-
-
-      # schedule downtime for a host
-      #  --data '{ "type": "Host", "filter": "host.name==\"api_dummy_host_1\"", ... }'
-
-      # schedule downtime for all services of a host
-      #  --data '{ "type": "Service", "filter": "host.name==\"api_dummy_host_1\"", ... }'
-
-      # schedule downtime for all hosts and services in a hostgroup
-      #  --data '{ "type": "Host", "filter": "\"api_dummy_hostgroup\" in host.groups", ... }'
-
-      #  --data '{ "type": "Service", "filter": "\"api_dummy_hostgroup\" in host.groups)", ... }'
-
+        payload: payload
+      )
     end
 
     # return downtimes
     #
-    # @param [Hash] params
-    # @option params [String] :host
-    #
     # @example
     #    @icinga.downtimes
     #
-    # @return [Hash]
+    # @return [Array]
     #
-    def downtimes( params = {} )
-
-      host = params.dig(:host)
+    def downtimes
 
-      Network.get(         host: host,
-        url: format( '%s/v1/objects/downtimes/%s', @icinga_api_url_base, host ),
+      data = Network.api_data(
+        url: format( '%s/objects/downtimes'   , @icinga_api_url_base ),
         headers: @headers,
-        options: @options )
+        options: @options
+      )
+
+      return data.dig('results') if( data.dig(:status).nil? )
 
+      nil
     end
 
   end