kennel 2.10.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9213ac86e78dd85ff280d2048bd20fe3d074c3d6218cc45021b8c11eee7c720c
-  data.tar.gz: b2506ab43bb450a0496db0985ffa990b378ad591fa7be2a1c8db32223863680e
+  metadata.gz: ef24e36c2feeba08b92edd003e6d11bfefaa31bd0839765393325b29e8132cb3
+  data.tar.gz: 54f97c79250c564d62f01837cc85badc4cdc3357860f40e0408d33640d1a94a8
 SHA512:
-  metadata.gz: 73331755a7074cd0eeb95c92901cb8bf477380672a553cd7ef4722ec4cb6ea6f2fd56634eef442fb4a59de961d102c7b8b0f5b39788d006c24d960573eb27500
-  data.tar.gz: fa9ee34a57cce815f63eba43208daac2232cd04456f1200adc4181e6a381407b93962d52cbc5f9b27398caa863c8ab371758f5c216613b0218f8b9e958de6bc5
+  metadata.gz: '08b01acd5c750342d5134e6c2ca6d235bdb5cefc8f0b61b46e7b475ed7be6fd677772bab5a032d2a67685e02389d6741f05ef1e05a0758d3c6f6ff2fae68cb0d'
+  data.tar.gz: 79cc9956a1b1790c2e6bfb7f25c981542a2b21d96f8c3d1bdc5328d1e708c410372fa9405bf16a3fbaf7a27aaf1954ca71cb760ae4bfad82fa346b10635b0e8c

data/lib/kennel/models/monitor.rb

@@ -6,7 +6,8 @@ module Kennel
 
       OPTIONAL_SERVICE_CHECK_THRESHOLDS = [:ok, :warning].freeze
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
-        :multi, :matching_downtimes, :overall_state_modified, :overall_state, :restricted_roles, :draft_status, :assets
+        :multi, :matching_downtimes, :overall_state_modified, :overall_state, :restricted_roles, :draft_status, :assets,
+        :enable_logs_sample
       ]
       TRACKING_FIELD = :message
 
@@ -25,7 +26,7 @@ module Kennel
         group_retention_duration: nil,
         groupby_simple_monitor: false,
         variables: nil,
-        on_missing_data: "default", # "default" is "evaluate as zero"
+        on_missing_data: nil,
         notification_preset_name: nil,
         notify_by: nil
       }.freeze
@@ -55,6 +56,7 @@ module Kennel
         # datadog UI sets this to false by default, but true is safer
         # except for log alerts which will always have "no error" gaps and should default to false
         notify_no_data: -> { !SKIP_NOTIFY_NO_DATA_TYPES.include?(type) },
+        no_data_timeframe: -> { MONITOR_OPTION_DEFAULTS.fetch(:no_data_timeframe) },
         notify_audit: -> { MONITOR_OPTION_DEFAULTS.fetch(:notify_audit) },
         new_host_delay: -> { MONITOR_OPTION_DEFAULTS.fetch(:new_host_delay) },
         new_group_delay: -> { nil },
@@ -74,6 +76,8 @@ module Kennel
       )
 
       def build_json
+        no_data_options = configure_no_data
+
         data = super.merge(
           name: "#{name}#{LOCK}",
           type: type,
@@ -83,8 +87,7 @@ module Kennel
           priority: priority,
           options: {
             timeout_h: timeout_h,
-            notify_no_data: notify_no_data,
-            no_data_timeframe: notify_no_data ? no_data_timeframe : nil,
+            **no_data_options.except(:on_missing_data),
             notify_audit: notify_audit,
             require_full_window: require_full_window,
             new_host_delay: new_host_delay,
@@ -92,33 +95,14 @@ module Kennel
             include_tags: true,
             escalation_message: Utils.presence(escalation_message.strip),
             evaluation_delay: evaluation_delay,
-            locked: false, # deprecated: setting this to true will likely fail
             renotify_interval: renotify_interval || 0,
-            variables: variables
+            variables: variables,
+            **configure_thresholds,
+            **no_data_options.slice(:on_missing_data) # moved here to avoid generated diff
           }
         )
 
         options = data[:options]
