kennel 1.55.0 → 1.57.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc230a06e4f7f969147e0c299ba61c4536d5623de432cfe3e247bece944962a
-  data.tar.gz: ae6d3ebe5db8fe7a5f406cda15e0a85d8a19b8d5f991a9787a63376a01572e70
+  metadata.gz: edff257eab30fa336ef8a067c7d02a5c4cfdb919b2381cbb88593e7292f4bef7
+  data.tar.gz: d166cc4f9bba2c73edf292e5d2a6e1e4e190125a04b608594b0e78055755134c
 SHA512:
-  metadata.gz: 3013cb61dd5c33a7dd1772b54645d62e7cf7e70bb5202f85950ab4f2a102e723d1583725200da513a54d66020af14ca9c57b63bc50e43b1a27a4d765d478c2fb
-  data.tar.gz: 28f5812c2795043927ca2161712d6e16f100cf6999e21fc64c3ee8e557d663c526a30dc9eef3069d2f229a699304d5f1029eb61176c3c51f4f825f5a45ac9e56
+  metadata.gz: b69c79b3ab7b34499bf4760d36ea54401b10e1bd0d68b37e4b39796b0a4fb48909a18fcbd724db619d95abf92f9585f094ec11c5d6c0332c3e4880c52654e977
+  data.tar.gz: ec9060115f34e789d1706e0165cd30fd5fb72c1451c6fa4b5df00b57fec18335ed81b960444a03424c5cf727fab6d32184357e0a442b93d86b2405b246f073e5

data/Readme.md

@@ -65,11 +65,11 @@ end
 ```
 
 ### Adding a new monitor
- - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to create a monitor
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors#create) to create a monitor
  - see below
 
 ### Updating an existing monitor
- - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to find a monitor
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors/manage) to find a monitor
  - get the `id` from the url
  - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`

data/lib/kennel.rb

@@ -10,16 +10,19 @@ require "kennel/syncer"
 require "kennel/api"
 require "kennel/github_reporter"
 require "kennel/subclass_tracking"
+require "kennel/settings_as_methods"
 require "kennel/file_cache"
 require "kennel/template_variables"
 require "kennel/optional_validations"
 require "kennel/unmuted_alerts"
 
 require "kennel/models/base"
+require "kennel/models/record"
 
-# parts
-require "kennel/models/monitor"
+# records
 require "kennel/models/dashboard"
+require "kennel/models/monitor"
+require "kennel/models/slo"
 
 # settings
 require "kennel/models/project"

data/lib/kennel/api.rb

@@ -8,7 +8,8 @@ module Kennel
     end
 
     def show(api_resource, id, params = {})
-      request :get, "/api/v1/#{api_resource}/#{id}", params: params
+      reply = request :get, "/api/v1/#{api_resource}/#{id}", params: params
+      api_resource == "slo" ? reply[:data] : reply
     end
 
     def list(api_resource, params = {})
@@ -16,7 +17,8 @@ module Kennel
     end
 
     def create(api_resource, attributes)
-      request :post, "/api/v1/#{api_resource}", body: attributes
+      reply = request :post, "/api/v1/#{api_resource}", body: attributes
+      api_resource == "slo" ? reply[:data].first : reply
     end
 
     def update(api_resource, id, attributes)

data/lib/kennel/importer.rb

@@ -28,7 +28,7 @@ module Kennel
 
       title_field = TITLES.detect { |f| data[f] }
       title = data.fetch(title_field)
-      title.tr!(Kennel::Models::Base::LOCK, "") # avoid double lock icon
+      title.tr!(Kennel::Models::Record::LOCK, "") # avoid double lock icon
 
       # calculate or reuse kennel_id
       # TODO: this is copy-pasted from syncer, need to find a nice way to reuse it
