Class: Morpheus::Cli::MonitoringGroupsCommand

Inherits:
Object
  • Object
show all
Includes:
CliCommand, MonitoringHelper
Defined in:
lib/morpheus/cli/monitoring_groups_command.rb

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from MonitoringHelper

#check_type_for_id, #check_type_for_name, #check_type_for_name_or_id, #find_check_by_id, #find_check_by_name, #find_check_by_name_or_id, #find_check_group_by_id, #find_check_group_by_name, #find_check_group_by_name_or_id, #find_contact_by_id, #find_contact_by_name, #find_contact_by_name_or_id, #find_incident_by_id, #find_monitoring_app_by_id, #find_monitoring_app_by_name, #find_monitoring_app_by_name_or_id, #format_monitoring_check_last_metric, #format_monitoring_check_status, #format_monitoring_check_type, #format_monitoring_incident_status, #format_monitoring_issue_attachment_type, #format_monitoring_issue_status, #format_severity, #get_available_check_types, included, #monitoring_interface, #print_check_groups_table, #print_check_history_table, #print_check_notifications_table, #print_checks_table, #print_incident_history_table, #print_incident_notifications_table, #print_incidents_table, #print_monitoring_apps_table

Methods included from CliCommand

#build_common_options, #build_option_type_options, #command_name, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_id_list, #parse_list_options, #parse_list_subtitles, #print, #print_error, #puts, #puts_error, #raise_command_error, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!

Instance Method Details

#_get(id, options) ⇒ Object 



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
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
186
187
188
189
190
191
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 97

def _get(id, options)

  begin
    check_group = find_check_group_by_name_or_id(id)

    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.get(check_group['id'])
      return
    end
    json_response = @monitoring_interface.groups.get(check_group['id'])
    check_group = json_response['checkGroup']
    if options[:json]
      puts as_json(json_response, options, "checkGroup")
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "checkGroup")
      return 0
    elsif options[:csv]
      puts records_as_csv([json_response['checkGroup']], options)
      return 0
    end

    print_h1 "Check Group Details"
    print cyan
    description_cols = {
      "ID" => lambda {|it| it['id'] },
      "Status" => lambda {|it| format_monitoring_check_status(it, true) },
      "Name" => lambda {|it| it['name'] },
      "Time" => lambda {|it| format_local_dt(it['lastRunDate']) },
      "Availability" => lambda {|it| it['availability'] ? "#{it['availability'].to_f.round(3).to_s}%" : "N/A"},
      "Response Time" => lambda {|it| it['lastTimer'] ? "#{it['lastTimer']}ms" : "N/A" },
      # "Last Metric" => lambda {|it| it['lastMetric'] ? "#{it['lastMetric']}" : "N/A" },
      "Type" => lambda {|it| format_monitoring_check_type(it) },
    }
    print_description_list(description_cols, check_group)

    ## Chart Stats


    ## Activity

    ## Checks in this check group
    checks = json_response["checks"]
    if checks && !checks.empty?
      print_h2 "Checks"
      # print as_pretty_table(check_groups, [:id, {"Check Group" => :name}], options)
      print_checks_table(checks, options)
    else
      # print "\n"
      # puts "No checks found..."
    end

    ## Open Incidents

    open_incidents = json_response["openIncidents"]
    if open_incidents && !open_incidents.empty?
      print_h2 "Open Incidents"
      # puts "\n(table coming soon...)\n"
      puts JSON.pretty_generate(open_incidents)
      # todo: move this to MonitoringHelper ?
      # print_incidents_table(issues, options)
    else
      print "\n", cyan
      puts "No open incidents for this check group"
    end

    ## History (plain old Hash)
    if options[:show_history]
      # history_items = json_response["history"]
      # gotta go get it
      history_json_response = @monitoring_interface.groups.history(check_group["id"], {})
      history_items = history_json_response["history"] || history_json_response["events"]  || history_json_response["issues"]
      issues = history_items
      if history_items && !history_items.empty?
        print_h2 "History"
        print_check_history_table(history_items, options)
        print_results_pagination(history_json_response, {:label => "event", :n_label => "events"})
      else
        print "\n"
        puts "No history found for this check group"
      end
    end

    ## Statistics (Hash)
    if options[:show_statistics]
      # todo....
    end

    print reset,"\n"

  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#add(args) ⇒ Object 



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 253

