Module: Icinga2::Services
- Included in:
- Client
- Defined in:
- lib/icinga2/services.rb
Overview
namespace for service handling
Instance Method Summary collapse
-
#add_service(params = {}) ⇒ Hash
add service.
-
#count_services_with_problems ⇒ Integer
return count of services with problems.
-
#delete_service(params) ⇒ Hash
delete a service.
-
#exists_service?(params) ⇒ Bool
returns true if the service exists.
-
#list_services_with_problems(max_items = 5) ⇒ Hash
return a list of services with problems.
-
#modify_service(params) ⇒ Hash
modify an service.
-
#service_objects(params = {}) ⇒ Array
returns service objects.
-
#service_problems ⇒ Hash
returns data with service problems.
-
#service_problems_handled ⇒ Hash
returns data with service problems they be handled (acknowledged or in downtime).
-
#services(params = {}) ⇒ Hash
return services.
-
#services_adjusted ⇒ Hash
returns adjusted service state.
-
#services_all ⇒ Integer
returns a counter of all services.
-
#unhandled_services ⇒ Hash
return all unhandled services.
Instance Method Details
#add_service(params = {}) ⇒ Hash
add service
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/icinga2/services.rb', line 34 def add_service( params = {} ) raise ArgumentError.new(format('wrong type. params must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) ) raise ArgumentError.new('missing params') if( params.size.zero? ) name = params.dig(:name) host_name = params.dig(:host_name) display_name = params.dig(:display_name) groups = params.dig(:groups) check_command = params.dig(:check_command) max_check_attempts = params.dig(:max_check_attempts) check_period = params.dig(:check_period) check_timeout = params.dig(:check_timeout) check_interval = params.dig(:check_interval) retry_interval = params.dig(:retry_interval) enable_notifications = params.dig(:enable_notifications) enable_active_checks = params.dig(:enable_active_checks) enable_passive_checks = params.dig(:enable_passive_checks) enable_event_handler = params.dig(:enable_event_handler) enable_flapping = params.dig(:enable_flapping) flapping_threshold = params.dig(:flapping_threshold) enable_perfdata = params.dig(:enable_perfdata) event_command = params.dig(:event_command) volatile = params.dig(:volatile) zone = params.dig(:zone) command_endpoint = params.dig(:command_endpoint) notes = params.dig(:notes) notes_url = params.dig(:notes_url) action_url = params.dig(:action_url) icon_image = params.dig(:icon_image) icon_image_alt = params.dig(:icon_image_alt) templates = params.dig(:templates) || ['generic-service'] vars = params.dig(:vars) || {} raise ArgumentError.new('missing name') if( name.nil? ) %w[display_name host_name check_command check_period event_command zone name command_endpoint notes notes_url action_url icon_image icon_image_alt ].each do |attr| v = eval(attr) raise ArgumentError.new(format('wrong type. \'%s\' must be an String, given \'%s\'', attr, v.class.to_s)) unless( v.is_a?(String) || v.nil? ) end %w[max_check_attempts flapping_threshold check_timeout check_interval retry_interval].each do |attr| v = eval(attr) raise ArgumentError.new(format('wrong type. \'%s\' must be an Integer, given \'%s\'', attr, v.class.to_s)) unless( v.is_a?(Integer) || v.nil? ) end %w[enable_notifications enable_active_checks enable_passive_checks enable_event_handler enable_flapping enable_perfdata volatile].each do |attr| v = eval(attr) raise ArgumentError.new(format('wrong type. \'%s\' must be True or False, given \'%s\'', attr, v.class.to_s)) unless( v.is_a?(TrueClass) || v.is_a?(FalseClass) || v.nil? ) end %w[groups templates].each do |attr| v = eval(attr) raise ArgumentError.new(format('wrong type. \'%s\' must be an Array, given \'%s\'', attr, v.class.to_s)) unless( v.is_a?(Array) || v.nil? ) end raise ArgumentError.new(format('wrong type. \'vars\' must be an Hash, given \'%s\'', v.class.to_s)) unless( vars.is_a?(Hash) ) payload = { 'templates' => templates, 'attrs' => { 'display_name' => display_name, 'groups' => groups, 'check_command' => check_command, 'max_check_attempts' => max_check_attempts, 'check_period' => check_period, 'check_timeout' => check_timeout, 'check_interval' => check_interval, 'retry_interval' => retry_interval, 'enable_notifications' => enable_notifications, 'enable_active_checks' => enable_active_checks, 'enable_passive_checks' => enable_passive_checks, 'enable_event_handler' => enable_event_handler, 'enable_flapping' => enable_flapping, 'flapping_threshold' => flapping_threshold, 'zone' => zone, 'enable_perfdata' => enable_perfdata, 'event_command' => event_command, 'volatile' => volatile, 'command_endpoint' => command_endpoint, 'notes' => notes, 'notes_url' => notes_url, 'action_url' => action_url, 'icon_image' => icon_image, 'icon_image_alt' => icon_image_alt, } } payload['attrs']['vars'] = vars unless vars.empty? # clear undefined settings payload.reject!{ |_k, v| v.nil? } payload['attrs'].reject!{ |_k, v| v.nil? } put( url: format( '%s/objects/services/%s!%s', @icinga_api_url_base, host_name, name ), headers: @headers, options: @options, payload: payload ) end |
#count_services_with_problems ⇒ Integer
return count of services with problems
453 454 455 456 457 458 459 460 461 462 463 |
# File 'lib/icinga2/services.rb', line 453 def count_services_with_problems service_data = service_objects service_data = JSON.parse(service_data) if service_data.is_a?(String) return 0 if( service_data.nil? ) f = service_data.select { |t| t.dig('attrs','state') != 0 && t.dig('attrs','downtime_depth').zero? && t.dig('attrs','acknowledgement').zero? } f.size end |
#delete_service(params) ⇒ Hash
delete a service
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/icinga2/services.rb', line 172 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? ) host_name = params.dig(:host_name) name = params.dig(:name) cascade = params.dig(:cascade) raise ArgumentError.new('Missing host') if( host_name.nil? ) raise ArgumentError.new('Missing service name') if( name.nil? ) 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, name, cascade.is_a?(TrueClass) ? '?cascade=1' : nil ) delete( url: url, headers: @headers, options: @options ) end |
#exists_service?(params) ⇒ Bool
returns true if the service exists
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/icinga2/services.rb', line 329 def exists_service?( params ) raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) ) raise ArgumentError.new('missing params') if( params.size.zero? ) host = params.dig(:host_name) service = params.dig(:name) raise ArgumentError.new('Missing host') if( host.nil? ) raise ArgumentError.new('Missing service') if( service.nil? ) result = services( host_name: host, name: service ) result = JSON.parse( result ) if result.is_a?( String ) result = result.first if( result.is_a?(Array) ) return false if( result.is_a?(Hash) && result.dig('code') == 404 ) true end |
#list_services_with_problems(max_items = 5) ⇒ Hash
return a list of services with problems
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/icinga2/services.rb', line 479 def list_services_with_problems( max_items = 5 ) services_with_problems = {} services_with_problems_and_severity = {} # only fetch the minimal attribute set required for severity calculation services_data = service_objects services_data = JSON.parse( services_data ) if services_data.is_a?(String) unless( services_data.nil? ) services_data.each do |s| name = s.dig('name') state = s.dig('attrs','state') next if state.zero? services_with_problems[name] = service_severity(s) end if( services_with_problems.count != 0 ) services_with_problems.sort.reverse! services_with_problems = services_with_problems.keys[1..max_items].each { |k| services_with_problems_and_severity[k] = services_with_problems[k] } end end { services_with_problems: services_with_problems, services_with_problems_and_severity: services_with_problems_and_severity } end |
#modify_service(params) ⇒ Hash
modify an service
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/icinga2/services.rb', line 224 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? ) templates = params.dig(:templates) || ['generic-service'] vars = params.dig(:vars) name = params.dig(:name) raise ArgumentError.new('Missing service name') if( 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_value do |v| payload = { 'templates' => templates, 'attrs' => v } end payload['filter'] = format( 'service.name=="%s"', name ) post( url: format( '%s/objects/services', @icinga_api_url_base ), headers: @headers, options: @options, payload: payload ) end |
#service_objects(params = {}) ⇒ Array
returns service objects
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/icinga2/services.rb', line 364 def service_objects( params = {} ) attrs = params.dig(:attrs) filter = params.dig(:filter) joins = params.dig(:joins) payload = {} if( attrs.nil? ) attrs = %w[name state acknowledgement downtime_depth last_check] end if( joins.nil? ) joins = ['host.name', 'host.state', 'host.acknowledgement', 'host.downtime_depth', 'host.last_check'] end payload['attrs'] = attrs unless attrs.nil? payload['filter'] = filter unless filter.nil? payload['joins'] = joins unless joins.nil? data = api_data( url: format( '%s/objects/services', @icinga_api_url_base ), headers: @headers, options: @options, payload: payload ) @last_service_objects_called = Time.now.to_i if( !data.nil? && data.is_a?(Array) ) all_services = data.clone unless( all_services.nil? ) @services_all = all_services.size @services_problems = count_problems(all_services) @services_handled_warning = count_problems(all_services, Icinga2::SERVICE_STATE_WARNING) @services_handled_critical = count_problems(all_services, Icinga2::SERVICE_STATE_CRITICAL) @services_handled_unknown = count_problems(all_services, Icinga2::SERVICE_STATE_UNKNOWN) end end data end |
#service_problems ⇒ Hash
returns data with service problems
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 |
# File 'lib/icinga2/services.rb', line 543 def service_problems cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout) service_objects if((Time.now.to_i - @last_service_objects_called).to_i > @last_call_timeout) 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 services_handled_all = @services_handled.nil? ? 0 : @services_handled services_handled_warning = @services_handled_warning.nil? ? 0 : @services_handled_warning services_handled_critical = @services_handled_critical.nil? ? 0 : @services_handled_critical services_handled_unknown = @services_handled_unknown.nil? ? 0 : @services_handled_unknown # calculate service problems adjusted by handled problems services_adjusted_warning = services_warning - services_handled_warning services_adjusted_critical = services_critical - services_handled_critical services_adjusted_unknown = services_unknown - services_handled_unknown { 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, adjusted_warning: services_adjusted_warning.to_i, adjusted_critical: services_adjusted_critical.to_i, adjusted_unknown: services_adjusted_unknown.to_i, handled_all: services_handled_all.to_i, handled_warning: services_handled_warning.to_i, handled_critical: services_handled_critical.to_i, handled_unknown: services_handled_unknown.to_i } end |
#service_problems_handled ⇒ Hash
returns data with service problems they be handled (acknowledged or in downtime)
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'lib/icinga2/services.rb', line 598 def service_problems_handled puts 'function service_problems_handled is obsolete' puts 'Please use service_problems()' cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout) problems_all = @services_handled.nil? ? 0 : @services_handled problems_critical = @services_handled_critical.nil? ? 0 : @services_handled_critical problems_warning = @services_handled_warning.nil? ? 0 : @services_handled_warning problems_unknown = @services_handled_unknown.nil? ? 0 : @services_handled_unknown { all: problems_all.to_i, warning: problems_warning.to_i, critical: problems_critical.to_i, unknown: problems_unknown.to_i } # [problems_all,problems_critical,problems_warning,problems_unknown] end |
#services(params = {}) ⇒ Hash
return services
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/icinga2/services.rb', line 297 def services( params = {} ) raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) ) host_name = params.dig(:host_name) name = params.dig(:name) url = if( name.nil? ) format( '%s/objects/services/%s', @icinga_api_url_base, host_name ) else format( '%s/objects/services/%s!%s', @icinga_api_url_base, host_name, name ) end api_data( url: url, headers: @headers, options: @options ) end |
#services_adjusted ⇒ Hash
returns adjusted service state
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
# File 'lib/icinga2/services.rb', line 419 def services_adjusted puts 'function services_adjusted is obsolete' puts 'Please use service_problems()' cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout) service_objects if((Time.now.to_i - @last_service_objects_called).to_i > @last_call_timeout) service_warning = @services_warning.nil? ? 0 : @services_warning service_critical = @services_critical.nil? ? 0 : @services_critical service_unknown = @services_unknown.nil? ? 0 : @services_unknown service_handled_warning = @services_handled_warning.nil? ? 0 : @services_handled_warning service_handled_critical = @services_handled_critical.nil? ? 0 : @services_handled_critical service_handled_unknown = @services_handled_unknown.nil? ? 0 : @services_handled_unknown # calculate service problems adjusted by handled problems service_adjusted_warning = service_warning - service_handled_warning service_adjusted_critical = service_critical - service_handled_critical service_adjusted_unknown = service_unknown - service_handled_unknown { warning: service_adjusted_warning.to_i, critical: service_adjusted_critical.to_i, unknown: service_adjusted_unknown.to_i } end |
#services_all ⇒ Integer
returns a counter of all services
518 519 520 521 522 523 524 |
# File 'lib/icinga2/services.rb', line 518 def services_all cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout) service_objects if((Time.now.to_i - @last_service_objects_called).to_i > @last_call_timeout) @services_all end |
#unhandled_services ⇒ Hash
return all unhandled services
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/icinga2/services.rb', line 265 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? api_data( url: format( '%s/objects/services', @icinga_api_url_base ), headers: @headers, options: @options, payload: payload ) end |