Module: Wavefront::Validators

Included in:
CoreApi, Write, Writer::Core
Defined in:
lib/wavefront-sdk/validators.rb

Overview

A module of mixins to validate input. The Wavefront documentation lays down restrictions on types and sizes of various inputs, which we will check on the user’s behalf. Most of the information used in this file comes from community.wavefront.com/docs/DOC-1031 Some comes from the Swagger API documentation, some has come directly from Wavefront engineers.

rubocop:disable Metrics/ModuleLength

Instance Method Summary collapse

Instance Method Details

#uuid?(str) ⇒ Bool

Is the given string a UUID? These are used for various item IDs.

Parameters:

Returns:

  • (Bool) 


21
22
23
 
# File 'lib/wavefront-sdk/validators.rb', line 21

def uuid?(str)
  str.is_a?(String) && str =~ /([a-f\d]{8}(-[a-f\d]{4}){3}-[a-f\d]{12})/
end

#wf_alert_id?(id) ⇒ Boolean

Ensure the given argument is a valid Wavefront alert ID. Alerts are identified by the epoch-nanosecond at which they were created.

Parameters:

  • id (String) —

    the alert ID to validate

Returns:

  • (Boolean) —

    True if the alert ID is valid

Raises:

  • Wavefront::Exception::InvalidAlertId if the alert ID is not valid



218
219
220
221
222
 
# File 'lib/wavefront-sdk/validators.rb', line 218

def wf_alert_id?(id)
  id = id.to_s if id.is_a?(Numeric)
  return true if id.is_a?(String) && id.match(/^\d{13}$/)
  raise Wavefront::Exception::InvalidAlertId
end

#wf_alert_severity?(severity) ⇒ Boolean

Ensure the given argument is a valid alert severity

Parameters:

  • severity (String) —

    severity

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidAlertSeverity if not valid



313
314
315
316
 
# File 'lib/wavefront-sdk/validators.rb', line 313

def wf_alert_severity?(severity)
  return true if %w[INFO SMOKE WARN SEVERE].include?(severity)
  raise Wavefront::Exception::InvalidAlertSeverity
end

#wf_cloudintegration_id?(id) ⇒ Boolean

Ensure the given argument is a valid Wavefront cloud integration ID

Parameters:

  • id (String) —

    the integration name to validate

Returns:

  • (Boolean) —

    True if the integration name is valid

Raises:

  • Wavefront::Exception::InvalidCloudIntegrationId if the integration ID is not valid



232
233
234
235
 
# File 'lib/wavefront-sdk/validators.rb', line 232

def wf_cloudintegration_id?(id)
  return true if uuid?(id)
  raise Wavefront::Exception::InvalidCloudIntegrationId
end

#wf_dashboard_id?(id) ⇒ Boolean

There doesn’t seem to be a public statement on what’s allowed in a dashboard name. For now I’m going to assume up to 255 word characters.

Parameters:

  • id (String) —

    the dashboard ID to validate

Returns:

  • (Boolean) —

    true if the dashboard ID is valid

Raises:

  • Wavefront::Exception::InvalidDashboardID if the dashboard ID is not valid



246
247
248
249
 
# File 'lib/wavefront-sdk/validators.rb', line 246

def wf_dashboard_id?(id)
  return true if id.is_a?(String) && id.size < 256 && id.match(/^[\w\-]+$/)
  raise Wavefront::Exception::InvalidDashboardId
end

#wf_derivedmetric_id?(id) ⇒ Boolean

Ensure the given argument is a valid derived metric ID. IDs are the millisecond epoch timestamp at which the derived metric was created.

Parameters:

Returns:

  • (Boolean) —

    True if the ID is valid

Raises:

  • Wavefront::Exception::InvalidDerivedMetricId



259
260
261
262
263
264
 
# File 'lib/wavefront-sdk/validators.rb', line 259

def wf_derivedmetric_id?(id)
  id = id.to_s if id.is_a?(Numeric)
  return true if id.is_a?(String) && id =~ /^\d{13}$/

  raise Wavefront::Exception::InvalidDerivedMetricId
end

#wf_distribution?(dist) ⇒ Boolean

Validate a distribution description

Parameters:

  • dist (Hash) —

    description of distribution

Returns:

  • (Boolean) —

    true if valid

Raises:

  • whichever exception is thrown first when validating each component of the distribution.



438
439
440
441
442
443
444
445
 
# File 'lib/wavefront-sdk/validators.rb', line 438

