Module: Icinga2::Services

Included in:
Client
Defined in:
lib/icinga2/services.rb

Overview

namespace for service handling

Instance Method Summary collapse

Instance Method Details

#add_service(params) ⇒ Hash

add service

Examples:

add_service(
  name: 'http2',
  host_name: 'icinga2',
  check_command: 'http',
  check_interval: 10,
  retry_interval: 30,
  vars: {
    http_address: '127.0.0.1',
    http_url: '/access/index',
    http_port: 80
  }
)

Parameters:

Options Hash (params):

  • name (String)
  • host_name (String)
  • display_name (String)
  • templates (Array)
  • groups (Array)
  • notes (String)
  • notes_url (String)
  • action_url (String)
  • check_command (String)
  • check_interval (Integer)
  • check_period (String)
  • check_timeout (Integer)
  • command_endpoint (String)
  • enable_active_checks (Bool)
  • enable_event_handler (Bool)
  • enable_flapping (Bool)
  • enable_notifications (Bool)
  • enable_passive_checks (Bool)
  • enable_perfdata (Bool)
  • event_command (String)
  • flapping_threshold_high (Integer)
  • flapping_threshold_low (Integer)
  • flapping_threshold (Integer)
  • icon_image_alt (String)
  • icon_image (String)
  • max_check_attempts (Integer)
  • retry_interval (Integer)
  • volatile (Bool)
  • vars (Hash)

Returns:

  • (Hash) —

    • status

    • message

Raises:

  • (ArgumentError) 


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
 
# File 'lib/icinga2/services.rb', line 59

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    = validate( params, required: true, var: 'name', type: String )
  host_name    = validate( params, required: true, var: 'host_name', type: String )
  display_name   = validate( params, required: false, var: 'display_name', type: String )
  groups   = validate( params, required: false, var: 'groups', type: Array )
  check_command = validate( params, required: false, var: 'check_command', type: String )
  max_check_attempts = validate( params, required: false, var: 'max_check_attempts', type: Integer ) || 3
  check_interval = validate( params, required: false, var: 'check_interval', type: Integer ) || 60
  check_period   = validate( params, required: false, var: 'check_period', type: Integer )
  check_timeout = validate( params, required: false, var: 'check_timeout', type: Integer )
  retry_interval   = validate( params, required: false, var: 'retry_interval', type: Integer ) || 45
  enable_active_checks = validate( params, required: false, var: 'enable_active_checks', type: Boolean )
  enable_event_handler = validate( params, required: false, var: 'enable_event_handler', type: Boolean )
  enable_flapping   = validate( params, required: false, var: 'enable_flapping', type: Boolean )
  enable_notifications = validate( params, required: false, var: 'enable_notifications', type: Boolean ) || false
  enable_passive_checks = validate( params, required: false, var: 'enable_passive_checks', type: Boolean )
  flapping_threshold = validate( params, required: false, var: 'flapping_threshold', type: Integer )
  enable_perfdata   = validate( params, required: false, var: 'enable_perfdata', type: Boolean )
  event_command = validate( params, required: false, var: 'event_command', type: String )
  volatile = validate( params, required: false, var: 'volatile', type: Boolean )
  zone   = validate( params, required: false, var: 'zone', type: String )
  command_endpoint = validate( params, required: false, var: 'command_endpoint', type: String )
  notes    = validate( params, required: false, var: 'notes', type: String )
  notes_url   = validate( params, required: false, var: 'notes_url', type: String )
  action_url = validate( params, required: false, var: 'action_url', type: String )
  icon_image    = validate( params, required: false, var: 'icon_image', type: String )
  icon_image_alt   = validate( params, required: false, var: 'icon_image_alt', type: String )
  templates   = validate( params, required: false, var: 'templates', type: Array ) || ['generic-service']
  vars   = validate( params, required: false, var: 'vars', type: Hash ) || {}

  # check if host exists
  return { 'code' => 404, 'name' => host_name, 'status' => 'Object not Found' } unless( exists_host?( host_name ) )

  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,
      vars: vars
    }
  }

  # 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

Examples:

count_services_with_problems

Returns:

  • (Integer) 


462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/icinga2/services.rb', line 462

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

Examples:

delete_service(host_name: 'foo', name: 'http2')
delete_service(host_name: 'foo', name: 'http2', cascade: true)

