Class: Wavefront::Source

Inherits:
CoreApi show all
Defined in:
lib/wavefront-sdk/source.rb

Overview

View and manage source metadata.

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

#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/source Create metadata (description or tags) for a specific source.

Refer to the Swagger API docs for valid keys.

Parameters:

  • body (Hash) —

    description of source

Returns:

Raises:

  • (ArgumentError) 


35
36
37
38
 
# File 'lib/wavefront-sdk/source.rb', line 35

def create(body)
  raise ArgumentError unless body.is_a?(Hash)
  api.post('', body, 'application/json')
end

#delete(id) ⇒ Wavefront::Response

DELETE /api/v2/source/id Delete metadata (description and tags) for a specific source.

Parameters:

  • id (String) —

    ID of the source

Returns:



46
47
48
49
 
# File 'lib/wavefront-sdk/source.rb', line 46

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

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

GET /api/v2/source/id Get a specific source for a customer.

Parameters:

  • id (String) —

    ID of the source

Returns:



74
75
76
77
78
79
80
 
# File 'lib/wavefront-sdk/source.rb', line 74

def describe(id, version = nil)
  wf_source_id?(id)
  wf_version?(version) if version
  fragments = [id]
  fragments += ['history', version] if version
  api.get(fragments.uri_concat)
end

#description_delete(id) ⇒ Object

DELETE /api/v2/source/id/description Remove description from a specific source



63
64
65
66
 
# File 'lib/wavefront-sdk/source.rb', line 63

def description_delete(id)
  wf_source_id?(id)
  api.delete([id, 'description'].uri_concat)
end

#description_set(id, description) ⇒ Object

POST /api/v2/source/id/description Set description associated with a specific source



54
55
56
57
58
 
# File 'lib/wavefront-sdk/source.rb', line 54

def description_set(id, description)
  wf_source_id?(id)
  api.post([id, 'description'].uri_concat, description,
           'application/json')
end

#list(limit = nil, cursor = nil) ⇒ Wavefront::Response

GET /api/v2/source Get all sources for a customer

Parameters:

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

    the number of sources to return

  • cursor (String) (defaults to: nil) —

    source at which the list begins

Returns:



19
20
21
22
23
24
25
 
# File 'lib/wavefront-sdk/source.rb', line 19

def list(limit = nil, cursor = nil)
  qs = {}
  qs[:limit] = limit if limit
  qs[:cursor] = cursor if cursor

  api.get('', qs)
end

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

PUT /api/v2/source/id/tag/tagValue Add a tag to a specific source

Parameters:

  • id (String) —

    ID of the source

  • tag (String) —

    tag to set.

Returns:



148
149
150
151
152
 
# File 'lib/wavefront-sdk/source.rb', line 148

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

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

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

Parameters:

  • id (String) —

    ID of the source

  • tag (String) —

    tag to delete

Returns:



135
136
137
138
139
 
# File 'lib/wavefront-sdk/source.rb', line 135

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

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

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

Parameters:

  • id (String) —

    ID of the source

  • tags (Array) —

    list of tags to set.

Returns:



121
122
123
124
125
126
 
# File 'lib/wavefront-sdk/source.rb', line 121

def tag_set(id, tags)
  wf_source_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/source/id/tag Get all tags associated with a specific source.

Parameters:

  • id (String) —

    ID of the source

Returns:



109
110
111
112
 
# File 'lib/wavefront-sdk/source.rb', line 109

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

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

PUT /api/v2/source/id Update metadata (description or tags) for a specific source.

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) 


93
94
95
96
97
98
99
100
101
 
# File 'lib/wavefront-sdk/source.rb', line 93

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

def update_keys
  %i[sourceName tags description]
end