def wf_distribution?(dist)
  wf_metric_name?(dist[:path])
  wf_distribution_values?(dist[:value])
  wf_epoch?(dist[:ts]) if dist[:ts]
  wf_source_id?(dist[:source]) if dist[:source]
  wf_point_tags?(dist[:tags]) if dist[:tags]
  true
end

#wf_distribution_count?(count) ⇒ Boolean

Ensure the given argument is a valid distribution count.

Parameters:

  • count (Numeric)

Returns:

  • (Boolean)

Raises:

  • Wavefront::Exception::InvalidDistributionCount if the count is not valid



501
502
503
504
 
# File 'lib/wavefront-sdk/validators.rb', line 501

def wf_distribution_count?(count)
  return true if count.is_a?(Integer) && count.positive?
  raise Wavefront::Exception::InvalidDistributionCount
end

#wf_distribution_interval?(interval) ⇒ Boolean

Ensure the given argument is a valid distribution interval.

Parameters:

  • interval (Symbol)

Returns:

  • (Boolean)

Raises:

  • Wavefront::Exception::InvalidDistributionInterval if the interval is not valid



491
492
493
494
 
# File 'lib/wavefront-sdk/validators.rb', line 491

def wf_distribution_interval?(interval)
  return true if i[m h d].include?(interval)
  raise Wavefront::Exception::InvalidDistributionInterval
end

#wf_distribution_values?(vals) ⇒ Boolean

Validate an array of distribution values

Parameters:

Returns:

  • (Boolean) —

    true if valid

Raises:

  • whichever exception is thrown first when validating each component of the distribution.



453
454
455
456
457
458
459
 
# File 'lib/wavefront-sdk/validators.rb', line 453

def wf_distribution_values?(vals)
  vals.each do |times, val|
    wf_distribution_count?(times)
    wf_value?(val)
  end
  true
end

#wf_epoch?(timestamp) ⇒ Boolean

Ensure the given argument is a valid epoch timestamp. Again, no range checking.

Parameters:

Returns:

  • (Boolean) —

    True if the timestamp is valid

Raises:

  • Wavefront::Exception::InvalidMaintenanceWindow



120
121
122
123
 
# File 'lib/wavefront-sdk/validators.rb', line 120

def wf_epoch?(timestamp)
  return true if timestamp.is_a?(Numeric)
  raise Wavefront::Exception::InvalidTimestamp
end

#wf_event_id?(id) ⇒ Boolean

Ensure the given argument is a valid event ID. Event IDs are an epoch-millisecond timestamp followed by a : followed by the name of the event.

Parameters:

  • id (String) —

    the event ID to validate

Returns:

  • (Boolean) —

    true if the event ID is valid

Raises:

  • Wavefront::Exception::InvalidEventID if the event ID is not valid



275
276
277
278
 
# File 'lib/wavefront-sdk/validators.rb', line 275

def wf_event_id?(id)
  return true if id.is_a?(String) && id =~ /^\d{13}:.+/
  raise Wavefront::Exception::InvalidEventId
end

#wf_granularity?(granularity) ⇒ Boolean

Ensure the given argument is a valid query granularity

Parameters:

  • granularity (String) —

    granularity

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidGranularity if not valid



336
337
338
339
 
# File 'lib/wavefront-sdk/validators.rb', line 336

def wf_granularity?(granularity)
  return true if %w[d h m s].include?(granularity.to_s)
  raise Wavefront::Exception::InvalidGranularity
end

#wf_integration_id?(id) ⇒ Boolean

Ensure the given argument is a valid Wavefront integration ID. These appear to be lower-case strings.

Parameters:

  • id (String) —

    the integration ID to validate

Returns:

  • (Boolean) —

    True if the integration name is valid

Raises:

  • Wavefront::Exception::InvalidIntegrationId if the integration ID is not valid



481
482
483
484
 
# File 'lib/wavefront-sdk/validators.rb', line 481

def wf_integration_id?(id)
  return true if id.is_a?(String) && id =~ /^[a-z0-9]+$/
  raise Wavefront::Exception::InvalidIntegrationId
end

#wf_link_id?(id) ⇒ Boolean

Ensure the given argument is a valid external Link ID

Parameters:

  • id (String) —

    the external link ID to validate

Returns:

  • (Boolean) —

    True if the link ID is valid

Raises:

  • Wavefront::Exception::InvalidExternalLinkId if the link ID is not valid



287
288
289
290
 
