Class: WavefrontCli::Metric

Inherits:
Base
  • Object
show all
Defined in:
lib/wavefront-cli/metric.rb

Overview

CLI coverage for the v2 ‘metric’ API. Also includes commands which call the currently unstable ‘chart’ API.

Constant Summary

Constants included from Constants

Constants::ALL_PAGE_SIZE, Constants::DEFAULT_CONFIG, Constants::DEFAULT_OPTS, Constants::EVENT_STATE_DIR, Constants::HUMAN_TIME_FORMAT, Constants::HUMAN_TIME_FORMAT_MS, Constants::SEARCH_SPLIT

Instance Attribute Summary

Attributes inherited from Base

#klass, #klass_word, #options, #wf

Instance Method Summary collapse

Methods inherited from Base

#_sdk_class, #cannot_noop!, #check_response_blocks, #check_status, #cli_output_class, #conds_to_query, #descriptive_name, #dispatch, #display, #display_api_error, #display_class, #display_no_api_response, #do_delete, #do_dump, #do_import, #do_list, #do_search, #do_set, #do_undelete, #dump_json, #dump_yaml, #extract_values, #failed_validation_message, #format_var, #handle_error, #handle_response, #hcl_fields, #import_to_create, #initialize, #item_dump_call, #load_display_class, #matching_method, #method_word_list, #mk_creds, #mk_opts, #name_of_do_method, #no_api_response, #ok_exit, #one_or_all, #options_and_exit, #parseable_output, #range_hash, #require_sdk_class, #run, #search_key, #smart_delete, #smart_delete_message, #status_error_handler, #unsupported_format_message, #validate_id, #validate_input, #validate_opts, #validate_tags, #validator_exception, #validator_method, #warning_message

Constructor Details

This class inherits a constructor from WavefrontCli::Base

Instance Method Details

#do_describe ⇒ Object

There’s an extra describe flag that other classes don’t have.



14
15
16
 
# File 'lib/wavefront-cli/metric.rb', line 14

def do_describe
  wf.detail(options[:'<metric>'], options[:glob] || [], options[:offset])
end

#do_list_all ⇒ Object 



22
23
24
 
# File 'lib/wavefront-cli/metric.rb', line 22

def do_list_all
  wf_chart_api_object.metrics_under('')
end

#do_list_under ⇒ Object 



18
19
20
 
# File 'lib/wavefront-cli/metric.rb', line 18

def do_list_under
  wf_chart_api_object.metrics_under(options[:'<metric>'])
end

#extra_validation ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/wavefront-cli/metric.rb', line 26

def extra_validation
  return unless options[:'<metric>']

  begin
    wf_metric_name?(options[:'<metric>'])
  rescue Wavefront::Exception::InvalidMetricName
    abort "'#{options[:'<metric>']}' is not a valid metric ID."
  end
end