RubyGems - icinga2 - Versions diffs - 0.8.1.2 → 0.9.0.1 - Mend

icinga2 0.8.1.2 → 0.9.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

data/doc/services.md CHANGED

@@ -4,17 +4,27 @@
 ## <a name="add-service"></a>add services
     add_services( params )
-**this function is not operable! need help, time and/or beer**
 ### Example
     services = {
-      'service-heap-mem' => {
-        'display_name'  => 'Tomcat - Heap Memory',
-        'check_command' => 'tomcat-heap-memory',
+      vars: {
+        display_name: 'Tomcat - Heap Memory',
+        check_command: 'tomcat-heap-memory'
       }
     }
-    @icinga.add_services( 'foo-bar.lan', services )
+    @icinga.add_services( host: 'icinga2', service_name: 'ping4', vars: services )
+    @icinga.add_services(
+      host: 'icinga2',
+      service_name: 'ping4',
+      vars: {
+        attrs: {
+          check_command: 'ping4',
+          check_interval: 10,
+          retry_interval: 30
+        }
+      }
+    )
 ## <a name="list-services"></a>list services
@@ -33,12 +43,19 @@
 ## <a name="delete-service"></a>delete
-**not yet implemented**
+    delete_service( params )
-## <a name="unhandled-services"></a>list unhandled_services
-**not yet implemented**
+#### Example
+    @icinga.delete_service(host: 'foo', service_name: 'ping4')
+    @icinga.delete_service(host: 'foo', service_name: 'new_ping4', cascade: true)
+## <a name="unhandled-services"></a>list unhandled_services
+    unhandled_services
+#### Example
+    @icinga.unhandled_services
 ## <a name="service-exists"></a>check if the service exists
@@ -84,13 +101,6 @@ or
     problems, problems_and_severity = @icinga.list_services_with_problems(10).values
-## <a name="update-host"></a>update host
-    update_host( hash, host )
-**this function is not operable! need help, time and/or beer**
-### Example
 ## <a name="count-all-services"></a>count all services
     services_all
@@ -117,3 +127,11 @@ or
 ### Example
     service_severity( {'attrs' => { 'state' => 0.0, 'acknowledgement' => 0.0, 'downtime_depth' => 0.0 } } )
+## <a name=""></a>(private) update host
+    update_host( hash, host )
+### Example
+    update_host( v, host_name )

data/doc/top-level-namespace.html CHANGED

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.4
 </title>
@@ -28,7 +28,7 @@
   </head>
   <body>
     <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
+      <iframe id="nav" src="class_list.html"></iframe>
       <div id="resizer"></div>
     </div>
@@ -59,6 +59,8 @@
         <div class="clear"></div>
       </div>
+      <iframe id="search_frame" src="class_list.html"></iframe>
       <div id="content"><h1>Top Level Namespace
@@ -82,10 +84,12 @@
 <p class="children">
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Icinga2.html" title="Icinga2 (module)">Icinga2</a></span>, <span class='object_link'><a href="Logging.html" title="Logging (module)">Logging</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Boolean.html" title="Boolean (module)">Boolean</a></span>, <span class='object_link'><a href="Icinga2.html" title="Icinga2 (module)">Icinga2</a></span>, <span class='object_link'><a href="Logging.html" title="Logging (module)">Logging</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>, <span class='object_link'><a href="FalseClass.html" title="FalseClass (class)">FalseClass</a></span>, <span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span>, <span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span>, <span class='object_link'><a href="Time.html" title="Time (class)">Time</a></span>, <span class='object_link'><a href="TrueClass.html" title="TrueClass (class)">TrueClass</a></span>
 </p>
@@ -100,9 +104,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 22 11:29:51 2017 by
+  Generated on Sun Nov 12 15:48:13 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.4).
+  0.9.4 (ruby-2.2.8).
 </div>
     </div>

data/examples/test.rb CHANGED

@@ -52,6 +52,9 @@ unless( i.nil? )
   puts ''
   puts ' ============================================================= '
+  puts '= icinga2 available'
+  puts i.available?
+  puts ''
   puts '= icinga2 status'
   puts i.status_data
   puts ''
@@ -74,6 +77,7 @@ unless( i.nil? )
   puts format( '= uptime: %s', i.uptime )
   puts ''
+  puts ''
   puts ' ------------------------------------------------------------- '
   puts ''
   puts ' ==> HOSTS'
@@ -84,15 +88,18 @@ unless( i.nil? )
   p, a = i.hosts_adjusted