Parameters:

Options Hash (params):

  • name (String) —

    service name

  • host_name (String) —

    host name for the service

  • cascade (Bool) — default: false —

    delete service also when other objects depend on it

Returns:

Raises:

  • (ArgumentError) 


152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/icinga2/services.rb', line 152

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? )

  name      = validate( params, required: true, var: 'name', type: String )
  host_name = validate( params, required: true, var: 'host_name', type: String )
  cascade   = validate( params, required: false, var: 'cascade', type: Boolean ) || false

  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

Examples:

exists_service?(host_name: 'icinga2', name: 'users')

Parameters:

Options Hash (params):

Returns:

  • (Bool)

Raises:

  • (ArgumentError) 


346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/icinga2/services.rb', line 346

def exists_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? )

  host_name = validate( params, required: true, var: 'host_name', type: String )
  name      = validate( params, required: true, var: 'name', type: String )

  result = services( host_name: host_name, name: name )
  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

Examples:

problems, problems_and_severity = list_services_with_problems.values

l = list_services_with_problems
problems_and_severity = l.dig(:services_with_problems_and_severity)

Parameters:

  • max_items (Integer) (defaults to: 5) —

    numbers of list entries

Returns:

  • (Hash) —

    • Array (services_with_problems)

    • Hash (services_with_problems_and_severity)

Raises:

  • (ArgumentError) 


488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/icinga2/services.rb', line 488

def list_services_with_problems( max_items = 5 )

  raise ArgumentError.new(format('wrong type. \'max_items\' must be an Integer, given \'%s\'', max_items.class.to_s)) unless( max_items.is_a?(Integer) )

  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? )

      # TODO
      # change spec tests!
      services_with_problems[name] = state # 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

Examples:

modify_service(
  name: 'http2',
  check_interval: 60,
  retry_interval: 10,
  vars: {
    http_url: '/access/login'     ,
    http_address: '10.41.80.63'
  }
)

Parameters:

Options Hash (params):

Returns:

  • (Hash) —

    • status

    • message

Raises:

  • (ArgumentError) 


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/icinga2/services.rb', line 193

def modify_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    = validate( params, required: true, var: 'name', type: String )
  display_name   = validate( params, required: false, var: 'display_name', type: String )
  groups   = validate( params, required: false, var: 'groups', type: Array )
  check_command = validate( params, required: false, var: 'check_command', type: String )
  max_check_attempts = validate( params, required: false, var: 'max_check_attempts', type: Integer ) || 3
  check_interval = validate( params, required: false, var: 'check_interval', type: Integer ) || 60
  check_period   = validate( params, required: false, var: 'check_period', type: Integer )
  check_timeout = validate( params, required: false, var: 'check_timeout', type: Integer )
  retry_interval   = validate( params, required: false, var: 'retry_interval', type: Integer ) || 45
  enable_active_checks = validate( params, required: false, var: 'enable_active_checks', type: Boolean )
  enable_event_handler = validate( params, required: false, var: 'enable_event_handler', type: Boolean )
  enable_flapping   = validate( params, required: false, var: 'enable_flapping', type: Boolean )
  enable_notifications = validate( params, required: false, var: 'enable_notifications', type: Boolean ) || false
  enable_passive_checks = validate( params, required: false, var: 'enable_passive_checks', type: Boolean )
  flapping_threshold = validate( params, required: false, var: 'flapping_threshold', type: Integer )
  enable_perfdata   = validate( params, required: false, var: 'enable_perfdata', type: Boolean )
  event_command = validate( params, required: false, var: 'event_command', type: String )
  volatile = validate( params, required: false, var: 'volatile', type: Boolean )
  zone   = validate( params, required: false, var: 'zone', type: String )
  command_endpoint = validate( params, required: false, var: 'command_endpoint', type: String )
  notes    = validate( params, required: false, var: 'notes', type: String )
  notes_url   = validate( params, required: false, var: 'notes_url', type: String )
  action_url = validate( params, required: false, var: 'action_url', type: String )
  icon_image    = validate( params, required: false, var: 'icon_image', type: String )
  icon_image_alt   = validate( params, required: false, var: 'icon_image_alt', type: String )
  templates   = validate( params, required: false, var: 'templates', type: Array ) || ['generic-service']
  vars   = validate( params, required: false, var: 'vars', type: Hash ) || {}

  # check if service exists
