class Wavefront::Proxy

Manage and query Wavefront proxies.

Public Instance Methods

delete(id) click to toggle source

DELETE /api/v2/proxy/id Delete a specific proxy

Deleting an active proxy moves it to 'trash', from where it can be restored with an undelete operation. Deleting a proxy in 'trash' removes it for ever.

@param id [String] ID of the proxy @return [Wavefront::Response]

# File lib/wavefront-sdk/proxy.rb, line 30
def delete(id)
  wf_proxy_id?(id)
  api.delete(id)
end
describe(id) click to toggle source

GET /api/v2/proxy/id Get a specific proxy

@param id [String] ID of the proxy @return [Wavefront::Response]

# File lib/wavefront-sdk/proxy.rb, line 41
def describe(id)
  wf_proxy_id?(id)
  api.get(id)
end
list(offset = 0, limit = 100) click to toggle source

GET /api/v2/proxy Get all proxies for a customer

@param offset [Int] proxy at which the list begins @param limit [Int] the number of proxies to return

# File lib/wavefront-sdk/proxy.rb, line 16
def list(offset = 0, limit = 100)
  api.get('', offset: offset, limit: limit)
end
rename(id, name) click to toggle source

PUT /api/v2/proxy/id Update the name of a specific proxy

Rename a proxy. This changes the human-readable name, not the unique identifier.

@param id [String] ID of the proxy @param name [String] new name @return [Wavefront::Response]

# File lib/wavefront-sdk/proxy.rb, line 69
def rename(id, name)
  wf_proxy_id?(id)
  wf_string?(name)
  update(id, name: name)
end
shutdown(id) click to toggle source

Shutdown a proxy. Requires proxy >=5.x. Might not be effective if you have something like systemd or SMF restarting a failed proxy. @param id [String] ID of the proxy @return [Wavefront::Response]

# File lib/wavefront-sdk/proxy.rb, line 95
def shutdown(id)
  wf_proxy_id?(id)
  api.put(id, { shutdown: true }, 'application/json')
end
undelete(id) click to toggle source

POST /api/v2/proxy/id/undelete Undelete a specific proxy

Move a proxy from 'trash' back into active service.

@param id [String] ID of the proxy @return [Wavefront::Response]

# File lib/wavefront-sdk/proxy.rb, line 54
def undelete(id)
  wf_proxy_id?(id)
  api.post([id, 'undelete'].uri_concat)
end
update(id, payload) click to toggle source

A generic function to change properties of a proxy. So far as I know, only the 'name' property can currently be changed, and we supply a dedicated rename method for that.

@param id [String] ID of the proxy @param payload [Hash] a key: value hash, where the key is the

property to change and the value is its desired value. No
validation is performed on any part of the payload.

@return [Wavefront::Response]

# File lib/wavefront-sdk/proxy.rb, line 85
def update(id, payload)
  wf_proxy_id?(id)
  api.put(id, payload)
end