Module: Icinga2::Services

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

Instance Method Summary collapse

Instance Method Details

#addServices(host, services = {}) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/icinga2/services.rb', line 6

def addServices( host, services = {} )

  def updateHost( hash, host )

    hash.each do |k, v|

      if( k == "host" && v.is_a?( String ) )
        v.replace( host )

      elsif( v.is_a?( Hash ) )
        self.updateHost( v, host )

      elsif( v.is_a?(Array) )

        v.flatten.each { |x| self.updateHost( x, host ) if x.is_a?( Hash ) }
      end
    end

    hash
  end

  services.each do |s,v|

    payload = {
      "templates" => [ "generic-service" ],
      "attrs"     => updateHost( v, host )
    }

    logger.debug( s )
    logger.debug( v.to_json )

    logger.debug( JSON.pretty_generate( payload ) )

    result = Network.put( {
      :host    => host,
      :url     => sprintf( '%s/v1/objects/services/%s!%s', @icingaApiUrlBase, host, s ),
      :headers => @headers,
      :options => @options,
      :payload => payload
    })

    logger.debug( result )

  end

end

#existsService?(params = {}) ⇒ Boolean

Returns:

  • (Boolean) 


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

def existsService?( params = {} )

  host    = params.dig(:host)
  service = params.dig(:service)

  if( host == nil )

    return {
      :status  => 404,
      :message => 'missing host name'
    }
  end

  result = self.listServices( { :host => host, :service => service } )

  if( result.is_a?( String ) )
    result = JSON.parse( result )
  end

  status = result.dig('status')

  if( status != nil && status == 200 )
    return true
  end

  return false

end

#listServices(params = {}) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/icinga2/services.rb', line 63

def listServices( params = {} )

  name    = params.dig(:host)
  service = params.dig(:service)

  if( service == nil )
    url = sprintf( '%s/v1/objects/services/%s', @icingaApiUrlBase, name )
  else
    url = sprintf( '%s/v1/objects/services/%s!%s', @icingaApiUrlBase, name, service )
  end

  result = Network.get( {
    :host     => name,
    :url      => url,
    :headers  => @headers,
    :options  => @options
  } )

  return JSON.pretty_generate( result )

end

#problemServices(max_items = 5) ⇒ Object 



188
189
190
191
192
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
 
# File 'lib/icinga2/services.rb', line 188

def problemServices( max_items = 5 )

  count = 0
  @serviceProblems = {}
  @serviceProblemsSeverity = {}

  # only fetch the minimal attribute set required for severity calculation
  servicesData = self.serviceObjects()

  if( servicesData.is_a?(String) )

    servicesData = JSON.parse( servicesData )
  end

  servicesData = servicesData.dig('nodes')

  servicesData.each do |service,v|

    name  = v.dig('name')
    state = v.dig('attrs','state')
#         logger.debug( "Severity for #{name}" )
    if( state == 0 )
      next
    end

    @serviceProblems[name] = self.serviceSeverity(v)
  end

  @serviceProblems.sort_by {|v| v}.reverse!

  @serviceProblems.keys[1..max_items].each { |k,v| @serviceProblemsSeverity[k] = @serviceProblems[k] }

#       @serviceProblems.each do |k,v|
#
#         if( count >= max_items )
#           break
#         end
#
#         @serviceProblemsSeverity[k] = v
#
#         count += 1
#       end

  return @serviceProblemsSeverity
end

#serviceObjects(params = {}) ⇒ Object 



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

def serviceObjects( params = {} )

  attrs   = params.dig(:attrs)
  filter  = params.dig(:filter)
  joins   = params.dig(:joins)
  payload = {}

  if( attrs == nil )
    attrs = ['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

  if( attrs != nil )
    payload['attrs'] = attrs
  end

  if( filter != nil )
    payload['filter'] = filter
  end

  if( joins != nil )
    payload['joins'] = joins
  end

  result = Network.get( {
    :host     => nil,
    :url      => sprintf( '%s/v1/objects/services', @icingaApiUrlBase ),
    :headers  => @headers,
    :options  => @options,
    :payload  => payload
  } )

  return JSON.pretty_generate( result )

end

#serviceProblems ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/icinga2/services.rb', line 156

def serviceProblems()

  data     = self.serviceObjects()
  problems = 0

  if( data.is_a?(String) )
    data = JSON.parse(data)
  end

  nodes = data.dig('nodes')

  nodes.each do |n|

    attrs           = n.last.dig('attrs')

    state           = attrs.dig('state')
    downtimeDepth   = attrs.dig('downtime_depth')
    acknowledgement = attrs.dig('acknowledgement')

#         puts state

    if( state != 0 && downtimeDepth == 0 && acknowledgement == 0 )
      problems += 1 #= problems +1
    end

  end

  return problems

end

#serviceSeverity(service) ⇒ Object

private stolen from Icinga Web 2 ./modules/monitoring/library/Monitoring/Backend/Ido/Query/ServicestatusQuery.php



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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/icinga2/services.rb', line 239

def serviceSeverity( service )

  attrs = service.dig('attrs')
  state           = attrs.dig('state')
  acknowledgement = attrs.dig('acknowledgement')
  downtimeDepth   = attrs.dig('downtime_depth')

#       logger.debug( attrs )

  severity = 0

  if( state == 0 )

    if( self.getObjectHasBeenChecked( service ) )
      severity += 16
    end

    if( acknowledgement != 0 )
      severity += 2
    elsif( downtimeDepth > 0 )
      severity += 1
    else
      severity += 4
    end
  else
    if( self.getObjectHasBeenChecked( service ) )
      severity += 16
    elsif( state == 1 )
      severity += 32
    elsif( state == 2 )
      severity += 128
    elsif( state == 3 )
      severity += 64
    else
      severity += 256
    end

    # requires joins
    host_attrs = service.dig('joins','host')

    host_state = host_attrs.dig('state')
    host_acknowledgement = host_attrs.dig('acknowledgement')
    host_downtimeDepth   = host_attrs.dig('downtime_depth')

    if( host_state > 0 )
      severity += 1024
    elsif( host_acknowledgement )
      severity += 512
    elsif( host_downtimeDepth > 0 )
      severity += 256
    else
      severity += 2048
    end
  end

  return severity
end

#unhandledServices(params = {}) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/icinga2/services.rb', line 54

def unhandledServices( params = {} )

  # 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/v1/objects/services' -d '{ "attrs": [ "__name", "state", "downtime_depth", "acknowledgement" ], "filter": "service.state != ServiceOK && service.downtime_depth == 0.0 && service.acknowledgement == 0.0" }''' | jq

end

#updateHost(hash, host) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/icinga2/services.rb', line 8

def updateHost( hash, host )

  hash.each do |k, v|

    if( k == "host" && v.is_a?( String ) )
      v.replace( host )

    elsif( v.is_a?( Hash ) )
      self.updateHost( v, host )

    elsif( v.is_a?(Array) )

      v.flatten.each { |x| self.updateHost( x, host ) if x.is_a?( Hash ) }
    end
  end

  hash
end