morpheus-cli 3.1.2.1 → 3.2.0

data/lib/morpheus/cli/monitoring_checks_command.rb

@@ -5,14 +5,11 @@ class Morpheus::Cli::MonitoringChecksCommand
   include Morpheus::Cli::CliCommand
   include Morpheus::Cli::MonitoringHelper
 
-  set_command_name :checks # :'monitoring-checks'
-  register_subcommands :list, :get, :update, :remove, :quarantine, :history #, :statistics
-  set_default_subcommand :list
+  set_command_name :'monitor-checks'
+  register_subcommands :list, :get, :add, :update, :remove
+  register_subcommands :mute, :unmute, :history #, :statistics
+  register_subcommands :'list-types' => :list_types
   
-  def initialize()
-    # @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
-  end
-
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
     @monitoring_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).monitoring
@@ -25,15 +22,16 @@ class Morpheus::Cli::MonitoringChecksCommand
   def list(args)
     options = {}
     params = {}
-    optparse = OptionParser.new do|opts|
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage()
-      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
+      # todo: api to load type id by name
+      # opts.on('--type VALUE', Array, "Filter by status. error,healthy,warning,muted") do |val|
+      #   params['checkType'] = val
+      # end
+      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, :csv, :fields, :json, :dry_run])
+      build_common_options(opts, options, [:list, :last_updated, :json, :yaml, :csv, :fields, :json, :dry_run, :remote])
     end
     optparse.parse!(args)
     connect(options)
@@ -41,27 +39,26 @@ class Morpheus::Cli::MonitoringChecksCommand
       [:phrase, :offset, :max, :sort, :direction, :lastUpdated].each do |k|
         params[k] = options[k] unless options[k].nil?
       end
-      # JD: lastUpdated 500ing, checks don't have that property ? =o  Fix it!
-
       if options[:dry_run]
         print_dry_run @monitoring_interface.checks.dry.list(params)
         return
       end
-
       json_response = @monitoring_interface.checks.list(params)
+      if options[:include_fields]
+        json_response = {"checks" => filter_data(json_response["checks"], options[:include_fields]) }
+      end
       if options[:json]
-        if options[:include_fields]
-          json_response = {"checks" => filter_data(json_response["checks"], options[:include_fields]) }
-        end
         puts as_json(json_response, options)
         return 0
-      end
-      if options[:csv]
+      elsif options[:yaml]
+        puts as_yaml(json_response, options)
+        return 0
+      elsif options[:csv]
         puts records_as_csv(json_response['checks'], options)
         return 0
       end
       checks = json_response['checks']
-      title = "Morpheus Checks"
+      title = "Morpheus Monitoring Checks"
       subtitles = []
       # if group
       #   subtitles << "Group: #{group['name']}".strip
@@ -88,7 +85,7 @@ class Morpheus::Cli::MonitoringChecksCommand
   
   def get(args)
     options = {}
-    optparse = OptionParser.new do|opts|
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[id list]")
       opts.on(nil,'--history', "Display Check History") do |val|
         options[:show_history] = true
@@ -121,13 +118,15 @@ class Morpheus::Cli::MonitoringChecksCommand
       end
       json_response = @monitoring_interface.checks.get(check['id'])
       check = json_response['check']
-      
+      if options[:include_fields]
+        json_response = {'check' => filter_data(check, options[:include_fields]) }
+      end
       if options[:json]
-        if options[:include_fields]
-          json_response = {"check" => filter_data(json_response["check"], options[:include_fields]) }
-        end
         puts as_json(json_response, options)
         return 0
+      elsif options[:yaml]
+        puts as_yaml(json_response, options)
+        return 0
       elsif options[:csv]
         puts records_as_csv([json_response['check']], options)
         return 0