# File 'lib/wavefront-sdk/validators.rb', line 287

def wf_link_id?(id)
  return true if id.is_a?(String) && id =~ /^\w{16}$/
  raise Wavefront::Exception::InvalidExternalLinkId
end

#wf_link_template?(template) ⇒ Boolean

Ensure the given argument is a valid external link template

Returns:

  • (Boolean) —

    true if it is valid

Raises:

  • Wavefront::Exception::InvalidTemplate if not



30
31
32
33
34
35
36
37
 
# File 'lib/wavefront-sdk/validators.rb', line 30

def wf_link_template?(template)
  if template.is_a?(String) &&
     template.start_with?('http://', 'https://')
    return true
  end

  raise Wavefront::Exception::InvalidLinkTemplate
end

#wf_maintenance_window_id?(id) ⇒ Boolean

Ensure the given argument is a valid maintenance window ID. IDs are the millisecond epoch timestamp at which the window was created.

Parameters:

Returns:

  • (Boolean) —

    True if the ID is valid

Raises:

  • Wavefront::Exception::InvalidMaintenanceWindowId



300
301
302
303
304
305
 
# File 'lib/wavefront-sdk/validators.rb', line 300

def wf_maintenance_window_id?(id)
  id = id.to_s if id.is_a?(Numeric)
  return true if id.is_a?(String) && id =~ /^\d{13}$/

  raise Wavefront::Exception::InvalidMaintenanceWindowId
end

#wf_message_id?(id) ⇒ Boolean

Ensure the given argument is a valid message ID

Parameters:

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidMessageId if not valid



324
325
326
327
 
# File 'lib/wavefront-sdk/validators.rb', line 324

def wf_message_id?(id)
  return true if id.is_a?(String) && id =~ /^\w+::\w+$/
  raise Wavefront::Exception::InvalidMessageId
end

#wf_metric_name?(metric) ⇒ Boolean

Ensure the given argument is a valid Wavefront metric name, or path.

is not valid.

Parameters:

  • metric (String) —

    the metric name to validate

Returns:

  • (Boolean) —

    True if the metric name is valid

Raises:

  • Wavefront::Exception::InvalidMetricName if metric name



47
48
49
50
51
52
53
54
55
 
# File 'lib/wavefront-sdk/validators.rb', line 47