#       return { 'code' => 404, 'name' => name, 'status' => 'Object not Found' } unless( exists_service?( host_name: host_name, service_name: name ) )
#       # check if host exists
#       return { 'code' => 404, 'name' => host_name, 'status' => 'Object not Found' } unless( exists_host?( host_name ) )

  payload = {
    templates: templates,
    filter: format( 'service.name == "%s"', name ),
    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,
      vars: vars
    }
  }

  # clear undefined settings
  payload.reject!{ |_k, v| v.nil? }
  payload[:attrs].reject!{ |_k, v| v.nil? }

  post(
    url: format( '%s/objects/services', @icinga_api_url_base ),
    headers: @headers,
    options: @options,
    payload: payload
  )
end

#service_objects(params = {}) ⇒ Array

returns service objects

Examples:

with default attrs and joins

service_objects
service_objects(attrs: ['name', 'state'], joins: ['host.name','host.state'])

Parameters:

  • params (Hash) (defaults to: {})

Options Hash (params):

  • attrs (Array) — default: ['name', 'state', 'acknowledgement', 'downtime_depth', 'last_check']
  • filter (String) — default: []
  • joins (Array) — default: ['host.name', 'host.state', 'host.acknowledgement', 'host.downtime_depth', 'host.last_check']

Returns:



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
405
406
407
408
409
410
411
412
413
 
# File 'lib/icinga2/services.rb', line 378

def service_objects( params = {} )

  attrs   = validate( params, required: false, var: 'attrs', type: Array ) || %w[name state acknowledgement downtime_depth  last_check]
  filter  = validate( params, required: false, var: 'filter', type: String )
  joins   = validate( params, required: false, var: 'joins', type: Array ) || ['host.name', 'host.state', 'host.acknowledgement', 'host.downtime_depth', 'host.last_check']

  payload = {
    attrs: attrs,
    filter: filter,
    joins: joins
  }

  payload.reject!{ |_k, v| v.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

Examples:

all, warning, critical, unknown, pending, in_downtime, acknowledged, adjusted_warning, adjusted_critical, adjusted_unknown = service_problems.values

p = service_problems
warning = p.dig(:warning)

Returns:

  • (Hash) —

    • ok

    • warning

    • critical

    • unknown

    • pending

    • in_downtime

    • acknowledged



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
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/icinga2/services.rb', line 555

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)

Examples:

service_objects
all, warning, critical, unknown = service_problems_handled.values

p = service_problems_handled
warning = p.dig(:warning)

Returns:

  • (Hash) —

    • all

    • critical

    • warning

    • unknown



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/icinga2/services.rb', line 610

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
  }
end

#services(params = {}) ⇒ Hash

return services

Examples:

to get all services

services

to get one service for host

services( host_name: 'icinga2', name: 'ping4' )

Parameters:

  • params (Hash) (defaults to: {})

Options Hash (params):

Returns:

Raises:

  • (ArgumentError) 


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/icinga2/services.rb', line 318

def services( params = {} )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )

  host_name = validate( params, required: false, var: 'host_name', type: String )
  name      = validate( params, required: false, var: 'name', type: String )

  url = format( '%s/objects/services/%s', @icinga_api_url_base, host_name )
  url = format( '%s/objects/services/%s!%s', @icinga_api_url_base, host_name, name ) unless( name.nil? )

  api_data(
    url: url,
    headers: @headers,
    options: @options
  )
end

#services_adjusted ⇒ Hash

returns adjusted service state

Examples:

warning, critical, unknown = services_adjusted.values

s = services_adjusted
unknown = s.dig(:unknown)

Returns:

  • (Hash) —

    • warning

    • critical

    • unknown



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/icinga2/services.rb', line 428

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

Examples:

services_all

Returns:

  • (Integer) 


530
531
532
533
534
535
536
 
# File 'lib/icinga2/services.rb', line 530

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

Examples:

unhandled_services

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/icinga2/services.rb', line 282

def unhandled_services

  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,
    filter: filter
  }

  # remove all empty attrs
  payload.reject!{ |_k, v| v.nil? }
  payload[:attrs].reject!{ |_k, v| v.nil? }

  api_data(
    url: format( '%s/objects/services', @icinga_api_url_base ),
    headers: @headers,
    options: @options,
    payload: payload
  )
end