@@ -137,16 +136,37 @@ class Morpheus::Cli::MonitoringChecksCommand
       print cyan
       description_cols = {
         "ID" => lambda {|it| it['id'] },
-        "Status" => lambda {|it| format_monitoring_check_status(it) },
+        "Status" => lambda {|it| format_monitoring_check_status(it, true) },
         "Name" => lambda {|it| it['name'] },
-        "Time" => lambda {|it| format_local_dt(it['lastRunDate']) },
+        "Time" => lambda {|it| it['lastRunDate'] ? format_local_dt(it['lastRunDate']) : "N/A" },
         "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" => 'checkType.name'
+        "Last Metric" => lambda {|it| 
+          if it['lastMetric']
+            metric_name = it['checkType'] ? it['checkType']['metricName'] : nil
+            if metric_name
+              "#{it['lastMetric']} #{metric_name}"
+            else
+              "#{it['lastMetric']}"
+            end
+          else
+            "N/A" 
+          end
+        },
+        "Type" => lambda {|it| format_monitoring_check_type(it) },
+        "Created By" => lambda {|it| it['createdBy'] ? it['createdBy']['username'] : "System" },
+        "Date Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+        "Last Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
+        # "Last Error" => lambda {|it| format_local_dt(it['lastErrorDate']) },
       }
       print_description_list(description_cols, check)
 
+      # Last Error
+      # if check['lastCheckStatus'] == 'error' && check['lastError']
+      #   print_h2 "Last Error at #{format_local_dt(check['lastErrorDate'])}"
+      #   print red,"#{check['lastError']}",reset,"\n"
+      # end
+
       ## Chart Stats
 
 
@@ -156,24 +176,34 @@ class Morpheus::Cli::MonitoringChecksCommand
       
       check_groups = json_response["groups"]
       if check_groups && !check_groups.empty?
-        print_h2 "Check Groups"
-        print as_pretty_table(check_groups, [:id, {"Check Group" => :name}], options)
+        print_h2 "Groups"
+        #print as_pretty_table(check_groups, [:id, :name], options)
+        print_check_groups_table(check_groups, options)
       else
         # print "\n"
         # puts "This check is not in any check groups."
       end
 
+      apps = json_response["apps"]
+      if apps && apps.empty?
+        print_h2 "Apps"
+        print as_pretty_table(apps, [:id, :name], options)
+      else
+        # print "\n"
+        # puts "This check is not in any monitoring apps."
+      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 print JSON.pretty_generate(open_incidents)
+        puts JSON.pretty_generate(open_incidents)
         # todo: move this to MonitoringHelper ?
         # print_incidents_table(issues, options)
       else
-        print "\n"
+        print "\n", cyan
         puts "No open incidents for this check"
       end
 
@@ -210,15 +240,15 @@ class Morpheus::Cli::MonitoringChecksCommand
   def history(args)
     options = {}
     params = {}
-    optparse = OptionParser.new do|opts|
-      opts.banner = subcommand_usage("[id] [options]")
+    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, :csv, :fields, :json, :dry_run])
+      build_common_options(opts, options, [:list, :last_updated, :json, :csv, :fields, :json, :dry_run, :remote])
     end
     optparse.parse!(args)
     if args.count < 1
@@ -253,7 +283,7 @@ class Morpheus::Cli::MonitoringChecksCommand
         return 0
       end
       history_items = json_response['history']
-      title = "Check History: #{check['id']}: #{check['displayName'] || check['name']}"
+      title = "Check History: #{check['name']}"
       subtitles = []
       if params[:phrase]
         subtitles << "Search: #{params[:phrase]}".strip
@@ -272,47 +302,142 @@ class Morpheus::Cli::MonitoringChecksCommand
     end
   end
 