def wf_metric_name?(metric)
  if metric.is_a?(String) && metric.size < 1024 &&
     (metric.match(/^#{DELTA}?[\w\-\.]+$/) ||
      metric.match(%r{^\"#{DELTA}?[\w\-\.\/,]+\"$}))
    return true
  end

  raise Wavefront::Exception::InvalidMetricName
end

#wf_ms_ts?(timestamp) ⇒ Boolean

Ensure the given argument is a valid millisecond epoch timestamp. We do no checking of the value, because who am I to say that the user doesn’t want to send a point relating to 1ms after the epoch, or a thousand years in the future?

Parameters:

  • timestamp (Integer) —

    the timestamp name to validate

Returns:

  • (Boolean) —

    True if the value is valid

Raises:

  • Wavefront::Exception::InvalidTimestamp



108
109
110
111
 
# File 'lib/wavefront-sdk/validators.rb', line 108

def wf_ms_ts?(timestamp)
  return true if timestamp.is_a?(Numeric)
  raise Wavefront::Exception::InvalidTimestamp
end

#wf_name?(name) ⇒ Boolean

Ensure the given argument is a valid name, for instance for an event. Names can contain, AFAIK, word characters.

raise Wavefront::Exception::InvalidName if name is not valid

Parameters:

  • name (String) —

    the name to validate

Returns:

  • (Boolean) —

    true if the name is valid

Raises:



64
65
66
67
 
# File 'lib/wavefront-sdk/validators.rb', line 64

def wf_name?(name)
  return true if name.is_a?(String) && name.size < 1024 && name =~ /^\w+$/
  raise Wavefront::Exception::InvalidName
end

#wf_notificant_id?(id) ⇒ Boolean

Ensure the given argument is a valid Wavefront notificant ID.

Parameters:

  • id (String) —

    the notificant ID to validate

Returns:

  • (Boolean) —

    True if the notificant ID is valid

Raises:

  • Wavefront::Exception::InvalidNotificantId if the notificant ID is not valid



468
469
470
471
 
# File 'lib/wavefront-sdk/validators.rb', line 468

def wf_notificant_id?(id)
  return true if id.is_a?(String) && id =~ /^\w{16}$/
  raise Wavefront::Exception::InvalidNotificantId
end

#wf_point?(point) ⇒ Boolean

Validate a point so it conforms to the standard described in community.wavefront.com/docs/DOC-1031

Parameters:

  • point (Hash) —

    description of point

Returns:

  • (Boolean) —

    true if valid

Raises:

  • whichever exception is thrown first when validating each component of the point.



423
424
425
426
427
428
429
430
 
# File 'lib/wavefront-sdk/validators.rb', line 423

def wf_point?(point)
  wf_metric_name?(point[:path])
  wf_value?(point[:value])
  wf_epoch?(point[:ts]) if point[:ts]
  wf_source_id?(point[:source]) if point[:source]
  wf_point_tags?(point[:tags]) if point[:tags]
  true
end

#wf_point_tag?(key, val) ⇒ Boolean

Validate a single point tag, probably on behalf of #wf_point_tags?

Parameters:

Returns:

  • (Boolean) —

    nil

Raises:

  • Wavefront::Exception::InvalidTag if any tag is not valid



188
189
190
191
192
193
194
195
 
# File 'lib/wavefront-sdk/validators.rb', line 188

def wf_point_tag?(key, val)
  if key && val && (key.size + val.size < 254) &&
     key =~ /^[\w\-\.:]+$/ && val !~ /\\$/
    return
  end

  raise Wavefront::Exception::InvalidTag
end

#wf_point_tags?(tags) ⇒ Boolean

Ensure a hash of key:value point tags are value. Not to be confused with source tags.

Parameters:

  • tags (Hash) —

    a hash of key:value tags

Returns:

  • (Boolean) —

    True if all tags are valid

Raises:

  • Wavefront::Exception::InvalidTag if any tags in the has do not validate



177
178
179
180
 
# File 'lib/wavefront-sdk/validators.rb', line 177

def wf_point_tags?(tags)
  raise Wavefront::Exception::InvalidTag unless tags.is_a?(Hash)
  tags.each { |k, v| wf_point_tag?(k, v) }
end

#wf_proxy_id?(id) ⇒ Boolean

Ensure the given argument is a valid Wavefront proxy ID

Parameters:

  • id (String) —

    the proxy ID to validate

Returns:

  • (Boolean) —

    True if the proxy ID is valid

Raises:

  • Wavefront::Exception::InvalidProxyId if the proxy ID is not valid



204
205
206
207
 
# File 'lib/wavefront-sdk/validators.rb', line 204

def wf_proxy_id?(id)
  return true if uuid?(id)
  raise Wavefront::Exception::InvalidProxyId
end

#wf_savedsearch_entity?(id) ⇒ Boolean

Ensure the given argument is a valid saved search entity type.

Parameters:

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidSavedSearchEntity if not valid



359
360
361
362
363
364
 
# File 'lib/wavefront-sdk/validators.rb', line 359

def wf_savedsearch_entity?(id)
  return true if %w[DASHBOARD ALERT MAINTENANCE_WINDOW
                    NOTIFICANT EVENT SOURCE EXTERNAL_LINK AGENT
                    CLOUD_INTEGRATION].include?(id)
  raise Wavefront::Exception::InvalidSavedSearchEntity
end

#wf_savedsearch_id?(id) ⇒ Boolean

Ensure the given argument is a valid saved search ID.

Parameters:

  • id (String) —

    saved search ID

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidSavedSearchId if not valid



347
348
349
350
 
# File 'lib/wavefront-sdk/validators.rb', line 347

def wf_savedsearch_id?(id)
  return true if id.is_a?(String) && id =~ /^\w{8}$/
  raise Wavefront::Exception::InvalidSavedSearchId
end

#wf_source_id?(source) ⇒ Boolean

Ensure the given argument is a valid Wavefront source name

Parameters:

  • source (String) —

    the source name to validate

Returns:

  • (Boolean) —

    True if the source name is valid

Raises:

  • Wavefront::Exception::InvalidSourceId if the source name is not valid



373
374
375
376
377
378
379
380
 
# File 'lib/wavefront-sdk/validators.rb', line 373

def wf_source_id?(source)
  if source.is_a?(String) && source.match(/^[\w\.\-]+$/) &&
     source.size < 1024
    return true
  end

  raise Wavefront::Exception::InvalidSourceId
end

#wf_string?(str) ⇒ Boolean

Ensure the given argument is a valid string, for a tag name.

Parameters:

  • str (String) —

    the string name to validate

Returns:

  • (Boolean) —

    True if the string is valid

Raises:

  • Wavefront::Exception::InvalidString if string is not valid.



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

def wf_string?(str)
  #
  # Only allows PCRE "word" characters, spaces, full-stops and
  # commas in tags and descriptions. This might be too restrictive,
  # but if it is, this is the only place we need to change it.
  #
  if str.is_a?(String) && str.size < 1024 && str =~ /^[\-\w \.,]*$/
    return true
  end

  raise Wavefront::Exception::InvalidString
end

#wf_tag?(*tags) ⇒ Boolean

Ensure one, or an array, of tags are valid. These tags are used as source tags, or tags for maintenance windows etc. They can contain letters, numbers, -, _ and :, and must be less than 256 characters long

Parameters:

Returns:

  • (Boolean) —

    True if all tags are valid

Raises:

  • Wavefront::Exception::InvalidTag



134
135
136
137
138
139
140
141
142
 
# File 'lib/wavefront-sdk/validators.rb', line 134

def wf_tag?(*tags)
  Array(*tags).each do |tag|
    unless tag.is_a?(String) && tag.size < 255 && tag =~ /^[\w:\-\.]+$/
      raise Wavefront::Exception::InvalidTag
    end
  end

  true
end

#wf_ts?(timestamp) ⇒ Boolean

Ensure the given argument is a valid timestamp

Parameters:

  • timestamp (DateTime) —

    the timestamp name to validate

Returns:

  • (Boolean) —

    True if the value is valid

Raises:

  • Wavefront::Exception::InvalidTimestamp



94
95
96
97
 
# File 'lib/wavefront-sdk/validators.rb', line 94

def wf_ts?(timestamp)
  return true if timestamp.is_a?(Time) || timestamp.is_a?(Date)
  raise Wavefront::Exception::InvalidTimestamp
end

#wf_user_id?(user) ⇒ Boolean

Ensure the given argument is a valid user.

Parameters:

  • user (String) —

    user identifier

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidUserId if not valid



388
389
390
391
 
# File 'lib/wavefront-sdk/validators.rb', line 388

def wf_user_id?(user)
  return true if user.is_a?(String) && user.length < 256 && !user.empty?
  raise Wavefront::Exception::InvalidUserId
end

#wf_usergroup_id?(gid) ⇒ Boolean

Ensure the given argument is a valid user group.

Parameters:

  • gid (String) —

    user group identiier

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidUserGroupId if not valid



399
400
401
402
 
# File 'lib/wavefront-sdk/validators.rb', line 399

def wf_usergroup_id?(gid)
  return true if uuid?(gid)
  raise Wavefront::Exception::InvalidUserGroupId
end

#wf_value?(value) ⇒ Boolean

Ensure the given argument is a valid Wavefront value. Can be any form of Numeric, including standard notation.

Parameters:

  • value (Numeric) —

    the source name to validate

Returns:

  • (Boolean) —

    True if the value is valid

Raises:

  • Wavefront::Exception::InvalidValue if the value is not valid



151
152
153
154
 
# File 'lib/wavefront-sdk/validators.rb', line 151

def wf_value?(value)
  return true if value.is_a?(Numeric)
  raise Wavefront::Exception::InvalidMetricValue
end

#wf_version?(version) ⇒ Boolean

Ensure the given argument is a valid version number

Parameters:

  • version (Integer) —

    the version number to validate

Returns:

  • (Boolean) —

    True if the version is valid

Raises:

  • Wavefront::Exception::InvalidVersion if the alert ID is not valid



163
164
165
166
167
 
# File 'lib/wavefront-sdk/validators.rb', line 163

def wf_version?(version)
  version = version.to_i if version.is_a?(String) && version =~ /^\d+$/
  return true if version.is_a?(Integer) && version.positive?
  raise Wavefront::Exception::InvalidVersion
end

#wf_webhook_id?(id) ⇒ Boolean

Ensure the given argument is a valid webhook ID.

Parameters:

Returns:

  • (Boolean) —

    true if valid

Raises:

  • Wavefront::Exceptions::InvalidWebhook if not valid



410
411
412
413
 
# File 'lib/wavefront-sdk/validators.rb', line 410

def wf_webhook_id?(id)
  return true if id.is_a?(String) && id =~ /^[a-zA-Z0-9]{16}$/
  raise Wavefront::Exception::InvalidWebhookId
end