-  puts format( '= host handled problems : %d', p )
-  puts format( '= host down adjusted    : %d', a )
+  puts format( '= host handled problems : %s', p )
+  puts format( '= host down adjusted    : %s', a )
   puts '= host objects'
+  all, down, critical, unknown = i.host_problems.values
   puts format( '= count of all hosts : %d', i.hosts_all )
-  puts format( '= hosts with problems: %d', i.hosts_problems )
-  puts format( '= hosts are down     : %d', i.hosts_down )
-  puts format( '= hosts are critical : %d', i.hosts_critical )
-  puts format( '= hosts are unknown  : %d', i.hosts_unknown )
+  puts format( '= hosts with problems: %s', i.list_hosts_with_problems )
+  puts format( '= hosts are down     : %d', down )
+  puts format( '= hosts are critical : %d', critical )
+  puts format( '= hosts are unknown  : %d', unknown )
   puts format( '= count hosts w. problems: %d', i.count_hosts_with_problems )
   ['icinga2', 'bp-foo'].each do |h|
@@ -113,8 +120,10 @@ unless( i.nil? )
   puts ''
   puts '= list all Hosts'
   puts i.hosts
+  puts ''
   puts ' = delete Host'
   puts i.delete_host( host: 'foo' )
+  puts ''
   puts ' = add Host'
   puts i.add_host(
      host: 'foo',
@@ -156,22 +165,28 @@ unless( i.nil? )
   puts ''
   puts ' ==> SERVICES'
   puts ''
+  i.cib_data
   i.service_objects
-  warning, critical, unknown = i.services_adjusted
+  all, warning, critical, unknown, pending, in_downtime, acknowledged = i.service_problems.values
   puts format( '= count of all services: %d', i.services_all )
-  puts format( '= services critical: %d', i.services_critical)
-  puts format( '= services warning: %d', i.services_warning)
-  puts format( '= services unknown: %d', i.services_unknown)
+  puts format( '= services warning: %d', warning)
+  puts format( '= services critical: %d', critical)
+  puts format( '= services unknown: %d', unknown)
+  puts format( '= services in downtime: %d', in_downtime)
+  puts format( '= services acknowledged: %d', acknowledged)
   puts ''
-  puts format( '= services handled warning problems: %d', i.services_handled_critical)
-  puts format( '= services handled critical problems: %d', i.services_handled_critical)
-  puts format( '= services handled unknown problems: %d', i.services_handled_unknown)
+  all, warning, critical, unknown = i.service_problems_handled.values
+  puts format( '= services handled warning problems: %d', warning)
+  puts format( '= services handled critical problems: %d', critical)
+  puts format( '= services handled unknown problems: %d', unknown)
   puts ''
+  warning, critical, unknown = i.services_adjusted.values
   puts format( '= services adjusted warning: %d',  warning)
   puts format( '= services adjusted critical: %d', critical)
   puts format( '= services adjusted unknown: %d',  unknown)
   puts ''
   puts '= check if service \'users\' on host \'icinga2\' exists'
   puts i.exists_service?( host: 'icinga2', service: 'users' )  ? 'true' : 'false'
@@ -195,6 +210,52 @@ unless( i.nil? )
   puts '= list all Services'
   puts i.services
   puts ''
+  puts '= add Service'
+  puts i.add_services(
+    host: 'icinga2',
+    service_name: 'new_http',
+    vars: {
+      attrs: {
+        check_command: 'http',
+        check_interval: 10,
+        retry_interval: 30,
+        vars: {
+          http_address: '127.0.0.1',
+          http_url: '/access/index',
+          http_port: 80
+        }
+      }
+    }
+  )
+  puts ''
+  puts '= list new named Service \'new_http\' from Host \'icinga2\''
+  puts i.services( host: 'icinga2', service: 'new_http' )
+  puts ''
+  puts '= modify named Service \'new_http\' from Host \'icinga2\''
+  puts JSON.pretty_generate  i.modify_service(
+    service_name: 'new_http',
+    vars: {
+      attrs: {
+        check_interval: 60,
+        retry_interval: 10,
+        vars: {
+          http_url: '/access/login'     ,
+          http_address: '10.41.80.63'
+        }
+      }
+    }
+  )
+  puts ''
+  puts '= list modified named Service \'new_http\' from Host \'icinga2\''
+  puts  JSON.pretty_generate i.services( host: 'icinga2', service: 'new_http' )
+  puts ''
+  puts '= delete named Service \'new_http\' from Host \'icinga2\''
+  puts i.delete_service(
+    host: 'icinga2',
+    service_name: 'new_http',
+    cascade: true
+  )
+  puts ''
   puts ' ------------------------------------------------------------- '
   puts ''

data/lib/icinga2.rb CHANGED

@@ -202,7 +202,6 @@ module Icinga2
     end
     # return Icinga2 Application data
     #
     # @example
@@ -322,6 +321,22 @@ module Icinga2
       )
     end
+    # check the availability of a Icinga network connect
+    #
+    # @example
+    #    @icinga.available?
+    #
+    # @return [Bool]
+    #
+    def available?
+      data = application_data
+      return true unless( data.nil? )
+      false
+    end
     # return Icinga2 version and revision
     #
     # @example

data/lib/icinga2/network.rb CHANGED

@@ -165,6 +165,7 @@ module Icinga2
         )
         data    = JSON.parse( data )
         results = data.dig('results').first
         return { status: results.dig('code').to_i, name: results.dig('name'), message: results.dig('status') } unless( results.nil? )
@@ -177,9 +178,6 @@ module Icinga2
         results = error.dig( 'results' )
         if( !results.nil? )
-#           result = result.first
           return {
             status: results.dig('code').to_i,
             name: results.dig('name'),
@@ -261,7 +259,7 @@ module Icinga2
         data    = JSON.parse( data )
         results = data.dig('results').first
-        return { status: results.dig('code').to_i, name: results.dig('name'), message: results.dig('status') } unless( results.nil? )
+        return { status: results.dig('code').to_i, message: results.dig('status') } unless( results.nil? )
       rescue RestClient::ExceptionWithResponse => e
@@ -273,7 +271,7 @@ module Icinga2
         return { status: error.dig('error').to_i, message: error.dig('status'), error: results } if( results.nil? )
         if( results.is_a?( Hash ) && results.count != 0 )
-#          result = result.first
           return {
             status: results.dig('code').to_i,
             name: results.dig('name'),
@@ -370,10 +368,14 @@ module Icinga2
             message: error.dig( 'status' )
           }
         else
+          results = results.first if( results.is_a?(Array) )
           return {
             status: results.dig('code').to_i,
             name: results.dig('name'),
-            message: results.dig('status')
+            message: results.dig('status'),
+            error: results.dig('errors')
           }
         end
       rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e

data/lib/icinga2/services.rb CHANGED

@@ -10,69 +10,204 @@ module Icinga2
     #
     # @param [Hash] params
     # @option params [String] :host
-    # @option params [String] :services
+    # @option params [String] :service_name
+    # @option params [Array] :templates
+    # @option params [Hash] :vars
     #
-    # @todo
-    #  this function is not operable
-    #  need help, time or beer
+    # @example
+    #    @icinga.add_services(
+    #      host: 'icinga2',
+    #      service_name: 'http2',
+    #      vars: {
+    #        attrs: {
+    #          check_command: 'http',
+    #          check_interval: 10,
+    #          retry_interval: 30,
+    #          vars: {
+    #            http_address: '127.0.0.1',
+    #            http_url: '/access/index',
+    #            http_port: 80
+    #          }
+    #        }
+    #      }
+    #    )
     #
     # @return [Hash]
+    #    * status
+    #    * message
     #
     def add_services( params = {} )
       raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
-      # TODO
-      puts 'add_services() ToDo'
+      host_name    = params.dig(:host)
+      service_name = params.dig(:service_name)
+      templates    = params.dig(:templates) || ['generic-service']
+      vars         = params.dig(:vars)
-      host_name = params.dig(:host)
-      services  = params.dig(:services)
+      raise ArgumentError.new('Missing host') if( host_name.nil? )
+      raise ArgumentError.new('Missing service_name') if( service_name.nil? )
+      raise ArgumentError.new('only Array for templates are allowed') unless( templates.is_a?(Array) )
+      raise ArgumentError.new('Missing vars') if( vars.nil? )
+      raise ArgumentError.new('only Hash for vars are allowed') unless( vars.is_a?(Hash) )
+      # validate
+      # needed_values = %w[check_command check_interval retry_interval]
-      services.each do |s,v|
+      attrs = vars.dig(:attrs)
+      validate_check_command  = attrs.select { |k,_v| k == 'check_command'.to_sym }.size
+      validate_check_interval = attrs.select { |k,_v| k == 'check_interval'.to_sym }.size
+      validate_retry_interval = attrs.select { |k,_v| k == 'retry_interval'.to_sym }.size
+      raise 'Error in attrs, expected \'check_command\' but was not found' if( validate_check_command.zero? )
+      raise 'Error in attrs, expected \'check_interval\' but was not found' if( validate_check_interval.zero? )
+      raise 'Error in attrs, expected \'retry_interval\' but was not found' if( validate_retry_interval.zero? )
+      payload = ''
+      vars.each do |_s,v|
         payload = {
-          'templates' => [ 'generic-service' ],
+          'templates' => templates,
           'attrs'     => update_host( v, host_name )
         }
+      end
+      Network.put(
+        url: format( '%s/objects/services/%s!%s', @icinga_api_url_base, host_name, service_name ),
+        headers: @headers,
+        options: @options,
+        payload: payload
+      )
+    end
+    # delete a service
+    #
+    # @param [Hash] params
+    # @option params [String] :host host name for the service
+    # @option params [String] :service_name
+    # @option params [Bool] :cascade (false) delete service also when other objects depend on it
+    #
+    # @example
+    #   @icinga.delete_service(host: 'foo', service_name: 'http2')
+    #   @icinga.delete_service(host: 'foo', service_name: 'http2', cascade: true)
+    #
+    # @return [Hash] result
+    #
+    def delete_service( params )
+      raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
-        logger.debug( s )
-        logger.debug( v.to_json )
+      host_name    = params.dig(:host)
+      service_name = params.dig(:service_name)
+      cascade      = params.dig(:cascade)
-        logger.debug( JSON.pretty_generate( payload ) )
+      raise ArgumentError.new('Missing host') if( host_name.nil? )
+      raise ArgumentError.new('Missing service_name') if( service_name.nil? )
-        Network.put(
-          url: format( '%s/objects/services/%s!%s', @icinga_api_url_base, host_name, s ),
-          headers: @headers,
-          options: @options,
-          payload: payload
-        )
+      if( ! cascade.nil? && ( ! cascade.is_a?(TrueClass) && ! cascade.is_a?(FalseClass) ) )
+        raise ArgumentError.new('cascade can only be true or false')
       end
+      url = format( '%s/objects/services/%s!%s%s', @icinga_api_url_base, host_name, service_name, cascade.is_a?(TrueClass) ? '?cascade=1' : nil )
+      Network.delete(
+        url: url,
+        headers: @headers,
+        options: @options
+      )
     end
-    # return all unhandled services
+    # modify an service
     #
     # @param [Hash] params
+    # @option params [String] :service_name
+    # @option params [Hash] :vars
     #
-    # @todo
-    #  this function is not operable
-    #  need help, time or beer
+    # @example
+    #    @icinga.modify_service(
+    #      service_name: 'http2',
+    #      vars: {
+    #        attrs: {
+    #          check_interval: 60,
+    #          retry_interval: 10,
+    #          vars: {
+    #            http_url: '/access/login'     ,
+    #            http_address: '10.41.80.63'
+    #          }
+    #        }
+    #      }
+    #    )
     #
-    # @return [Nil]
+    # @return [Hash]
+    #    * status
+    #    * message
     #
-    def unhandled_services( params = {} )
+    def modify_service( params )
       raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
-      # TODO
-      puts 'unhandled_services() ToDo'
+      templates     = params.dig(:templates) || ['generic-service']
+      vars          = params.dig(:vars)
+      service_name  = params.dig(:service_name)
-      # taken from https://blog.netways.de/2016/11/18/icinga-2-api-cheat-sheet/
-      # 5) Anzeige aller Services die unhandled sind und weder in Downtime, noch acknowledged sind
-      # /usr/bin/curl -k -s -u 'root:icinga' -H 'X-HTTP-Method-Override: GET' -X POST
-      # 'https://127.0.0.1:5665/objects/services' #
-      # -d '{ "attrs": [ "__name", "state", "downtime_depth", "acknowledgement" ], "filter": "service.state != ServiceOK && service.downtime_depth == 0.0 && service.acknowledgement == 0.0" }''' | jq
+      raise ArgumentError.new('Missing service_name') if( service_name.nil? )
+      raise ArgumentError.new('only Array for templates are allowed') unless( templates.is_a?(Array) )
+      raise ArgumentError.new('Missing vars') if( vars.nil? )
+      raise ArgumentError.new('only Hash for vars are allowed') unless( vars.is_a?(Hash) )
+      payload = {}
+      vars.each do |_s,v|
+        payload = {
+          'templates' => templates,
+          'attrs'     => v
+        }
+      end
+      payload['filter'] = format( 'service.name=="%s"', service_name )
+      Network.post(
+        url: format( '%s/objects/services', @icinga_api_url_base ),
+        headers: @headers,
+        options: @options,
+        payload: payload
+      )
+    end
+    # return all unhandled services
+    #
+    # @example
+    #    @icinga.unhandled_services
+    #
+    # @return [Hash]
+    #
+    def unhandled_services
+      payload = {}
+      filter = 'service.state != ServiceOK && service.downtime_depth == 0.0 && service.acknowledgement == 0.0'
+      attrs  = %w[__name name state acknowledgement downtime_depth last_check]
+      payload['attrs']  = attrs unless  attrs.nil?
+      payload['filter'] = filter unless filter.nil?
+      data = Network.api_data(
+        url: format( '%s/objects/services', @icinga_api_url_base ),
+        headers: @headers,
+        options: @options,
+        payload: payload
+      )
+      status  = data.dig(:status)
+      data.dig('results') if( status.nil? )
     end
     # return services
@@ -121,7 +256,7 @@ module Icinga2
     # @option params [String] :service
     #
     # @example
-    #    @icinga.exists_service?(host: 'icinga2', service: 'users' )
+    #    @icinga.exists_service?(host: 'icinga2', service: 'users')
     #
     # @return [Bool]
     #
@@ -308,36 +443,6 @@ module Icinga2
       }
     end