@@ -53,6 +53,8 @@ module Kennel
         if query && critical
           query.sub!(/([><=]) (#{Regexp.escape(critical.to_f.to_s)}|#{Regexp.escape(critical.to_i.to_s)})$/, "\\1 \#{critical}")
         end
+
+        data[:type] = "query alert" if data[:type] == "metric alert"
       elsif resource == "dashboard"
         widgets = data[:widgets]&.flat_map { |widget| widget.dig(:definition, :widgets) || [widget] }
         widgets&.each { |widget| dry_up_query!(widget) }
@@ -105,7 +107,9 @@ module Kennel
 
             "\n#{pretty}\n  "
           elsif k == :message
-            "\n    <<~TEXT\n#{v.each_line.map { |l| l.strip.empty? ? "\n" : "      #{l}" }.join}\n    TEXT\n  "
+            "\n    <<~TEXT\n#{v.each_line.map { |l| l.strip.empty? ? "\n" : "      #{l}" }.join}\n      \#{super()}\n    TEXT\n  "
+          elsif k == :tags
+            " super() + #{v.inspect} "
           else
             " #{v.inspect} "
           end

data/lib/kennel/models/base.rb

@@ -4,115 +4,10 @@ require "hashdiff"
 module Kennel
   module Models
     class Base
-      LOCK = "\u{1F512}"
-      READONLY_ATTRIBUTES = [
-        :deleted, :matching_downtimes, :id, :created, :created_at, :creator, :org_id, :modified,
-        :overall_state_modified, :overall_state, :api_resource
-      ].freeze
-      REQUEST_DEFAULTS = {
-        style: { width: "normal", palette: "dog_classic", type: "solid" },
-        conditional_formats: [],
-        aggregator: "avg"
-      }.freeze
-      OVERRIDABLE_METHODS = [:name, :kennel_id].freeze
+      extend SubclassTracking
+      include SettingsAsMethods
 
-      class ValidationError < RuntimeError
-      end
-
-      class << self
-        include SubclassTracking
-
-        def settings(*names)
-          duplicates = (@set & names)
-          if duplicates.any?
-            raise ArgumentError, "Settings #{duplicates.map(&:inspect).join(", ")} are already defined"
-          end
-
-          overrides = ((instance_methods - OVERRIDABLE_METHODS) & names)
-          if overrides.any?
-            raise ArgumentError, "Settings #{overrides.map(&:inspect).join(", ")} are already used as methods"
-          end
-
-          @set.concat names
-          names.each do |name|
-            next if method_defined?(name)
-            define_method name do
-              message = "Trying to call #{name} for #{self.class} but it was never set or passed as option"
-              raise_with_location ArgumentError, message
-            end
-          end
-        end
-
-        def defaults(options)
-          options.each do |name, block|
-            validate_setting_exists name
-            define_method name, &block
-          end
-        end
-
-        def inherited(child)
-          super
-          child.instance_variable_set(:@set, (@set || []).dup)
-        end
-
-        def validate_setting_exists(name)
-          return if !@set || @set.include?(name)
-          supported = @set.map(&:inspect)
-          raise ArgumentError, "Unsupported setting #{name.inspect}, supported settings are #{supported.join(", ")}"
-        end
-
-        private
-
-        def normalize(_expected, actual)
-          self::READONLY_ATTRIBUTES.each { |k| actual.delete k }
-        end
-
-        # discard styles/conditional_formats/aggregator if nothing would change when we applied (both are default or nil)
-        def ignore_request_defaults(expected, actual, level1, level2)
-          actual = actual[level1] || {}
-          expected = expected[level1] || {}
-          [expected.size.to_i, actual.size.to_i].max.times do |i|
-            a_r = actual.dig(i, level2, :requests) || []
-            e_r = expected.dig(i, level2, :requests) || []
-            ignore_defaults e_r, a_r, self::REQUEST_DEFAULTS
-          end
-        end
-
-        def ignore_defaults(expected, actual, defaults)
-          [expected&.size.to_i, actual&.size.to_i].max.times do |i|
-            e = expected[i] || {}
-            a = actual[i] || {}
-            ignore_default(e, a, defaults)
-          end
-        end
-
-        def ignore_default(expected, actual, defaults)
-          definitions = [actual, expected]
-          defaults.each do |key, default|
-            if definitions.all? { |r| !r.key?(key) || r[key] == default }
-              actual.delete(key)
-              expected.delete(key)
-            end
-          end
-        end
-      end
-
-      def initialize(options = {})
-        validate_options(options)
-
-        options.each do |name, block|
-          self.class.validate_setting_exists name
-          define_singleton_method name, &block
-        end
-
-        # need expand_path so it works wih rake and when run individually
-        pwd = /^#{Regexp.escape(Dir.pwd)}\//
-        @invocation_location = caller.detect do |l|
-          if found = File.expand_path(l).sub!(pwd, "")
-            break found
-          end
-        end
-      end
+      SETTING_OVERRIDABLE_METHODS = [:name, :kennel_id].freeze
 
       def kennel_id
         name = self.class.name
@@ -126,56 +21,9 @@ module Kennel
         self.class.name
       end
 
-      def diff(actual)
-        expected = as_json
-        expected.delete(:id)
-
-        self.class.send(:normalize, expected, actual)
-
-        HashDiff.diff(actual, expected, use_lcs: false)
-      end
-
-      def tracking_id
-        "#{project.kennel_id}:#{kennel_id}"
-      end
-
       def to_json
         raise NotImplementedError, "Use as_json"
       end
-
-      def resolve_linked_tracking_ids(*)
-      end
-
-      private
-
-      def resolve_link(id, id_map, force:)
-        id_map[id] || begin
-          message = "Unable to find #{id} in existing monitors (they need to be created first to link them)"
-          force ? invalid!(message) : Kennel.err.puts(message)
-        end
-      end
-
-      # let users know which project/resource failed when something happens during diffing where the backtrace is hidden
-      def invalid!(message)
-        raise ValidationError, "#{tracking_id} #{message}"
-      end
-
-      def raise_with_location(error, message)
-        message = message.dup
-        message << " for project #{project.kennel_id}" if defined?(project)
-        message << " on #{@invocation_location}" if @invocation_location
-        raise error, message
-      end
-
-      def validate_options(options)
-        unless options.is_a?(Hash)
-          raise ArgumentError, "Expected #{self.class.name}.new options to be a Hash, got a #{options.class}"
-        end
-        options.each do |k, v|
-          next if v.class == Proc
-          raise ArgumentError, "Expected #{self.class.name}.new option :#{k} to be Proc, for example `#{k}: -> { 12 }`"
-        end
-      end
     end
   end
 end

data/lib/kennel/models/dashboard.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 module Kennel
   module Models
-    class Dashboard < Base
+    class Dashboard < Record
       include TemplateVariables
       include OptionalValidations
 
       API_LIST_INCOMPLETE = true
       DASHBOARD_DEFAULTS = { template_variables: [] }.freeze
-      READONLY_ATTRIBUTES = Base::READONLY_ATTRIBUTES + [
+      READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
         :author_handle, :author_name, :modified_at, :url, :is_read_only, :notify_list
       ]
       REQUEST_DEFAULTS = {
@@ -15,7 +15,7 @@ module Kennel
       }.freeze
       SUPPORTED_DEFINITION_OPTIONS = [:events, :markers, :precision].freeze
 
-      settings :id, :title, :description, :definitions, :widgets, :kennel_id, :layout_type
+      settings :title, :description, :definitions, :widgets, :layout_type
 
       defaults(
         description: -> { "" },
@@ -32,9 +32,15 @@ module Kennel
         def normalize(expected, actual)
           super
 
-          ignore_default expected, actual, DASHBOARD_DEFAULTS
-
           base_pairs(expected, actual).each do |pair|
+            # datadog always adds 2 to slo widget height
+            # need to check fir layout since some monitors have height/width in their definition
+            pair.dig(1, :widgets)&.each do |widget|
+              if widget.dig(:definition, :type) == "slo" && widget.dig(:layout, :height)
+                widget[:layout][:height] -= 2
+              end
+            end
+
             # conditional_formats ordering is randomly changed by datadog, compare a stable ordering
             pair.each do |b|
               b[:widgets]&.each do |w|
@@ -64,13 +70,6 @@ module Kennel
         end
       end
 
-      attr_reader :project
-
-      def initialize(project, *args)
-        @project = project
-        super(*args)
-      end
-
       def as_json
         return @json if @json
         all_widgets = render_definitions + widgets
@@ -109,6 +108,10 @@ module Kennel
             if (id = definition[:alert_id]) && tracking_id?(id)
               definition[:alert_id] = resolve_link(id, id_map, force: false).to_s
             end
+          when "slo"
+            if (id = definition[:slo_id]) && tracking_id?(id)
+              definition[:slo_id] = resolve_link(id, id_map, force: false).to_s
+            end
           end
         end
       end

data/lib/kennel/models/monitor.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 module Kennel
   module Models
-    class Monitor < Base
+    class Monitor < Record
       include OptionalValidations
 
-      API_LIST_INCOMPLETE = false
       RENOTIFY_INTERVALS = [0, 10, 20, 30, 40, 50, 60, 90, 120, 180, 240, 300, 360, 720, 1440].freeze # minutes
       QUERY_INTERVALS = ["1m", "5m", "10m", "15m", "30m", "1h", "2h", "4h", "1d"].freeze
       OPTIONAL_SERVICE_CHECK_THRESHOLDS = [:ok, :warning].freeze
-      READONLY_ATTRIBUTES = Base::READONLY_ATTRIBUTES + [:multi]
+      READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
+        :multi, :matching_downtimes, :overall_state_modified, :overall_state
+      ]
 
       # defaults that datadog uses when options are not sent, so safe to leave out if our values match their defaults
       MONITOR_OPTION_DEFAULTS = {
@@ -21,8 +22,8 @@ module Kennel
       DEFAULT_ESCALATION_MESSAGE = ["", nil].freeze
 
       settings(
-        :query, :name, :message, :escalation_message, :critical, :kennel_id, :type, :renotify_interval, :warning, :timeout_h, :evaluation_delay,
-        :ok, :id, :no_data_timeframe, :notify_no_data, :notify_audit, :tags, :critical_recovery, :warning_recovery, :require_full_window,
+        :query, :name, :message, :escalation_message, :critical, :type, :renotify_interval, :warning, :timeout_h, :evaluation_delay,
+        :ok, :no_data_timeframe, :notify_no_data, :notify_audit, :tags, :critical_recovery, :warning_recovery, :require_full_window,
         :threshold_windows, :new_host_delay
       )
 
@@ -45,13 +46,6 @@ module Kennel
         threshold_windows: -> { nil }
       )
 
-      attr_reader :project
-
-      def initialize(project, *args)
-        @project = project
-        super(*args)
-      end
-
       def as_json
         return @as_json if @as_json
         data = {
@@ -108,8 +102,6 @@ module Kennel
         @as_json = data
       end
 
-      # resolve composite monitors ... only works when referenced monitors already exist
-      # since leaving names or bad ids in the query breaks the monitor update
       def resolve_linked_tracking_ids(id_map)
         if as_json[:type] == "composite"
           as_json[:query] = as_json[:query].gsub(/%\{(.*?)\}/) do

data/lib/kennel/models/record.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+module Kennel
+  module Models
+    class Record < Base
+      LOCK = "\u{1F512}"
+      READONLY_ATTRIBUTES = [
+        :deleted, :id, :created, :created_at, :creator, :org_id, :modified, :modified_at, :api_resource
+      ].freeze
+      REQUEST_DEFAULTS = {
+        style: { width: "normal", palette: "dog_classic", type: "solid" },
+        conditional_formats: [],
+        aggregator: "avg"
+      }.freeze
+      API_LIST_INCOMPLETE = false
+
+      class ValidationError < RuntimeError
+      end
+
+      settings :id, :kennel_id
+
+      class << self
+        private
+
+        def normalize(_expected, actual)
+          self::READONLY_ATTRIBUTES.each { |k| actual.delete k }
+        end
+
+        # discard styles/conditional_formats/aggregator if nothing would change when we applied (both are default or nil)
+        def ignore_request_defaults(expected, actual, level1, level2)
+          actual = actual[level1] || {}
+          expected = expected[level1] || {}
+          [expected.size.to_i, actual.size.to_i].max.times do |i|
+            a_r = actual.dig(i, level2, :requests) || []
+            e_r = expected.dig(i, level2, :requests) || []
+            ignore_defaults e_r, a_r, self::REQUEST_DEFAULTS
+          end
+        end
+
+        def ignore_defaults(expected, actual, defaults)
+          [expected&.size.to_i, actual&.size.to_i].max.times do |i|
+            e = expected[i] || {}
+            a = actual[i] || {}
+            ignore_default(e, a, defaults)
+          end
+        end
+
+        def ignore_default(expected, actual, defaults)
+          definitions = [actual, expected]
+          defaults.each do |key, default|
+            if definitions.all? { |r| !r.key?(key) || r[key] == default }
+              actual.delete(key)
+              expected.delete(key)
+            end
+          end
+        end
+      end
+
+      attr_reader :project
+
+      def initialize(project, *args)
+        raise ArgumentError, "First argument must be a project, not #{project.class}" unless project.is_a?(Project)
+        @project = project
+        super(*args)
+      end
+
+      def diff(actual)
+        expected = as_json
+        expected.delete(:id)
+
+        self.class.send(:normalize, expected, actual)
+
+        HashDiff.diff(actual, expected, use_lcs: false)
+      end
+
+      def tracking_id
+        "#{project.kennel_id}:#{kennel_id}"
+      end
+
+      def resolve_linked_tracking_ids(*)
+      end
+
+      private
+
+      def resolve_link(id, id_map, force:)
+        id_map[id] || begin
+          message = "Unable to find #{id} in existing monitors (they need to be created first to link them)"
+          force ? invalid!(message) : Kennel.err.puts(message)
+        end
+      end
+
+      # let users know which project/resource failed when something happens during diffing where the backtrace is hidden
+      def invalid!(message)
+        raise ValidationError, "#{tracking_id} #{message}"
+      end
+
+      def raise_with_location(error, message)
+        super error, "#{message} for project #{project.kennel_id}"
+      end
+    end
+  end
+end

data/lib/kennel/models/slo.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+module Kennel
+  module Models
+    class Slo < Record
+      READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [:type_id, :monitor_tags]
+      DEFAULTS = {
+        description: nil,
+        query: nil,
+        monitor_ids: []
+      }.freeze
+
+      settings :type, :description, :thresholds, :query, :tags, :monitor_ids, :monitor_tags, :name
+
+      defaults(
+        id: -> { nil },
+        tags: -> { @project.tags },
+        query: -> { DEFAULTS.fetch(:query) },
+        description: -> { DEFAULTS.fetch(:description) },
+        monitor_ids: -> { DEFAULTS.fetch(:monitor_ids) }
+      )
+
+      def as_json
+        return @as_json if @as_json
+        data = {
+          name: "#{name}#{LOCK}",
+          description: description,
+          thresholds: thresholds,
+          monitor_ids: monitor_ids,
+          tags: tags,
+          type: type
+        }
+
+        data[:query] = query if query
+        data[:id] = id if id
+
+        @as_json = data
+      end
+
+      def self.api_resource
+        "slo"
+      end
+
+      def url(id)
+        Utils.path_to_url "/slo?slo_id=#{id}"
+      end
+
+      def resolve_linked_tracking_ids(id_map)
+        as_json[:monitor_ids] = as_json[:monitor_ids].map do |id|
+          id.is_a?(String) ? resolve_link(id, id_map, force: false) || 1 : id
+        end
+      end
+
+      def self.normalize(expected, actual)
+        super
+
+        # remove readonly values
+        actual[:thresholds]&.each do |threshold|
+          threshold.delete(:warning_display)
+          threshold.delete(:target_display)
+        end
+
+        # tags come in a semi-random order and order is never updated
+        expected[:tags]&.sort!
+        actual[:tags].sort!
+
+        ignore_default(expected, actual, DEFAULTS)
+      end
+    end
+  end
+end

data/lib/kennel/optional_validations.rb

@@ -6,19 +6,10 @@ module Kennel
       base.defaults(validate: -> { true })
     end
 
-    # https://stackoverflow.com/questions/20235206/ruby-get-all-keys-in-a-hash-including-sub-keys/53876255#53876255
-    def self.all_keys(items)
-      case items
-      when Hash then items.keys + items.values.flat_map { |v| all_keys(v) }
-      when Array then items.flat_map { |i| all_keys(i) }
-      else []
-      end
-    end
-
     private
 
     def validate_json(data)
-      bad = OptionalValidations.all_keys(data).grep_v(Symbol)
+      bad = Kennel::Utils.all_keys(data).grep_v(Symbol)
       return if bad.empty?
       invalid!(
         "Only use Symbols as hash keys to avoid permanent diffs when updating.\n" \

data/lib/kennel/settings_as_methods.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+module Kennel
+  module SettingsAsMethods
+    SETTING_OVERRIDABLE_METHODS = [].freeze
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.instance_variable_set(:@settings, [])
+    end
+
+    module ClassMethods
+      def settings(*names)
+        duplicates = (@settings & names)
+        if duplicates.any?
+          raise ArgumentError, "Settings #{duplicates.map(&:inspect).join(", ")} are already defined"
+        end
+
+        overrides = ((instance_methods - self::SETTING_OVERRIDABLE_METHODS) & names)
+        if overrides.any?
+          raise ArgumentError, "Settings #{overrides.map(&:inspect).join(", ")} are already used as methods"
+        end
+
+        @settings.concat names
+
+        names.each do |name|
+          next if method_defined?(name)
+          define_method name do
+            message = "Trying to call #{name} for #{self.class} but it was never set or passed as option"
+            raise_with_location ArgumentError, message
+          end
+        end
+      end
+
+      def defaults(options)
+        options.each do |name, block|
+          validate_setting_exist name
+          define_method name, &block
+        end
+      end
+
+      private
+
+      def validate_setting_exist(name)
+        return if !@settings || @settings.include?(name)
+        supported = @settings.map(&:inspect)
+        raise ArgumentError, "Unsupported setting #{name.inspect}, supported settings are #{supported.join(", ")}"
+      end
+
+      def inherited(child)
+        super
+        child.instance_variable_set(:@settings, (@settings || []).dup)
+      end
+    end
+
+    def initialize(options = {})
+      super()
+
+      unless options.is_a?(Hash)
+        raise ArgumentError, "Expected #{self.class.name}.new options to be a Hash, got a #{options.class}"
+      end
+
+      options.each do |k, v|
+        next if v.class == Proc
+        raise ArgumentError, "Expected #{self.class.name}.new option :#{k} to be Proc, for example `#{k}: -> { 12 }`"
+      end
+
+      options.each do |name, block|
+        self.class.send :validate_setting_exist, name
+        define_singleton_method name, &block
+      end
+
+      # need expand_path so it works wih rake and when run individually
+      pwd = /^#{Regexp.escape(Dir.pwd)}\//
+      @invocation_location = caller.detect do |l|
+        if found = File.expand_path(l).sub!(pwd, "")
+          break found
+        end
+      end
+    end
+
+    def raise_with_location(error, message)
+      message = message.dup
+      message << " on #{@invocation_location}" if @invocation_location
+      raise error, message
+    end
+  end
+end

data/lib/kennel/syncer.rb

@@ -71,28 +71,28 @@ module Kennel
       Progress.progress "Diffing" do
         filter_by_project! actual
 
-        details_cache do |cache|
-          items = actual.map do |a|
-            e = matching_expected(a)
-            if e && @expected.delete(e)
-              [e, a]
-            else
-              [nil, a]
-            end
+        items = actual.map do |a|
+          e = matching_expected(a)
+          if e && @expected.delete(e)
+            [e, a]
+          else
+            [nil, a]
           end
+        end
 
+        details_cache do |cache|
           # fill details of things we need to compare (only do this part in parallel for safety & balancing)
           Utils.parallel(items.select { |e, _| e && e.class::API_LIST_INCOMPLETE }) { |_, a| fill_details(a, cache) }
+        end
 
-          # pick out things to update or delete
-          items.each do |e, a|
-            id = a.fetch(:id)
-            if e
-              diff = e.diff(a)
-              @update << [id, e, a, diff] if diff.any?
-            elsif tracking_id(a) # was previously managed
-              @delete << [id, nil, a]
-            end
+        # pick out things to update or delete
+        items.each do |e, a|
+          id = a.fetch(:id)
+          if e
+            diff = e.diff(a)
+            @update << [id, e, a, diff] if diff.any?
+          elsif tracking_id(a) # was previously managed
+            @delete << [id, nil, a]
           end
         end
 
@@ -113,7 +113,7 @@ module Kennel
 
     # dashes are nested, others are not
     def unnest(api_resource, result)
-      result[api_resource.to_sym] || result
+      result[api_resource.to_sym] || result[:data] || result
     end
 
     def details_cache(&block)
@@ -122,14 +122,9 @@ module Kennel
     end
 
     def download_definitions
-      api_resources = Models::Base.subclasses.map do |m|
-        next unless m.respond_to?(:api_resource)
-        m.api_resource
-      end
-
-      Utils.parallel(api_resources.compact.uniq) do |api_resource|
+      Utils.parallel(Models::Record.subclasses.map(&:api_resource)) do |api_resource|
         results = @api.list(api_resource, with_downtimes: false) # lookup monitors without adding unnecessary downtime information
-        results = results[results.keys.first] if results.is_a?(Hash) # dashes/screens are nested in {dash: {}}
+        results = results[results.keys.first] if results.is_a?(Hash) # dashboards are nested in {dashboards: []}
         results.each { |c| c[:api_resource] = api_resource } # store api resource for later diffing
       end.flatten(1)
     end

data/lib/kennel/tasks.rb

@@ -38,6 +38,7 @@ namespace :kennel do
       url = (subdomain ? "https://zendesk.datadoghq.com" : "") + "/account/settings"
       puts "Invalid mentions found, either ignore them by adding to `KNOWN` env var or add them via #{url}"
       bad.each { |f, v| puts "Invalid mention #{v} in monitor message of #{f}" }
+      abort
     end
   end
 

data/lib/kennel/utils.rb

@@ -133,6 +133,15 @@ module Kennel
         Kennel.err.puts "Error #{e}, #{times} retries left"
         retry
       end
+
+      # https://stackoverflow.com/questions/20235206/ruby-get-all-keys-in-a-hash-including-sub-keys/53876255#53876255
+      def all_keys(items)
+        case items
+        when Hash then items.keys + items.values.flat_map { |v| all_keys(v) }
+        when Array then items.flat_map { |i| all_keys(i) }
+        else []
+        end
+      end
     end
   end
 end

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -47,11 +47,11 @@ end
 ```
 
 ### Adding a new monitor
- - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to create a monitor
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors#create) to create a monitor
  - see below
 
 ### Updating an existing monitor
- - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to find a monitor
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors/manage) to find a monitor
  - get the `id` from the url
  - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
@@ -161,6 +161,10 @@ To link to existing monitors via their kennel_id
 
 Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a given datadog monitor tag.
 
+### Validating mentions work
+
+`rake kennel:validate_mentions` should run as part of CI
+
 ## Examples
 
 ### Reusable monitors/dashes/etc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.55.0
+  version: 1.57.2
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-14 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -68,9 +68,12 @@ files:
 - lib/kennel/models/dashboard.rb
 - lib/kennel/models/monitor.rb
 - lib/kennel/models/project.rb
+- lib/kennel/models/record.rb
+- lib/kennel/models/slo.rb
 - lib/kennel/models/team.rb
 - lib/kennel/optional_validations.rb
 - lib/kennel/progress.rb
+- lib/kennel/settings_as_methods.rb
 - lib/kennel/subclass_tracking.rb
 - lib/kennel/syncer.rb
 - lib/kennel/tasks.rb