icinga2 0.9.2.8 → 1.0.0

data/lib/icinga2/notifications.rb

@@ -11,7 +11,7 @@ module Icinga2
     # @param [String] host
     #
     # @example
-    #    @icinga.enable_host_notification('icinga')
+    #    enable_host_notification('icinga')
     #
     # @return [Hash]
     #
@@ -30,7 +30,7 @@ module Icinga2
     # @param [String] host
     #
     # @example
-    #    @icinga.disable_host_notification('icinga')
+    #    disable_host_notification('icinga')
     #
     # @return [Hash]
     #
@@ -49,7 +49,7 @@ module Icinga2
     # @param [String] host
     #
     # @example
-    #    @icinga.enable_service_notification('icinga')
+    #    enable_service_notification('icinga')
     #
     # @return [Hash]
     #
@@ -68,7 +68,7 @@ module Icinga2
     # @param [String] host
     #
     # @example
-    #    @icinga.disable_service_notification('icinga')
+    #    disable_service_notification('icinga')
     #
     # @return [Hash]
     #
@@ -87,7 +87,7 @@ module Icinga2
     # @param [String] host_group
     #
     # @example
-    #    @icinga.enable_hostgroup_notification('linux-servers')
+    #    enable_hostgroup_notification('linux-servers')
     #
     # @return [Hash]
     #
@@ -106,7 +106,7 @@ module Icinga2
     # @param [String] host_group
     #
     # @example
-    #    @icinga.disable_hostgroup_notification('linux-servers')
+    #    disable_hostgroup_notification('linux-servers')
     #
     # @return [Hash]
     #
@@ -152,7 +152,11 @@ module Icinga2
       name = validate( params, required: true, var: 'name', type: String )
       notifications = validate( params, required: false, var: 'enable_notifications', type: Boolean ) || false
 