-    # update host
-    #
-    # @param [Hash] hash
-    # @param [String] host
-    #
-    # @todo
-    #  this function are not operable
-    #  need help, time or beer
-    #
-    # @return [Hash]
-    #
-    def update_host( hash, host )
-      hash.each do |k, v|
-        if( k == 'host' && v.is_a?( String ) )
-          v.replace( host )
-        elsif( v.is_a?( Hash ) )
-          update_host( v, host )
-        elsif( v.is_a?(Array) )
-          v.flatten.each { |x| update_host( x, host ) if x.is_a?( Hash ) }
-        end
-      end
-      hash
-    end
     # returns a counter of all services
     #
     # @example
@@ -351,12 +456,51 @@ module Icinga2
       @services_all
     end
+    # returns data with service problems
+    #
+    # @example
+    #    @icinga.cib_data
+    #    all, warning, critical, unknown, pending, in_downtime, acknowledged = @icinga.service_problems.values
+    #
+    #    p = @icinga.service_problems
+    #    warning = p.dig(:warning)
+    #
+    # @return [Hash]
+    #    * ok
+    #    * warning
+    #    * critical
+    #    * unknown
+    #    * pending
+    #    * in_downtime
+    #    * acknowledged
+    #
+    def service_problems
+      services_ok           = @services_ok.nil?           ? 0 : @services_ok
+      services_warning      = @services_warning.nil?      ? 0 : @services_warning
+      services_critical     = @services_critical.nil?     ? 0 : @services_critical
+      services_unknown      = @services_unknown.nil?      ? 0 : @services_unknown
+      services_pending      = @services_pending.nil?      ? 0 : @services_pending
+      services_in_downtime  = @services_in_downtime.nil?  ? 0 : @services_in_downtime
+      services_acknowledged = @services_acknowledged.nil? ? 0 : @services_acknowledged
+      {
+        ok: services_ok.to_i,
+        warning: services_critical.to_i,
+        critical: services_warning.to_i,
+        unknown: services_unknown.to_i,
+        pending: services_pending.to_i,
+        in_downtime: services_in_downtime.to_i,
+        acknowledged: services_acknowledged.to_i
+      }
+    end
     # returns data with service problems they be handled (acknowledged or in downtime)
     #
     # @example
     #    @icinga.cib_data
     #    @icinga.service_objects
-    #    all, critical, warning, unknown = @icinga.service_problems_handled.values
+    #    all, warning, critical, unknown = @icinga.service_problems_handled.values
     #
     #    p = @icinga.service_problems_handled
     #    warning = p.dig(:warning)
@@ -376,8 +520,8 @@ module Icinga2
       {
         all: problems_all.to_i,
-        critical: problems_critical.to_i,
         warning: problems_warning.to_i,
+        critical: problems_critical.to_i,
         unknown: problems_unknown.to_i
       }
@@ -462,5 +606,39 @@ module Icinga2
       severity
     end
+    private
+    # update host
+    #
+    # @param [Hash] hash
+    # @param [String] host
+    #
+    # @todo
+    #  this function are not operable
+    #  need help, time or beer
+    #
+    # @api protected
+    #
+    # @return [Hash]
+    #
+    def update_host( hash, host )
+      hash.each do |k, v|
+        if( k == 'host' && v.is_a?( String ) )
+          v.replace( host )
+        elsif( v.is_a?( Hash ) )
+          update_host( v, host )
+        elsif( v.is_a?(Array) )
+          v.flatten.each { |x| update_host( x, host ) if x.is_a?( Hash ) }
+        end
+      end
+      hash
+    end
   end
 end