-        if data.fetch(:type) != "composite"
-          thresholds = (options[: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
 
         # set without causing lots of nulls to be stored
         if (notify_by_value = notify_by)
@@ -149,30 +133,46 @@ module Kennel
         # Add in statuses where we would re notify on. Possible values: alert, no data, warn
         if options[:renotify_interval] != 0
           statuses = ["alert"]
-          statuses << "no data" if options[:notify_no_data]
+          statuses << "no data" if options[:notify_no_data] || options[:on_missing_data] == "show_and_notify_no_data"
           statuses << "warn" if options.dig(:thresholds, :warning)
           options[:renotify_statuses] = statuses
         end
 
-        # on_missing_data cannot be used with notify_no_data or no_data_timeframe
-        # TODO migrate everything to only use on_missing_data
-        if data.fetch(:type) == "event-v2 alert" || on_missing_data != "default"
-          options[:on_missing_data] = on_missing_data
-          options[:notify_no_data] = false # cannot set nil or it's an endless update loop
-          options.delete :no_data_timeframe
-        end
-
         # only set when needed to avoid big diff
         if (notification_preset_name = notification_preset_name())
           options[:notification_preset_name] = notification_preset_name
         end
 
-        # locked is deprecated, will fail if used
-        options.delete :locked
-
         data
       end
 
+      # TODO: migrate everything to only use on_missing_data by only sending notify_no_data when it was set by a user
+      # and enforce that it is not set at the same time as on_missing_data
+      def configure_no_data
+        notify = notify_no_data
+        timeframe = no_data_timeframe
+        action = on_missing_data
+        action ||= "default" if type == "event-v2 alert"
+
+        # TODO: mark setting action && !notify.nil? at all as invalid
+        if action && timeframe
+          invalid! :invalid_no_data_config, "set either no_data_timeframe or on_missing_data"
+        end
+        if type == "composite" && action
+          invalid! :invalid_no_data_config, "cannot use on_missing_data with composite monitor"
+        end
+
+        # on_missing_data cannot be used with notify_no_data + no_data_timeframe
+        if action
+          { on_missing_data: action || "default" }
+        else
+          {
+            notify_no_data: notify,
+            no_data_timeframe: notify ? no_data_timeframe || default_no_data_timeframe : nil
+          }
+        end
+      end
+
       def resolve_linked_tracking_ids!(id_map, **args)
         case as_json[:type]
         when "composite", "slo alert"
@@ -194,7 +194,7 @@ module Kennel
       # deprecated this setting is no longer returned by dd for new monitors
       # datadog UI warns when setting no data timeframe to less than 2x the query window
       # limited to 24h because `no_data_timeframe must not exceed group retention` and max group retention is 24h
-      def no_data_timeframe
+      def default_no_data_timeframe
         default = 60
         if type == "query alert" && (minutes = query_window_minutes)
           (minutes * 2).clamp(default, 24 * 60)
@@ -206,7 +206,8 @@ module Kennel
       # validate that monitors that alert on no data resolve in external services by using timeout_h, so it sends a
       # notification when the no data group is removed from the monitor, which datadog does automatically after 24h
       def timeout_h
-        notify_no_data && on_missing_data != "resolve" ? 24 : MONITOR_OPTION_DEFAULTS.fetch(:timeout_h)
+        sending_no_data_notifications = (on_missing_data ? on_missing_data == "show_and_notify_no_data" : notify_no_data)
+        sending_no_data_notifications ? 24 : MONITOR_OPTION_DEFAULTS.fetch(:timeout_h)
       end
 
       def self.api_resource
@@ -235,7 +236,9 @@ module Kennel
         ignore_default(expected, actual, MONITOR_DEFAULTS)
 
         options = actual.fetch(:options)
-        options.delete(:silenced) # we do not manage silenced, so ignore it when diffing
+
+        # we do not manage silenced: ignore it when diffing
+        options.delete(:silenced)
 
         # fields are not returned when set to true
         if ["service check", "event alert"].include?(actual[:type])
@@ -265,13 +268,38 @@ module Kennel
           options.delete(:escalation_message)
           expected_options.delete(:escalation_message)
         end
+
         # locked is deprecated: ignored when diffing
         options.delete(:locked)
-        expected_options.delete(:locked)
       end
 
       private
 
+      def configure_thresholds
+        return {} if type == "composite"
+
+        thresholds = { critical: critical }
+
+        # set optional variables
+        [:warning, :ok, :critical_recovery, :warning_recovery].each do |key|
+          if (value = send(key))
+            thresholds[key] = value
+          end
+        end
+
+        # custom logic for some types
+        case 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
+
+        { thresholds: thresholds }
+      end
+
       def validate_json(data)
         super
 
@@ -287,9 +315,11 @@ module Kennel
         end
 
         # verify query includes critical value
-        if (query_value = data.fetch(:query)[/\s*[<>]=?\s*(\d+(\.\d+)?)\s*$/, 1])
-          if Float(query_value) != Float(data.dig(:options, :thresholds, :critical))
-            invalid! :critical_does_not_match_query, "critical and value used in query must match"
+        if (critical = data.dig(:options, :thresholds, :critical))
+          if (query_value = data.fetch(:query)[/\s*[<>]=?\s*(\d+(\.\d+)?)\s*$/, 1])
+            if Float(query_value) != Float(critical)
+              invalid! :critical_does_not_match_query, "critical and value used in query must match"
+            end
           end
         end
 

data/lib/kennel/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kennel
-  VERSION = "2.10.0"
+  VERSION = "2.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-08 00:00:00.000000000 Z
+date: 2026-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs