Class: Kennel::Models::Monitor

Inherits:
Base
  • Object
show all
Includes:
OptionalValidations
Defined in:
lib/kennel/models/monitor.rb

Constant Summary collapse

API_LIST_INCOMPLETE = 
false
RENOTIFY_INTERVALS =

minutes

[0, 10, 20, 30, 40, 50, 60, 90, 120, 180, 240, 300, 360, 720, 1440].freeze
QUERY_INTERVALS = 
["1m", "5m", "10m", "15m", "30m", "1h", "2h", "4h", "1d"].freeze
OPTIONAL_SERVICE_CHECK_THRESHOLDS = 
[:ok, :warning].freeze
NON_MULTI_TYPES =

NOTE: event alerts don’t seem to return their multi setting

["query alert", "log alert", "composite"].freeze
MONITOR_DEFAULTS = 
{
  escalation_message: nil,
  evaluation_delay: nil,
  no_data_timeframe: nil
}.freeze

Constants inherited from Base

Base::LOCK, Base::READONLY_ATTRIBUTES, Base::REQUEST_DEFAULTS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OptionalValidations

all_keys, included

Methods inherited from Base

defaults, #diff, inherited, #kennel_id, #name, #resolve_linked_tracking_ids, settings, #to_json, #tracking_id, validate_setting_exists

Methods included from SubclassTracking

#recursive_subclasses, #subclasses

Constructor Details

#initialize(project, *args) ⇒ Monitor

Returns a new instance of Monitor.



45
46
47
48
 
# File 'lib/kennel/models/monitor.rb', line 45

def initialize(project, *args)
  @project = project
  super(*args)
end

Instance Attribute Details

#project ⇒ Object (readonly)

Returns the value of attribute project.



43
44
45
 
# File 'lib/kennel/models/monitor.rb', line 43

def project
  @project
end

Class Method Details

.api_resource ⇒ Object 



107
108
109
 
# File 'lib/kennel/models/monitor.rb', line 107

def self.api_resource
  "monitor"
end

.normalize(expected, actual) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/kennel/models/monitor.rb', line 115

def self.normalize(expected, actual)
  super
  options = actual.fetch(:options)
  options.delete(:silenced) # we do not manage silenced, so ignore it when diffing
  options[:escalation_message] ||= nil # unset field is not returned and would break the diff

  # fields are not returned when set to true
  if ["service check", "event alert"].include?(actual[:type])
    options[:include_tags] = true unless options.key?(:include_tags)
    options[:require_full_window] = true unless options.key?(:require_full_window)
  end

  case actual[:type]
  when "event alert"
    # setting 0 results in thresholds not getting returned from the api
    options[:thresholds] ||= { critical: 0 }

  when "service check"
    # fields are not returned when created with default values via UI
    OPTIONAL_SERVICE_CHECK_THRESHOLDS.each do |t|
      options[:thresholds][t] ||= 1
    end
  end

  # nil / "" / 0 are not returned from the api when set via the UI
  options[:evaluation_delay] ||= nil

  ignore_default(expected[:options] || {}, options, MONITOR_DEFAULTS)
end

Instance Method Details

#as_json ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/kennel/models/monitor.rb', line 50

def as_json
  return @as_json if @as_json
  data = {
    name: "#{name}#{LOCK}",
    type: type,
    query: query.strip,
    message: message.strip,
    tags: tags.uniq,
    multi: multi,
    options: {
      timeout_h: timeout_h,
      notify_no_data: notify_no_data,
      no_data_timeframe: no_data_timeframe,
      notify_audit: notify_audit,
      require_full_window: require_full_window,
      new_host_delay: 300,
      include_tags: true,
      escalation_message: Utils.presence(escalation_message.strip),
      evaluation_delay: evaluation_delay,
      locked: false, # setting this to true prevents any edit and breaks updates when using replace workflow
      renotify_interval: renotify_interval || 0,
      thresholds: {
        critical: critical
      }
    }
  }

  options = data[:options]
  thresholds = options[:thresholds]

  data[:id] = id if id

  # warning, ok, critical_recovery, and warning_recovery are optional
  [:warning, :ok, :critical_recovery, :warning_recovery].each do |key|
    if value = send(key)
      thresholds[key] = value
    end
  end

  case data.fetch(:type)
  when "service check"
    # avoid diff for default values of 1
    OPTIONAL_SERVICE_CHECK_THRESHOLDS.each { |t| thresholds[t] ||= 1 }
  when "query alert"
    # metric and query values are stored as float by datadog
    thresholds.each { |k, v| thresholds[k] = Float(v) }
  end

  if windows = threshold_windows
    options[:threshold_windows] = windows
  end

  validate_json(data) if validate

  @as_json = data
end

#url(id) ⇒ Object 



111
112
113
 
# File 'lib/kennel/models/monitor.rb', line 111

def url(id)
  Utils.path_to_url "/monitors##{id}/edit"
end