Class: Kennel::Models::Monitor
- Defined in:
- lib/kennel/models/monitor.rb
Constant Summary collapse
- RENOTIFY_INTERVALS =
minutes
[0, 10, 20, 30, 40, 50, 60, 90, 120, 180, 240, 300, 360, 720, 1440].freeze
- OPTIONAL_SERVICE_CHECK_THRESHOLDS =
[:ok, :warning].freeze
- READONLY_ATTRIBUTES =
superclass::READONLY_ATTRIBUTES + [ :multi, :matching_downtimes, :overall_state_modified, :overall_state, :restricted_roles ]
- TRACKING_FIELD =
:message
- MONITOR_DEFAULTS =
{ priority: nil }.freeze
- MONITOR_OPTION_DEFAULTS =
defaults that datadog uses when options are not sent, so safe to leave out if our values match their defaults
{ evaluation_delay: nil, new_host_delay: 300, timeout_h: 0, renotify_interval: 0, notify_audit: false, no_data_timeframe: nil, # this works out ok since if notify_no_data is on, it would never be nil groupby_simple_monitor: false, variables: nil, on_missing_data: "default", # "default" is "evaluate as zero" notification_preset_name: nil }.freeze
- DEFAULT_ESCALATION_MESSAGE =
["", nil].freeze
- ALLOWED_PRIORITY_CLASSES =
[NilClass, Integer].freeze
- ALLOWED_UNLINKED =
rubocop:disable Style/MutableConstant placeholder for custom overrides
[]
Constants inherited from Record
Record::ALLOWED_KENNEL_ID_CHARS, Record::ALLOWED_KENNEL_ID_FULL, Record::ALLOWED_KENNEL_ID_REGEX, Record::ALLOWED_KENNEL_ID_SEGMENT, Record::LOCK, Record::MARKER_TEXT, Record::TRACKING_FIELDS, Record::UnvalidatedRecordError
Constants included from OptionalValidations
OptionalValidations::UNIGNORABLE
Constants inherited from Base
Base::SETTING_OVERRIDABLE_METHODS
Constants included from SettingsAsMethods
SettingsAsMethods::AS_PROCS, SettingsAsMethods::SETTING_OVERRIDABLE_METHODS
Instance Attribute Summary
Attributes inherited from Record
#filtered_validation_errors, #project, #unfiltered_validation_errors
Class Method Summary collapse
- .api_resource ⇒ Object
- .normalize(expected, actual) ⇒ Object
- .parse_url(url) ⇒ Object
- .url(id) ⇒ Object
Instance Method Summary collapse
- #build_json ⇒ Object
- #resolve_linked_tracking_ids!(id_map, **args) ⇒ Object
- #validate_update!(diffs) ⇒ Object
Methods inherited from Record
#add_tracking_id, api_resource_map, #as_json, #build, #diff, #initialize, #invalid_update!, parse_any_url, parse_tracking_id, #remove_tracking_id, remove_tracking_id, #safe_tracking_id, #tracking_id
Methods included from OptionalValidations
Methods inherited from Base
Methods included from SubclassTracking
#recursive_subclasses, #subclasses
Methods included from SettingsAsMethods
included, #initialize, #raise_with_location
Constructor Details
This class inherits a constructor from Kennel::Models::Record
Class Method Details
.api_resource ⇒ Object
170 171 172 |
# File 'lib/kennel/models/monitor.rb', line 170 def self.api_resource "monitor" end |
.normalize(expected, actual) ⇒ Object
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/kennel/models/monitor.rb', line 190 def self.normalize(expected, actual) super ignore_default(expected, actual, MONITOR_DEFAULTS) = actual.fetch(:options) .delete(:silenced) # we do not manage silenced, so ignore it when diffing # fields are not returned when set to true if ["service check", "event alert"].include?(actual[:type]) [:include_tags] = true unless .key?(:include_tags) [:require_full_window] = true unless .key?(:require_full_window) end case actual[:type] when "event alert" # setting nothing results in thresholds not getting returned from the api [:thresholds] ||= { critical: 0 } when "service check" # fields are not returned when created with default values via UI OPTIONAL_SERVICE_CHECK_THRESHOLDS.each do |t| [:thresholds][t] ||= 1 end end # nil / "" / 0 are not returned from the api when set via the UI [:evaluation_delay] ||= nil = expected[:options] || {} ignore_default(, , MONITOR_OPTION_DEFAULTS) if DEFAULT_ESCALATION_MESSAGE.include?([:escalation_message]) .delete(:escalation_message) .delete(:escalation_message) end end |
.parse_url(url) ⇒ Object
178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/kennel/models/monitor.rb', line 178 def self.parse_url(url) # datadog uses / for show and # for edit as separator in it's links id = url[/\/monitors[\/#](\d+)/, 1] # slo alert url id ||= url[/\/slo\/edit\/[a-z\d]{10,}\/alerts\/(\d+)/, 1] return unless id Integer(id) end |
.url(id) ⇒ Object
174 175 176 |
# File 'lib/kennel/models/monitor.rb', line 174 def self.url(id) Utils.path_to_url "/monitors/#{id}/edit" end |
Instance Method Details
#build_json ⇒ Object
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 106 107 108 109 110 111 112 113 114 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 144 145 146 147 148 149 |
# File 'lib/kennel/models/monitor.rb', line 64 def build_json data = super.merge( name: "#{name}#{LOCK}", type: type, query: query.strip, message: .strip, tags: .uniq, priority: priority, options: { timeout_h: timeout_h, notify_no_data: notify_no_data, no_data_timeframe: notify_no_data ? no_data_timeframe : nil, notify_audit: notify_audit, require_full_window: require_full_window, new_host_delay: new_host_delay, new_group_delay: new_group_delay, include_tags: true, escalation_message: Utils.presence(.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, variables: variables } ) = data[:options] if data.fetch(:type) != "composite" thresholds = ([:thresholds] = { critical: critical }) # 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 thresholds[:critical] = critical unless 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 end # setting this via the api breaks the UI with # "The no_data_timeframe option is not allowed for log alert monitors" if data.fetch(:type) == "log alert" .delete :no_data_timeframe end if windows = threshold_windows [:threshold_windows] = windows end if schedule = [:scheduling_options] = schedule end # Datadog requires only either new_group_delay or new_host_delay, never both .delete([:new_group_delay] ? :new_host_delay : :new_group_delay) # Add in statuses where we would re notify on. Possible values: alert, no data, warn if [:renotify_interval] != 0 statuses = ["alert"] statuses << "no data" if [:notify_no_data] statuses << "warn" if .dig(:thresholds, :warning) [:renotify_statuses] = statuses end # for events: on_missing_data cannot be used with notify_no_data or no_data_timeframe if data.fetch(:type) == "event-v2 alert" [:on_missing_data] = on_missing_data [:notify_no_data] = false # cannot set nil or it's an endless update loop .delete :no_data_timeframe end # only set when needed to avoid big diff if (notification_preset_name = notification_preset_name()) [:notification_preset_name] = notification_preset_name end data end |
#resolve_linked_tracking_ids!(id_map, **args) ⇒ Object
151 152 153 154 155 156 157 158 159 160 |
# File 'lib/kennel/models/monitor.rb', line 151 def resolve_linked_tracking_ids!(id_map, **args) case as_json[:type] when "composite", "slo alert" type = (as_json[:type] == "composite" ? :monitor : :slo) as_json[:query] = as_json[:query].gsub(/%{(.*?)}/) do resolve($1, type, id_map, **args) || $& end else # do nothing end end |
#validate_update!(diffs) ⇒ Object
162 163 164 165 166 167 168 |
# File 'lib/kennel/models/monitor.rb', line 162 def validate_update!(diffs) # ensure type does not change, but not if it's metric->query which is supported and used by importer.rb _, path, from, to = diffs.detect { |_, path, _, _| path == "type" } if path && !(from == "metric alert" && to == "query alert") invalid_update!(path, from, to) end end |