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", "24h"].freeze

Constants inherited from Base

Base::LOCK, Base::READONLY_ATTRIBUTES

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OptionalValidations

included

Methods inherited from Base

defaults, inherited, #name, settings, #tracking_id, validate_setting_exists

Methods included from SubclassTracking

#recursive_subclasses, #subclasses

Constructor Details

#initialize(project, *args) ⇒ Monitor

Returns a new instance of Monitor.



31
32
33
34
# File 'lib/kennel/models/monitor.rb', line 31

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

Instance Attribute Details

#projectObject (readonly)

Returns the value of attribute project.



29
30
31
# File 'lib/kennel/models/monitor.rb', line 29

def project
  @project
end

Class Method Details

.api_resourceObject



93
94
95
# File 'lib/kennel/models/monitor.rb', line 93

def self.api_resource
  "monitor"
end

Instance Method Details

#as_jsonObject



43
44
45
46
47
48
49
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
# File 'lib/kennel/models/monitor.rb', line 43

def as_json
  return @as_json if @as_json
  data = {
    name: "#{name}#{LOCK}",
    type: type,
    query: query,
    message: <<~TEXT.strip,
      #{message}

      @slack-#{project.team.slack}
    TEXT
    tags: @project.tags + tags,
    multi: multi,
    options: {
      timeout_h: 0,
      notify_no_data: notify_no_data,
      no_data_timeframe: no_data_timeframe,
      notify_audit: true,
      require_full_window: true,
      new_host_delay: 300,
      include_tags: true,
      escalation_message: Utils.presence(escalation_message.strip),
      evaluation_delay: nil,
      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 and ok are optional
  thresholds[:warning] = warning if warning
  thresholds[:ok] = ok if ok

  # metric and query values are stored as float by datadog
  if data.fetch(:type) == "query alert"
    thresholds.each { |k, v| thresholds[k] = Float(v) }
  end

  validate_json(data) if validate

  @as_json = data
end

#diff(actual) ⇒ Object



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/kennel/models/monitor.rb', line 101

def diff(actual)
  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

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

  # fields are not returned when set to true
  if actual[:type] == "service check"
    options[:thresholds][:critical] ||= 1
    options[:thresholds][:warning] ||= 1
    options[:thresholds][:ok] ||= 1
  end

  # nil or "" are not returned from the api
  options[:evaluation_delay] ||= nil

  super
end

#kennel_idObject



36
37
38
39
40
41
# File 'lib/kennel/models/monitor.rb', line 36

def kennel_id
  if self.class == Kennel::Models::Monitor
    raise "Need to set :kennel_id when defining monitors from Kennel::Models::Monitor"
  end
  super
end

#url(id) ⇒ Object



97
98
99
# File 'lib/kennel/models/monitor.rb', line 97

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