+  def add(args)
+    options = {}
+    params = {'inUptime' => true, 'severity' => 'critical'}
+    check_type = nil
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[name] -t CODE")
+      opts.on('-t', '--type CODE', "Check Type Code or ID") do |val|
+        if val.to_s =~ /\A\d{1,}\Z/
+          params['checkType'] = {'id' => val.to_i}
+        else
+          params['checkType'] = {'code' => val}
+        end
+      end
+      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('--checkInterval MILLIS', String, "Check Interval. Value is in milliseconds. Default varies by type.") do |val|
+        params['checkInterval'] = val.to_i # * 1000
+      end
+      opts.on('--severity VALUE', String, "Max Severity. Determines the maximum severity level this check 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('-c', '--config JSON', "Config settings as JSON") do |val|
+        begin
+          params['config'] = JSON.parse(val.to_s)
+        rescue => ex
+          raise ::OptionParser::InvalidOption.new("Failed to parse --config as JSON. Error: #{ex.message}")
+        end
+      end
+      build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
+      opts.footer = "List monitoring checks."
+    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
+    if args[0]
+      params['name'] = args[0]
+    end
+    connect(options)
+    begin
+      # construct payload
+      payload = nil
+      if options[:payload]
+        payload = options[:payload]
+      else
+        params.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]
+        # todo: load option types based on type and prompt
+        payload = {'check' => params}
+      end
+      if options[:dry_run]
+        print_dry_run @monitoring_interface.checks.dry.create(payload)
+        return
+      end
+      json_response = @monitoring_interface.checks.create(payload)
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        check = json_response['check']
+        print_green_success "Added check #{check['name']}"
+        _get(check['id'], {})
+      end
+      return 0
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
   def update(args)
     options = {}
     params = {}
-    optparse = OptionParser.new do|opts|
-      opts.banner = subcommand_usage("[id]")
-      build_common_options(opts, options, [:json, :dry_run, :quiet])
+    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('--checkInterval VALUE', String, "Check Interval. Value is in milliseconds.") do |val|
+        params['checkInterval'] = val.to_i # * 1000
+      end
+      opts.on('--severity VALUE', String, "Max Severity. Determines the maximum severity level this check 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
+      build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
+      opts.footer = "Update a monitoring check." + "\n" +
+                    "[name] is required. This is the name or id of a check." + "\n" +
+                    "The available options vary by type."
     end
     optparse.parse!(args)
-    if args.count < 1
-      puts optparse
-      exit 1
+    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 = find_check_by_name_or_id(args[0])
-
-      if params.empty?
-        print_red_alert "Specify atleast one option to update"
-        puts optparse
-        exit 1
+      # 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 = {'check' => params}
       end
-
-      payload = {
-        'check' => {id: check["id"]}
-      }
-      payload['check'].merge!(params)
-
       if options[:dry_run]
         print_dry_run @monitoring_interface.checks.dry.update(check["id"], payload)
         return
       end
-
       json_response = @monitoring_interface.checks.update(check["id"], payload)
       if options[:json]
         puts as_json(json_response, options)
       elsif !options[:quiet]
-        print_green_success "Updated check #{check['id']}"
+        print_green_success "Updated check #{check['name']}"
         _get(check['id'], {})
       end
-
+      return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
       exit 1
@@ -320,55 +445,92 @@ class Morpheus::Cli::MonitoringChecksCommand
   end
 
 
-  def quarantine(args)
+  def mute(args)
     options = {}
     params = {'enabled' => true}
-    optparse = OptionParser.new do|opts|
-      opts.banner = subcommand_usage("[id list]")
-      # this one is a bit weird.. it's a way to toggle incident.inUptime
-      # opts.on("--enabled BOOL", String, "Quarantine can be removed with --enabled false") do |val|
-      #   params['enabled'] = ['on','true'].include?(val.to_s.downcase)
-      # end
-      opts.on("-d", "--disabled", "Disable Quarantine instead") do
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[name]")
+      opts.on(nil, "--disable", "Disable mute state instead, the same as unmute") do
         params['enabled'] = false
       end
-      build_common_options(opts, options, [:json, :dry_run, :quiet])
+      build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
+      opts.footer = "Mute a check. This prevents it from creating new incidents." + "\n" +
+                    "[name] is required. This is the name or id of a check."
     end
     optparse.parse!(args)
-    if args.count < 1
+    if args.count != 1
       puts optparse
-      exit 1
+      return 1
     end
     connect(options)
-
     begin
       check = find_check_by_name_or_id(args[0])
-
-      if params.empty?
-        print_red_alert "Specify atleast one option to update"
-        puts optparse
-        exit 1
+      # construct payload
+      payload = nil
+      if options[:payload]
+        payload = options[:payload]
+      else
+        payload = params
+      end
+      if options[:dry_run]
+        print_dry_run @monitoring_interface.checks.dry.quarantine(check["id"], payload)
+        return 0
       end
+      json_response = @monitoring_interface.checks.quarantine(check["id"], payload)
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if params['enabled']
+          print_green_success "Muted check #{check['name']}"
+        else
+          print_green_success "Unmuted check #{check['name']}"
+        end
+        _get(check['id'], {})
+      end
+      return 0
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
 
-      # payload = {
-      #   'check' => {id: check["id"]}
-      # }
-      # payload['check'].merge!(check)
-      payload = params
+  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, :quiet, :remote])
+      opts.footer = "Unmute a check." + "\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 = find_check_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.checks.dry.update(check["id"], payload)
-        return
+        print_dry_run @monitoring_interface.checks.dry.quarantine(check["id"], payload)
+        return 0
       end
