Class: Wavefront::Alert
- Includes:
- Mixin::Acl, Mixin::Tag
- Defined in:
- lib/wavefront-sdk/alert.rb
Overview
View and manage alerts. Alerts are identified by their millisecond epoch timestamp. Returns a Wavefront::Response::Alert object.
Instance Attribute Summary
Attributes inherited from CoreApi
Instance Method Summary collapse
-
#alerts_in_state(state) ⇒ Wavfront::Response
Use a search to get all alerts in the given state.
-
#all ⇒ Wavefront::Response
All your alerts.
-
#checking ⇒ Wavefront::Response
All alerts being checked.
-
#clone(id, version = nil) ⇒ Wavefront::Response
POST /api/v2/alert/id/clone Clones the specified alert.
-
#create(body) ⇒ Wavefront::Response
POST /api/v2/alert Create a specific alert.
-
#delete(id) ⇒ Wavefront::Response
DELETE /api/v2/alert/id Delete a specific alert.
-
#describe(id, version = nil) ⇒ Wavefront::Response
GET /api/v2/alert/id GET /api/v2/alert/id/history/version Get a specific alert / Get a specific historical version of a specific alert.
-
#firing ⇒ Wavefront::Response
(also: #active)
All currently firing alerts.
-
#history(id, offset = nil, limit = nil) ⇒ Wavefront::Response
GET /api/v2/alert/id/history Get the version history of a specific alert.
-
#in_maintenance ⇒ Wavefront::Response
(also: #affected_by_maintenance)
All alerts currently in a maintenance window.
-
#install(id) ⇒ Object
POST /api/v2/alert/id/install Unhide a specific integration alert.
-
#invalid ⇒ Wavefront::Response
All alerts which have an invalid query.
-
#list(offset = 0, limit = 100) ⇒ Wavefront::Response
GET /api/v2/alert Get all alerts for a customer.
-
#no_data ⇒ Wavefront::Response
All alerts reporting NO_DATA.
-
#none ⇒ Wavefront::Response
I honestly don’t know what the NONE state denotes, but this will fetch alerts which have it.
-
#snooze(id, seconds = nil) ⇒ Wavefront::Response
POST /api/v2/alert/id/snooze Snooze a specific alert for some number of seconds.
-
#snoozed ⇒ Wavefront::Response
All alerts currently snoozed.
-
#summary ⇒ Wavefront::Response
GET /api/v2/alert/summary Count alerts of various statuses for a customer.
-
#trash ⇒ Wavefront::Response
All alerts in the trash.
-
#undelete(id) ⇒ Wavefront::Response
POST /api/v2/alert/id/undelete Undelete a specific alert.
-
#uninstall(id) ⇒ Object
POST /api/v2/alert/id/uninstall Hide a specific integration alert.
-
#unsnooze(id) ⇒ Wavefront::Response
POST /api/v2/alert/id/unsnooze Unsnooze a specific alert.
-
#update(id, body, modify = true) ⇒ Wavefront::Response
PUT /api/v2/alert/id Update a specific alert.
- #update_keys ⇒ Object
- #valid_id?(id) ⇒ Boolean
-
#versions(id) ⇒ Object
Gets all the versions of the given alert.
Methods included from Mixin::Tag
#tag_add, #tag_delete, #tag_set, #tags
Methods included from Mixin::Acl
#acl_add, #acl_delete, #acl_set, #acls
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_account_id?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_aws_external_id?, #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_ingestionpolicy_id?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_metricspolicy_id?, #wf_monitoredcluster_id?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_permission?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_role_id?, #wf_sampling_value?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_serviceaccount_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_trace?, #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
#alerts_in_state(state) ⇒ Wavfront::Response
Use a search to get all alerts in the given state. You would be better to use one of the wrapper methods like #firing, #snoozed etc, but I’ve left this method public in case new states are added before the SDK supports them.
288 289 290 291 292 293 |
# File 'lib/wavefront-sdk/alert.rb', line 288 def alerts_in_state(state) require_relative 'search' wfs = Wavefront::Search.new(creds, opts) query = { key: 'status', value: state, matchingMethod: 'EXACT' } wfs.search(:alert, query, limit: :all, offset: PAGE_SIZE) end |
#all ⇒ Wavefront::Response
Returns all your alerts.
276 277 278 |
# File 'lib/wavefront-sdk/alert.rb', line 276 def all list(PAGE_SIZE, :all) end |
#checking ⇒ Wavefront::Response
Returns all alerts being checked.
258 259 260 |
# File 'lib/wavefront-sdk/alert.rb', line 258 def checking alerts_in_state(:checking) end |
#clone(id, version = nil) ⇒ Wavefront::Response
POST /api/v2/alert/id/clone Clones the specified alert
121 122 123 124 125 126 127 128 129 |
# File 'lib/wavefront-sdk/alert.rb', line 121 def clone(id, version = nil) wf_alert_id?(id) wf_version?(version) if version api.post([id, 'clone'].uri_concat, { id: id, name: nil, v: version }, 'application/json') end |
#create(body) ⇒ Wavefront::Response
POST /api/v2/alert Create a specific alert. We used to validate input here, but this couples the SDK too tightly to the API. Now it’s just a generic POST of a hash.
41 42 43 44 45 |
# File 'lib/wavefront-sdk/alert.rb', line 41 def create(body) raise ArgumentError unless body.is_a?(Hash) api.post('', body, 'application/json') end |
#delete(id) ⇒ Wavefront::Response
DELETE /api/v2/alert/id Delete a specific alert.
Deleting an active alert moves it to ‘trash’, from where it can be restored with an #undelete operation. Deleting an alert in ‘trash’ removes it for ever.
57 58 59 60 |
# File 'lib/wavefront-sdk/alert.rb', line 57 def delete(id) wf_alert_id?(id) api.delete(id) end |
#describe(id, version = nil) ⇒ Wavefront::Response
GET /api/v2/alert/id GET /api/v2/alert/id/history/version Get a specific alert / Get a specific historical version of a specific alert.
71 72 73 74 75 76 77 |
# File 'lib/wavefront-sdk/alert.rb', line 71 def describe(id, version = nil) wf_alert_id?(id) wf_version?(version) if version fragments = [id] fragments += ['history', version] if version api.get(fragments.uri_concat) end |
#firing ⇒ Wavefront::Response Also known as: active
Returns all currently firing alerts.
235 236 237 |
# File 'lib/wavefront-sdk/alert.rb', line 235 def firing alerts_in_state(:firing) end |
#history(id, offset = nil, limit = nil) ⇒ Wavefront::Response
GET /api/v2/alert/id/history Get the version history of a specific alert.
137 138 139 140 141 142 143 144 |
# File 'lib/wavefront-sdk/alert.rb', line 137 def history(id, offset = nil, limit = nil) wf_alert_id?(id) qs = {} qs[:offset] = offset if offset qs[:limit] = limit if limit api.get([id, 'history'].uri_concat, qs) end |
#in_maintenance ⇒ Wavefront::Response Also known as: affected_by_maintenance
Returns all alerts currently in a maintenance window.
243 244 245 |
# File 'lib/wavefront-sdk/alert.rb', line 243 def in_maintenance alerts_in_state(:in_maintenance) end |
#install(id) ⇒ Object
POST /api/v2/alert/id/install Unhide a specific integration alert
149 150 151 152 |
# File 'lib/wavefront-sdk/alert.rb', line 149 def install(id) wf_alert_id?(id) api.post([id, 'install'].uri_concat, nil) end |
#invalid ⇒ Wavefront::Response
Returns all alerts which have an invalid query.
220 221 222 |
# File 'lib/wavefront-sdk/alert.rb', line 220 def invalid alerts_in_state(:invalid) end |
#list(offset = 0, limit = 100) ⇒ Wavefront::Response
GET /api/v2/alert Get all alerts for a customer
29 30 31 |
# File 'lib/wavefront-sdk/alert.rb', line 29 def list(offset = 0, limit = 100) api.get('', offset: offset, limit: limit) end |
#no_data ⇒ Wavefront::Response
Returns all alerts reporting NO_DATA.
270 271 272 |
# File 'lib/wavefront-sdk/alert.rb', line 270 def no_data alerts_in_state(:no_data) end |
#none ⇒ Wavefront::Response
Returns I honestly don’t know what the NONE state denotes, but this will fetch alerts which have it.
252 253 254 |
# File 'lib/wavefront-sdk/alert.rb', line 252 def none alerts_in_state(:none) end |
#snooze(id, seconds = nil) ⇒ Wavefront::Response
POST /api/v2/alert/id/snooze Snooze a specific alert for some number of seconds.
162 163 164 165 166 |
# File 'lib/wavefront-sdk/alert.rb', line 162 def snooze(id, seconds = nil) wf_alert_id?(id) qs = seconds ? "?seconds=#{seconds}" : '' api.post([id, "snooze#{qs}"].uri_concat, nil) end |
#snoozed ⇒ Wavefront::Response
Returns all alerts currently snoozed.
229 230 231 |
# File 'lib/wavefront-sdk/alert.rb', line 229 def snoozed alerts_in_state(:snoozed) end |
#summary ⇒ Wavefront::Response
GET /api/v2/alert/summary Count alerts of various statuses for a customer
207 208 209 |
# File 'lib/wavefront-sdk/alert.rb', line 207 def summary api.get('summary') end |
#trash ⇒ Wavefront::Response
Returns all alerts in the trash.
264 265 266 |
# File 'lib/wavefront-sdk/alert.rb', line 264 def trash alerts_in_state(:trash) end |
#undelete(id) ⇒ Wavefront::Response
POST /api/v2/alert/id/undelete Undelete a specific alert.
178 179 180 181 |
# File 'lib/wavefront-sdk/alert.rb', line 178 def undelete(id) wf_alert_id?(id) api.post([id, 'undelete'].uri_concat) end |
#uninstall(id) ⇒ Object
POST /api/v2/alert/id/uninstall Hide a specific integration alert
186 187 188 189 |
# File 'lib/wavefront-sdk/alert.rb', line 186 def uninstall(id) wf_alert_id?(id) api.post([id, 'uninstall'].uri_concat, nil) end |
#unsnooze(id) ⇒ Wavefront::Response
POST /api/v2/alert/id/unsnooze Unsnooze a specific alert.
197 198 199 200 |
# File 'lib/wavefront-sdk/alert.rb', line 197 def unsnooze(id) wf_alert_id?(id) api.post([id, 'unsnooze'].uri_concat) end |
#update(id, body, modify = true) ⇒ Wavefront::Response
PUT /api/v2/alert/id Update a specific alert.
105 106 107 108 109 110 111 112 113 |
# File 'lib/wavefront-sdk/alert.rb', line 105 def update(id, body, modify = true) wf_alert_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
17 18 19 20 |
# File 'lib/wavefront-sdk/alert.rb', line 17 def update_keys %i[id name target condition displayExpression minutes tag resolveAfterMinutes severity additionalInformation] end |
#valid_id?(id) ⇒ Boolean
168 169 170 |
# File 'lib/wavefront-sdk/alert.rb', line 168 def valid_id?(id) wf_alert_id?(id) end |
#versions(id) ⇒ Object
Gets all the versions of the given alert
83 84 85 86 87 88 89 90 91 92 |
# File 'lib/wavefront-sdk/alert.rb', line 83 def versions(id) wf_alert_id?(id) resp = api.get([id, 'history'].uri_concat) return if opts[:noop] versions = resp.response.items.map(&:version) resp.response[:items] = versions resp end |