def add(args)
  options = {}
  params = {'inUptime' => true, 'severity' => 'critical'}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    opts.on('--name VALUE', String, "Name") do |val|
      params['name'] = val
    end
    opts.on('--description VALUE', String, "Description") do |val|
      params['description'] = val
    end
    opts.on('--minHappy VALUE', String, "Min Checks. This specifies the minimum number of checks within the group that must be happy to keep the group from becoming unhealthy.") do |val|
      params['minHappy'] = val.to_i
    end
    opts.on('--severity VALUE', String, "Max Severity. Determines the maximum severity level this group can incur on an incident when failing. Default is critical") do |val|
      params['severity'] = val
    end
    opts.on('--inUptime [on|off]', String, "Affects Availability. Default is on.") do |val|
      params['inUptime'] = val.nil? || val.to_s == 'on' || val.to_s == 'true'
    end
    opts.on('--checks LIST', Array, "Checks to include in this group, comma separated list of IDs") do |list|
      if list.size == 1 && list[0] == 'null' # hacky way to clear it
        params['checks'] = []
      else
        params['checks'] = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote, :quiet])
    opts.footer = "Create a new group of monitoring checks." + "\n" +
                  "[name] is required and can be passed as --name instead."
  end
  optparse.parse!(args)
  if args.count > 1
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "wrong number of arguments, expected 0-1 and got #{args.count}\n#{optparse}"
    return 1
  end
  # support [name] as first argument
  if args[0]
    params['name'] = args[0]
  end
  connect(options)
  begin
    # construct payload
    payload = nil
    if options[:payload]
      payload = options[:payload]
    else
      # merge -O options into normally parsed options
      params.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]
      if params['checks']
        params['checks'] = params['checks'].collect {|it| it.to_i }
      end
      # todo: prompt?
      payload = {'checkGroup' => params}
    end
    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.create(payload)
      return
    end
    json_response = @monitoring_interface.groups.create(payload)
    if options[:json]
      puts as_json(json_response, options)
    elsif !options[:quiet]
      check_group = json_response['checkGroup']
      print_green_success "Added check group #{check_group['name']}"
      _get(check_group['id'], {})
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#connect(opts) ⇒ Object 



12
13
14
15
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 12

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @monitoring_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).monitoring
end

#get(args) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 73

def get(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[id list]")
    opts.on(nil,'--history', "Display Check Group History") do |val|
      options[:show_history] = true
    end
    # opts.on(nil,'--statistics', "Display Statistics") do |val|
    #   options[:show_statistics] = true
    # end
    build_common_options(opts, options, [:json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)
  id_list = parse_id_list(args)
  return run_command_for_each_arg(id_list) do |arg|
    _get(arg, options)
  end
end

#handle(args) ⇒ Object 



17
18
19
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 17

def handle(args)
  handle_subcommand(args)
end

#history(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 193

def history(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    # opts.on('--status LIST', Array, "Filter by status. open, closed") do |list|
    #   params['status'] = list
    # end
    opts.on('--severity LIST', Array, "Filter by severity. critical, warning, info") do |list|
      params['severity'] = list
    end
    build_common_options(opts, options, [:list, :last_updated, :json, :yaml, :csv, :fields, :json, :dry_run, :remote])
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)
  begin
    check_group = find_check_group_by_name_or_id(args[0])
    return 1 if check_group.nil?
    
    # construct payload
    params.merge!(parse_list_options(options))

    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.history(check_group['id'], params)
      return
    end

    json_response = @monitoring_interface.groups.history(check_group['id'], params)
    if options[:json]
      puts as_json(json_response, options, "history")
      return 0
    elsif options[:csv]
      puts records_as_csv(json_response["history"], options)
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "history")
      return 0
    end
    history_items = json_response["history"]
    title = "Check Group History - [#{check_group['id']}] #{check_group['displayName'] || check_group['name']}"
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 title, subtitles
    if history_items.empty?
      print cyan,"No history found.",reset,"\n"
    else
      print_check_history_table(history_items, options)
      print_results_pagination(json_response, {:label => "event", :n_label => "events"})
    end
    print reset,"\n"
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#list(args) ⇒ Object 



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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 21

def list(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage()
    opts.on('--status VALUE', Array, "Filter by status. error,healthy,warning,muted") do |val|
      params['status'] = val
    end
    build_common_options(opts, options, [:list, :last_updated, :json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)
  connect(options)
  begin
    # construct payload
    params.merge!(parse_list_options(options))

    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.list(params)
      return
    end

    json_response = @monitoring_interface.groups.list(params)

    if options[:json]
      puts as_json(json_response, options, "checkGroups")
      return 0
    elsif options[:csv]
      puts records_as_csv(json_response['checkGroups'], options)
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "checkGroups")
      return 0
    end
    check_groups = json_response['checkGroups']
    title = "Morpheus Monitoring Check Groups"
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 title, subtitles
    if check_groups.empty?
      print cyan,"No check groups found.",reset,"\n"
    else
      print_check_groups_table(check_groups, options)
      print_results_pagination(json_response, {:label => "check group", :n_label => "check groups"})
      # print_results_pagination(json_response)
    end
    print reset,"\n"
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#mute(args) ⇒ Object 



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
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
445
446
447
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 400

def mute(args)
  options = {}
  params = {'enabled' => true}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    opts.on(nil, "--disable", "Disable mute, the same as unmute") do
      params['enabled'] = false
    end
    build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote, :quiet])
    opts.footer = "Mute a check group. This prevents it from creating new incidents." + "\n" +
                  "[name] is required. This is the name or id of a check group."
  end
  optparse.parse!(args)
  if args.count != 1
    puts optparse
    return 1
  end
  connect(options)
  begin
    check_group = find_check_group_by_name_or_id(args[0])
    # construct payload
    payload = nil
    if options[:payload]
      payload = options[:payload]
    else
      payload = params
    end
    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.quarantine(check_group["id"], payload)
      return 0
    end
    json_response = @monitoring_interface.groups.quarantine(check_group["id"], payload)
    if options[:json]
      puts as_json(json_response, options)
    elsif !options[:quiet]
      if params['enabled']
        print_green_success "Muted group #{check_group['name']}"
      else
        print_green_success "Unmuted group #{check_group['name']}"
      end
      _get(monitor_app['id'], {})
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#remove(args) ⇒ Object 



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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 492