-
-      json_response = @monitoring_interface.checks.update(check["id"], payload)
+      json_response = @monitoring_interface.checks.quarantine(check["id"], payload)
       if options[:json]
         puts as_json(json_response, options)
       elsif !options[:quiet]
-        print_green_success "Quarantined check #{check['id']}"
+        print_green_success "Unmuted check #{check['name']}"
         _get(check['id'], {})
       end
-
+      return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
       exit 1
@@ -377,12 +539,12 @@ class Morpheus::Cli::MonitoringChecksCommand
 
   def remove(args)
     options = {}
-    optparse = OptionParser.new do|opts|
-      opts.banner = subcommand_usage("[id]")
-      build_common_options(opts, options, [:json, :dry_run, :quiet])
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[name]")
+      build_common_options(opts, options, [:json, :dry_run, :quiet, :remote])
     end
     optparse.parse!(args)
-    if args.count < 1
+    if args.count != 1
       puts optparse
       return 127
     end
@@ -419,6 +581,77 @@ class Morpheus::Cli::MonitoringChecksCommand
     end
   end
 
+  def list_types(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage()
+      build_common_options(opts, options, [:list, :json, :yaml, :csv, :fields, :dry_run, :remote])
+      opts.footer = "List monitoring check types."
+    end
+    optparse.parse!(args)
+    connect(options)
+    begin
+      [:phrase, :offset, :max, :sort, :direction].each do |k|
+        params[k] = options[k] unless options[k].nil?
+      end
+      if options[:dry_run]
+        print_dry_run @monitoring_interface.checks.dry.list_check_types(params)
+        return
+      end
+
+      json_response = @monitoring_interface.checks.list_check_types(params)
+      if options[:include_fields]
+        json_response = {"checkTypes" => filter_data(json_response["checkTypes"], options[:include_fields]) }
+      end
+      if options[:json]
+        puts as_json(json_response, options)
+        return 0
+      elsif options[:csv]
+        puts records_as_csv(json_response['monitorApps'], options)
+        return 0
+      elsif options[:yaml]
+        puts as_yaml(json_response, options)
+        return 0
+      end
+      if options[:json]
+        if options[:include_fields]
+          json_response = {"checkTypes" => filter_data(json_response["checkTypes"], options[:include_fields]) }
+        end
+        puts as_json(json_response, options)
+        return 0
+      end
+      if options[:csv]
+        puts records_as_csv(json_response['checkTypes'], options)
+        return 0
+      end
+      check_types = json_response['checkTypes']
+      title = "Check Types"
+      subtitles = []
+      if params[:phrase]
+        subtitles << "Search: #{params[:phrase]}".strip
+      end
+      print_h1 title, subtitles
+      if check_types.empty?
+        print cyan,"No check types found.",reset,"\n"
+      else
+        # columns = [:code, :name]
+        columns = [
+          # {"ID" => lambda {|check_type| check_type['id'] } },
+          {"NAME" => lambda {|check_type| check_type['name'] } },
+          {"CODE" => lambda {|check_type| check_type['code'] } },
+          {"METRIC" => lambda {|check_type| check_type['metricName'] } },
+          {"DEFAULT INTERVAL" => lambda {|check_type| check_type['defaultInterval'] ? format_human_duration(check_type['defaultInterval'].to_i / 1000) : '' } }
+        ]
+        print as_pretty_table(check_types, columns, options)
+        print_results_pagination(json_response, {:label => "type", :n_label => "types"})
+      end
+      print reset,"\n"
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
 
   private