Class: Wavefront::DerivedMetric
- Defined in:
- lib/wavefront-sdk/derivedmetric.rb
Overview
View and manage derived metrics
Instance Attribute Summary
Attributes inherited from CoreApi
Instance Method Summary collapse
-
#create(body) ⇒ Wavefront::Response
POST /api/v2/derivedmetric Create a specific derived metric definition.
-
#delete(id) ⇒ Wavefront::Response
DELETE /api/v2/derivedmetric/id Delete a specific derived metric definition.
-
#describe(id, version = nil) ⇒ Wavefront::Response
GET /api/v2/derivedmetric/id Get a specific derived metric definition / Get a specific historical version of a specific derived metric definition.
-
#history(id) ⇒ Wavefront::Response
GET /api/v2/derivedmetric/id/history Get the version history of a derived metric definition.
-
#list(offset = 0, limit = 100) ⇒ Wavefront::Response
GET /api/v2/derivedmetric Get all derived metric definitions for a customer.
-
#tag_add(id, tag) ⇒ Wavefront::Response
PUT /api/v2/derivedmetric/id/tag/tagValue Add a tag to a specific derived metric definition.
-
#tag_delete(id, tag) ⇒ Wavefront::Response
DELETE /api/v2/derivedmetric/id/tag/tagValue Remove a tag from a specific derived metric definition.
-
#tag_set(id, tags) ⇒ Wavefront::Response
POST /api/v2/derivedmetric/id/tag Set all tags associated with a specific derived metric definition.
-
#tags(id) ⇒ Wavefront::Response
GET /api/v2/derivedmetric/id/tag Get all tags associated with a specific derived metric definition.
-
#undelete(id) ⇒ Wavefront::Response
POST /api/v2/derivedmetric/id/undelete Move a derived metric definition from ‘trash’ back into active service.
-
#update(id, body, modify = true) ⇒ Wavefront::Response
PUT /api/v2/derivedmetric/id Update a specific derived metric definition.
- #update_keys ⇒ Object
Methods inherited from CoreApi
#api_base, #api_path, #hash_for_update, #initialize, #setup_api, #time_to_ms
Methods included from Mixins
#log, #parse_relative_time, #parse_time, #relative_time, #time_multiplier, #valid_relative_time?
Methods included from Validators
#uuid?, #wf_alert_id?, #wf_alert_severity?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_derivedmetric_id?, #wf_distribution?, #wf_distribution_count?, #wf_distribution_interval?, #wf_distribution_values?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_ts?, #wf_user_id?, #wf_usergroup_id?, #wf_value?, #wf_version?, #wf_webhook_id?
Constructor Details
This class inherits a constructor from Wavefront::CoreApi
Instance Method Details
#create(body) ⇒ Wavefront::Response
POST /api/v2/derivedmetric Create a specific derived metric definition. Refer to the Swagger API docs for valid keys.
30 31 32 33 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 30 def create(body) raise ArgumentError unless body.is_a?(Hash) api.post('', body, 'application/json') end |
#delete(id) ⇒ Wavefront::Response
DELETE /api/v2/derivedmetric/id Delete a specific derived metric definition. Deleting an active derived metric moves it to ‘trash’, from where it can be restored with an #undelete operation. Deleting a derived metric in ‘trash’ removes it for ever.
44 45 46 47 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 44 def delete(id) wf_derivedmetric_id?(id) api.delete(id) end |
#describe(id, version = nil) ⇒ Wavefront::Response
GET /api/v2/derivedmetric/id Get a specific derived metric definition / Get a specific historical version of a specific derived metric definition.
57 58 59 60 61 62 63 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 57 def describe(id, version = nil) wf_derivedmetric_id?(id) wf_version?(version) if version fragments = [id] fragments += ['history', version] if version api.get(fragments.uri_concat) end |
#history(id) ⇒ Wavefront::Response
GET /api/v2/derivedmetric/id/history Get the version history of a derived metric definition.
92 93 94 95 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 92 def history(id) wf_derivedmetric_id?(id) api.get([id, 'history'].uri_concat) end |
#list(offset = 0, limit = 100) ⇒ Wavefront::Response
GET /api/v2/derivedmetric Get all derived metric definitions for a customer.
19 20 21 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 19 def list(offset = 0, limit = 100) api.get('', offset: offset, limit: limit) end |
#tag_add(id, tag) ⇒ Wavefront::Response
PUT /api/v2/derivedmetric/id/tag/tagValue Add a tag to a specific derived metric definition.
144 145 146 147 148 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 144 def tag_add(id, tag) wf_derivedmetric_id?(id) wf_string?(tag) api.put([id, 'tag', tag].uri_concat) end |
#tag_delete(id, tag) ⇒ Wavefront::Response
DELETE /api/v2/derivedmetric/id/tag/tagValue Remove a tag from a specific derived metric definition.
131 132 133 134 135 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 131 def tag_delete(id, tag) wf_derivedmetric_id?(id) wf_string?(tag) api.delete([id, 'tag', tag].uri_concat) end |
#tag_set(id, tags) ⇒ Wavefront::Response
POST /api/v2/derivedmetric/id/tag Set all tags associated with a specific derived metric definition.
117 118 119 120 121 122 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 117 def tag_set(id, ) wf_derivedmetric_id?(id) = Array() .each { |t| wf_string?(t) } api.post([id, 'tag'].uri_concat, .to_json, 'application/json') end |
#tags(id) ⇒ Wavefront::Response
GET /api/v2/derivedmetric/id/tag Get all tags associated with a specific derived metric definition.
104 105 106 107 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 104 def (id) wf_derivedmetric_id?(id) api.get([id, 'tag'].uri_concat) end |
#undelete(id) ⇒ Wavefront::Response
POST /api/v2/derivedmetric/id/undelete Move a derived metric definition from ‘trash’ back into active service.
157 158 159 160 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 157 def undelete(id) wf_derivedmetric_id?(id) api.post([id, 'undelete'].uri_concat) end |
#update(id, body, modify = true) ⇒ Wavefront::Response
PUT /api/v2/derivedmetric/id Update a specific derived metric definition.
76 77 78 79 80 81 82 83 84 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 76 def update(id, body, modify = true) wf_derivedmetric_id?(id) raise ArgumentError unless body.is_a?(Hash) return api.put(id, body, 'application/json') unless modify api.put(id, hash_for_update(describe(id).response, body), 'application/json') end |
#update_keys ⇒ Object
8 9 10 |
# File 'lib/wavefront-sdk/derivedmetric.rb', line 8 def update_keys # %i[id name url description sections] end |