Class: Wavefront::Dashboard

Inherits:
CoreApi
  • Object
show all
Defined in:
lib/wavefront-sdk/dashboard.rb

Overview

View and manage dashboards.

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts

Instance Method Summary collapse

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

#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_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/dashboard Create a specific dashboard. Refer to the Swagger API docs for valid keys.

Parameters:

  • body (Hash) —

    description of dashboard

Returns:

Raises:

  • (ArgumentError) 


30
31
32
33
 
# File 'lib/wavefront-sdk/dashboard.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/dashboard/id Delete a specific dashboard. Deleting an active dashboard moves it to ‘trash’, from where it can be restored with an #undelete operation. Deleting a dashboard in ‘trash’ removes it for ever.

Parameters:

  • id (String) —

    ID of the dashboard

Returns:



44
45
46
47
 
# File 'lib/wavefront-sdk/dashboard.rb', line 44

def delete(id)
  wf_dashboard_id?(id)
  api.delete(id)
end

#describe(id, version = nil) ⇒ Wavefront::Response

GET /api/v2/dashboard/id Get a specific dashboard / Get a specific historical version of a specific dashboard.

Parameters:

  • id (String) —

    ID of the dashboard

  • version (Integer) (defaults to: nil) —

    version of dashboard

Returns:



57
58
59
60
61
62
63
 
# File 'lib/wavefront-sdk/dashboard.rb', line 57

def describe(id, version = nil)
  wf_dashboard_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/dashboard/id/history Get the version history of a dashboard.

Parameters:

  • id (String) —

    ID of the dashboard

Returns:



92
93
94
95
 
# File 'lib/wavefront-sdk/dashboard.rb', line 92

def history(id)
  wf_dashboard_id?(id)
  api.get([id, 'history'].uri_concat)
end

#list(offset = 0, limit = 100) ⇒ Wavefront::Response

GET /api/v2/dashboard Get all dashboards for a customer.

Parameters:

  • offset (Int) (defaults to: 0) —

    dashboard at which the list begins

  • limit (Int) (defaults to: 100) —

    the number of dashboards to return

Returns:



19
20
21
 
# File 'lib/wavefront-sdk/dashboard.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/dashboard/id/tag/tagValue Add a tag to a specific dashboard.

Parameters:

  • id (String) —

    ID of the dashboard

  • tag (String) —

    tag to set.

Returns:



142
143
144
145
146
 
# File 'lib/wavefront-sdk/dashboard.rb', line 142

def tag_add(id, tag)
  wf_dashboard_id?(id)
  wf_string?(tag)
  api.put([id, 'tag', tag].uri_concat)
end

#tag_delete(id, tag) ⇒ Wavefront::Response

DELETE /api/v2/dashboard/id/tag/tagValue Remove a tag from a specific dashboard.

Parameters:

  • id (String) —

    ID of the dashboard

  • tag (String) —

    tag to delete

Returns:



129
130
131
132
133
 
# File 'lib/wavefront-sdk/dashboard.rb', line 129

def tag_delete(id, tag)
  wf_dashboard_id?(id)
  wf_string?(tag)
  api.delete([id, 'tag', tag].uri_concat)
end

#tag_set(id, tags) ⇒ Wavefront::Response

POST /api/v2/dashboard/id/tag Set all tags associated with a specific dashboard.

Parameters:

  • id (String) —

    ID of the dashboard

  • tags (Array) —

    list of tags to set.

Returns:



115
116
117
118
119
120
 
# File 'lib/wavefront-sdk/dashboard.rb', line 115

def tag_set(id, tags)
  wf_dashboard_id?(id)
  tags = Array(tags)
  tags.each { |t| wf_string?(t) }
  api.post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
end

#tags(id) ⇒ Wavefront::Response

GET /api/v2/dashboard/id/tag Get all tags associated with a specific dashboard.

Parameters:

  • id (String) —

    ID of the dashboard

Returns:



103
104
105
106
 
# File 'lib/wavefront-sdk/dashboard.rb', line 103

def tags(id)
  wf_dashboard_id?(id)
  api.get([id, 'tag'].uri_concat)
end

#undelete(id) ⇒ Wavefront::Response

POST /api/v2/dashboard/id/undelete Move a dashboard from ‘trash’ back into active service.

Parameters:

  • id (String) —

    ID of the dashboard

Returns:



154
155
156
157
 
# File 'lib/wavefront-sdk/dashboard.rb', line 154

def undelete(id)
  wf_dashboard_id?(id)
  api.post([id, 'undelete'].uri_concat)
end

#update(id, body, modify = true) ⇒ Wavefront::Response

PUT /api/v2/dashboard/id Update a specific dashboard.

Parameters:

  • id (String) —

    a Wavefront alert ID

  • body (Hash) —

    key-value hash of the parameters you wish to change

  • modify (true, false) (defaults to: true) —

    if true, use #describe() to get a hash describing the existing object, and modify that with the new body. If false, pass the new body straight through.

Returns:

Raises:

  • (ArgumentError) 


76
77
78
79
80
81
82
83
84
 
# File 'lib/wavefront-sdk/dashboard.rb', line 76

def update(id, body, modify = true)
  wf_dashboard_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/dashboard.rb', line 8

def update_keys
  %i[id name url description sections]
end