-      payload = { attrs: { enable_notifications: notifications } }
+      payload = {
+        attrs: {
+          enable_notifications: notifications
+        }
+      }
 
       post(
         url: format( '%s/objects/hosts/%s', @icinga_api_url_base, name ),
@@ -181,7 +185,9 @@ module Icinga2
 
       payload = {
         filter: format( '"%s" in host.groups', group ),
-        attrs: { enable_notifications: notifications }
+        attrs: {
+          enable_notifications: notifications
+        }
       }
 
       post(
@@ -211,7 +217,9 @@ module Icinga2
 
       payload = {
         filter: format( 'host.name=="%s"', name ),
-        attrs: { enable_notifications: notifications }
+        attrs: {
+          enable_notifications: notifications
+        }
       }
 
       post(

data/lib/icinga2/servicegroups.rb

@@ -16,7 +16,7 @@ module Icinga2
     # @option params [String] action_url
     #
     # @example
-    #   @icinga.add_servicegroup(service_group: 'foo', display_name: 'FOO')
+    #   add_servicegroup(service_group: 'foo', display_name: 'FOO')
     #
     # @return [Hash] result
     #
@@ -59,7 +59,7 @@ module Icinga2
     # @option params [Bool] cascade (false) delete servicegroup also when other objects depend on it
     #
     # @example
-    #   @icinga.delete_servicegroup('foo')
+    #   delete_servicegroup('foo')
     #
     # @return [Array] result
     #
@@ -87,10 +87,10 @@ module Icinga2
     # @param [String] service_group (nil) optional for a single servicegroup
     #
     # @example to get all users
-    #    @icinga.servicegroups
+    #    servicegroups
     #
     # @example to get one user
-    #    @icinga.servicegroups(service_group: 'disk')
+    #    servicegroups(service_group: 'disk')
     #
     # @return [Array] returns a hash with all servicegroups
     #
@@ -113,7 +113,7 @@ module Icinga2
     # @param [String] service_group the name of the servicegroup
     #
     # @example
-    #    @icinga.exists_servicegroup?('disk')
+    #    exists_servicegroup?('disk')
     #
     # @return [Bool] returns true if the servicegroup exists
     #

data/lib/icinga2/services.rb

@@ -21,12 +21,12 @@ module Icinga2
     # @option params [String] check_period
     # @option params [Integer] check_timeout
     # @option params [String] command_endpoint
-    # @option params [Boolean] enable_active_checks
-    # @option params [Boolean] enable_event_handler
-    # @option params [Boolean] enable_flapping
-    # @option params [Boolean] enable_notifications
-    # @option params [Boolean] enable_passive_checks
-    # @option params [Boolean] enable_perfdata
+    # @option params [Bool] enable_active_checks
+    # @option params [Bool] enable_event_handler
+    # @option params [Bool] enable_flapping
+    # @option params [Bool] enable_notifications
+    # @option params [Bool] enable_passive_checks
+    # @option params [Bool] enable_perfdata
     # @option params [String] event_command
     # @option params [Integer] flapping_threshold_high
     # @option params [Integer] flapping_threshold_low
@@ -35,11 +35,11 @@ module Icinga2
     # @option params [String] icon_image
     # @option params [Integer] max_check_attempts
     # @option params [Integer] retry_interval
-    # @option params [Boolean] volatile
+    # @option params [Bool] volatile
     # @option params [Hash] vars
     #
     # @example
-    #    @icinga.add_service(
+    #    add_service(
     #      name: 'http2',
     #      host_name: 'icinga2',
     #      check_command: 'http',
@@ -144,8 +144,8 @@ module Icinga2
     # @option params [Bool] cascade (false) delete service also when other objects depend on it
     #
     # @example
-    #   @icinga.delete_service(host_name: 'foo', name: 'http2')
-    #   @icinga.delete_service(host_name: 'foo', name: 'http2', cascade: true)
+    #   delete_service(host_name: 'foo', name: 'http2')
+    #   delete_service(host_name: 'foo', name: 'http2', cascade: true)
     #
     # @return [Hash] result
     #
@@ -176,7 +176,7 @@ module Icinga2
     # @option params [Hash] vars
     #
     # @example
-    #    @icinga.modify_service(
+    #    modify_service(
     #      name: 'http2',
     #      check_interval: 60,
     #      retry_interval: 10,
@@ -275,7 +275,7 @@ module Icinga2
     # return all unhandled services
     #
     # @example
-    #    @icinga.unhandled_services
+    #    unhandled_services
     #
     # @return [Hash]
     #
@@ -308,10 +308,10 @@ module Icinga2
     # @option params [String] name
     #
     # @example to get all services
-    #    @icinga.services
+    #    services
     #
     # @example to get one service for host
-    #    @icinga.services( host_name: 'icinga2', name: 'ping4' )
+    #    services( host_name: 'icinga2', name: 'ping4' )
     #
     # @return [Hash]
     #
@@ -339,7 +339,7 @@ module Icinga2
     # @option params [String] name
     #
     # @example
-    #    @icinga.exists_service?(host_name: 'icinga2', name: 'users')
+    #    exists_service?(host_name: 'icinga2', name: 'users')
     #
     # @return [Bool]
     #
@@ -368,10 +368,10 @@ module Icinga2
     # @option params [Array] joins (['host.name','host.state','host.acknowledgement','host.downtime_depth','host.last_check'])
     #
     # @example with default attrs and joins
-    #    @icinga.service_objects
+    #    service_objects
     #
     # @example
-    #    @icinga.service_objects(attrs: ['name', 'state'], joins: ['host.name','host.state'])
+    #    service_objects(attrs: ['name', 'state'], joins: ['host.name','host.state'])
     #
     # @return [Array]
     #
@@ -415,9 +415,9 @@ module Icinga2
     # returns adjusted service state
     #
     # @example
-    #    warning, critical, unknown = @icinga.services_adjusted.values
+    #    warning, critical, unknown = services_adjusted.values
     #
-    #    s = @icinga.services_adjusted
+    #    s = services_adjusted
     #    unknown = s.dig(:unknown)
     #
     # @return [Hash]
@@ -455,7 +455,7 @@ module Icinga2
     # return count of services with problems
     #
     # @example
-    #    @icinga.count_services_with_problems
+    #    count_services_with_problems
     #
     # @return [Integer]
     #
@@ -476,9 +476,9 @@ module Icinga2
     # @param [Integer] max_items numbers of list entries
     #
     # @example
-    #    problems, problems_and_severity = @icinga.list_services_with_problems.values
+    #    problems, problems_and_severity = list_services_with_problems.values
     #
-    #    l = @icinga.list_services_with_problems
+    #    l = list_services_with_problems
     #    problems_and_severity = l.dig(:services_with_problems_and_severity)
     #
     # @return [Hash]
@@ -501,9 +501,11 @@ module Icinga2
           name  = s.dig('name')
           state = s.dig('attrs','state')
 
-          next if  state.zero?
+          next if( state.zero? )
 
-          services_with_problems[name] = service_severity(s)
+          # TODO
+          # change spec tests!
+          services_with_problems[name] = state # service_severity(s)
         end
 
         if( services_with_problems.count != 0 )
@@ -521,7 +523,7 @@ module Icinga2
     # returns a counter of all services
     #
     # @example
-    #    @icinga.services_all
+    #    services_all
     #
     # @return [Integer]
     #
@@ -536,9 +538,9 @@ module Icinga2
     # returns data with service problems
     #
     # @example
-    #    all, warning, critical, unknown, pending, in_downtime, acknowledged, adjusted_warning, adjusted_critical, adjusted_unknown = @icinga.service_problems.values
+    #    all, warning, critical, unknown, pending, in_downtime, acknowledged, adjusted_warning, adjusted_critical, adjusted_unknown = service_problems.values
     #
-    #    p = @icinga.service_problems
+    #    p = service_problems
     #    warning = p.dig(:warning)
     #
     # @return [Hash]
@@ -593,10 +595,10 @@ module Icinga2
     # returns data with service problems they be handled (acknowledged or in downtime)
     #
     # @example
-    #    @icinga.service_objects
-    #    all, warning, critical, unknown = @icinga.service_problems_handled.values
+    #    service_objects
+    #    all, warning, critical, unknown = service_problems_handled.values
     #
-    #    p = @icinga.service_problems_handled
+    #    p = service_problems_handled
     #    warning = p.dig(:warning)
     #
     # @return [Hash]

data/lib/icinga2/statistics.rb

@@ -10,9 +10,9 @@ module Icinga2
     # return statistic data for latency and execution_time
     #
     # @example
-    #    latency, execution_time = @icinga.average_statistics.values
+    #    latency, execution_time = average_statistics.values
     #
-    #    h = @icinga.average_statistics
+    #    h = average_statistics
     #    latency = h.dig(:latency)
     #
     # @return [Hash]
@@ -35,9 +35,9 @@ module Icinga2
     # return statistic data for intervall data
     #
     # @example
-    #    hosts_active_checks, hosts_passive_checks, services_active_checks, services_passive_checks = @icinga.interval_statistics.values
+    #    hosts_active_checks, hosts_passive_checks, services_active_checks, services_passive_checks = interval_statistics.values
     #
-    #    i = @icinga.interval_statistics
+    #    i = interval_statistics
     #    hosts_active_checks = i.dig(:hosts_active_checks)
     #
     # @return [Hash]
@@ -68,9 +68,9 @@ module Icinga2
     # return statistic data for services
     #
     # @example
-    #    ok, warning, critical, unknown, pending, in_downtime, ack = @icinga.service_statistics.values
+    #    ok, warning, critical, unknown, pending, in_downtime, ack = service_statistics.values
     #
-    #    s = @icinga.service_statistics
+    #    s = service_statistics
     #    critical = s.dig(:critical)
     #
     # @return [Hash]
@@ -108,9 +108,9 @@ module Icinga2
     # return statistic data for hosts
     #
     # @example
-    #    up, down, pending, unreachable, in_downtime, ack = @icinga.host_statistics.values
+    #    up, down, pending, unreachable, in_downtime, ack = host_statistics.values
     #
-    #    h = @icinga.host_statistics
+    #    h = host_statistics
     #    pending = h.dig(:pending)
     #
     # @return [Hash]
@@ -146,7 +146,7 @@ module Icinga2
     # return queue statistics from the api
     #
     # @example
-    #    @icinga.work_queue_statistics
+    #    work_queue_statistics
     #
     # @return [Hash]
     #
@@ -171,14 +171,17 @@ module Icinga2
         graphite_data  = graphite_data.dig('status', 'graphitewriter', 'graphite')       unless( graphite_data.nil? )
         ido_mysql_data = ido_mysql_data.dig('status', 'idomysqlconnection', 'ido-mysql') unless( ido_mysql_data.nil? )
 
-        a = {}
-        a['json_rpc']  = json_rpc_data  if(json_rpc_data.is_a?(Hash))
-        a['graphite']  = graphite_data  if(graphite_data.is_a?(Hash))
-        a['ido-mysql'] = ido_mysql_data if(ido_mysql_data.is_a?(Hash))
+        payload = {
+          json_rpc: json_rpc_data,
+          graphite: graphite_data,
+          ido_mysql: ido_mysql_data
+        }
+
+        payload.reject!{ |_k, v| v.nil? }
 
         key_list = %w[work_queue_item_rate query_queue_item_rate]
 
-        a.each do |k,v|
+        payload.each do |k,v|
           key_list.each do |key|
             if( v.include?( key ))
               attr_name = format('%s queue rate', k)

data/lib/icinga2/tools.rb

@@ -49,18 +49,18 @@ module Icinga2
     # @param [Integer] state (nil)
     #
     # @example for host objects
-    #    h_objects = @icinga.host_objects
-    #    all = @icinga.count_problems(h_objects)
-    #    down = @icinga.count_problems(h_objects, Icinga2::HOSTS_DOWN)
-    #    critical = @icinga.count_problems(h_objects, Icinga2::HOSTS_CRITICAL)
-    #    unknown = @icinga.count_problems(h_objects, Icinga2::HOSTS_UNKNOWN)
+    #    h_objects = host_objects
+    #    all = count_problems(h_objects)
+    #    down = count_problems(h_objects, Icinga2::HOSTS_DOWN)
+    #    critical = count_problems(h_objects, Icinga2::HOSTS_CRITICAL)
+    #    unknown = count_problems(h_objects, Icinga2::HOSTS_UNKNOWN)
     #
     # @example for service objects
-    #    s_objects = @icinga.service_objects
-    #    all = @icinga.count_problems(s_objects)
-    #    warning = @icinga.count_problems(s_objects, Icinga2::SERVICE_STATE_WARNING)
-    #    critical = @icinga.count_problems(s_objects, Icinga2::SERVICE_STATE_CRITICAL)
-    #    unknown = @icinga.count_problems(s_objects, Icinga2::SERVICE_STATE_UNKNOWN)
+    #    s_objects = service_objects
+    #    all = count_problems(s_objects)
+    #    warning = count_problems(s_objects, Icinga2::SERVICE_STATE_WARNING)
+    #    critical = count_problems(s_objects, Icinga2::SERVICE_STATE_CRITICAL)
+    #    unknown = count_problems(s_objects, Icinga2::SERVICE_STATE_UNKNOWN)
     #
     # @return [Integer]
     #
@@ -91,5 +91,26 @@ module Icinga2
       f.size
     end
 
+
+    # check, it an String a valid Json
+    #
+    # @param json [String] json
+    #
+    # @example
+    #   valid_json?( json )
+    #
+    # @return [Bool]
+    #
+    def valid_json?( json )
+
+      begin
+        JSON.parse( json )
+        return true
+      rescue JSON::ParserError => e
+        @logger.error("json parse error: #{e}") if @debug
+        return false
+      end
+
+    end
   end
 end

data/lib/icinga2/usergroups.rb

@@ -13,7 +13,7 @@ module Icinga2
     # @option params [String] display_name the displayed name
     #
     # @example
-    #   @icinga.add_usergroup(user_group: 'foo', display_name: 'FOO')
+    #   add_usergroup(user_group: 'foo', display_name: 'FOO')
     #
     # @return [Hash] result
     #
@@ -48,7 +48,7 @@ module Icinga2
     # @param [String] user_group usergroup to delete
     #
     # @example
-    #   @icinga.delete_usergroup('foo')
+    #   delete_usergroup('foo')
     #
     # @return [Hash] result
     #
@@ -69,10 +69,10 @@ module Icinga2
     # @param [String] user_group (nil) optional for a single usergroup
     #
     # @example to get all users
-    #    @icinga.usergroups
+    #    usergroups
     #
     # @example to get one user
-    #    @icinga.usergroups('icingaadmins')
+    #    usergroups('icingaadmins')
     #
     # @return [Hash] returns a hash with all usergroups
     #
@@ -93,7 +93,7 @@ module Icinga2
     # @param [String] user_group the name of the usergroups
     #
     # @example
-    #    @icinga.exists_usergroup?('icingaadmins')
+    #    exists_usergroup?('icingaadmins')
     #
     # @return [Bool] returns true if the usergroup exists
     #