def remove(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:json, :dry_run, :quiet])
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    return 127
  end
  connect(options)

  begin
    check_group = find_check_group_by_name_or_id(args[0])

    unless options[:yes] || ::Morpheus::Cli::OptionTypes::confirm("Are you sure you would like to delete check group '#{check_group['name']}'?", options)
      return false
    end

    # payload = {
    #   'checkGroup' => {id: check_group["id"]}
    # }
    # payload['checkGroup'].merge!(check_group)
    payload = params

    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.destroy(check_group["id"])
      return
    end

    json_response = @monitoring_interface.groups.destroy(check_group["id"])
    if options[:json]
      puts as_json(json_response, options)
    elsif !options[:quiet]
      print_green_success "Deleted check group #{check_group['name']}"
    end
    return 0, nil
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    return 1
  end
end

#unmute(args) ⇒ Object 



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 449

def unmute(args)
  options = {}
  params = {'enabled' => false}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:payload, :json, :dry_run, :remote, :quiet])
    opts.footer = "Unmute a check group." + "\n" +
                  "[name] is required. This is the name or id of a check."
  end
  optparse.parse!(args)
  if args.count != 1
    puts optparse
    return 1
  end
  connect(options)

  begin
    check_group = find_check_group_by_name_or_id(args[0])
    # construct payload
    payload = nil
    if options[:payload]
      payload = options[:payload]
    else
      payload = params
    end
    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.quarantine(check_group["id"], payload)
      return 0
    end
    json_response = @monitoring_interface.groups.quarantine(check_group["id"], payload)
    if options[:json]
      puts as_json(json_response, options)
    elsif !options[:quiet]
      print_green_success "Unmuted group #{check_group['name']}"
      _get(check_group['id'], {})
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#update(args) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
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
 
# File 'lib/morpheus/cli/monitoring_groups_command.rb', line 329

def update(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    opts.on('--name VALUE', String, "Name for this check group") do |val|
      params['name'] = val
    end
    opts.on('--description VALUE', String, "Description") do |val|
      params['description'] = val
    end
    opts.on('--minHappy VALUE', String, "Min Checks. This specifies the minimum number of checks within the group that must be happy to keep the group from becoming unhealthy.") do |val|
      params['minHappy'] = val.to_i
    end
    opts.on('--severity VALUE', String, "Max Severity. Determines the maximum severity level this group can incur on an incident when failing. Default is critical") do |val|
      params['severity'] = val
    end
    opts.on('--inUptime [on|off]', String, "Affects Availability. Default is on.") do |val|
      params['inUptime'] = val.nil? || val.to_s == 'on' || val.to_s == 'true'
    end
    opts.on('--checks LIST', Array, "Checks to include in this group, comma separated list of IDs") do |list|
      if list.size == 1 && list[0] == 'null' # hacky way to clear it
        params['checks'] = []
      else
        params['checks'] = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote, :quiet])
    opts.footer = "Update a check group." + "\n" +
                  "[name] is required. This is the name or id of a check group."
  end
  optparse.parse!(args)
  if args.count != 1
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "wrong number of arguments, expected 1 and got #{args.count}\n#{optparse}"
    return 1
  end
  connect(options)
  begin
    check_group = find_check_group_by_name_or_id(args[0])
    # construct payload
    payload = nil
    if options[:payload]
      payload = options[:payload]
    else
      # merge -O options into normally parsed options
      params.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]
      if params['checks']
        params['checks'] = params['checks'].collect {|it| it.to_i }
      end
      # todo: prompt?
      payload = {'checkGroup' => params}
    end
    if options[:dry_run]
      print_dry_run @monitoring_interface.groups.dry.update(check_group["id"], payload)
      return
    end
    json_response = @monitoring_interface.groups.update(check_group["id"], payload)
    if options[:json]
      puts as_json(json_response, options)
    elsif !options[:quiet]
      print_green_success "Updated check group #{check_group['name']}"
      _get(check_group['id'], {})
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end