kennel 1.76.2 → 1.78.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f414fdeaa15b105fde4fa0cbcf70956246bcafafd31aa3d4a48dbed37e3a31ff
-  data.tar.gz: b29014f8c562d772429a09ede70ad92d7ad892f4359628c66e24535cd50e4232
+  metadata.gz: 404c565dc87a8ffd30f1c0293228cc5270bedd3c6e5eaae1d191ba6cdae60ce7
+  data.tar.gz: 274f807772d6077c625a503aeb3d98edeef795bf0d7c40845db56d7b2e2e2ff0
 SHA512:
-  metadata.gz: 2cb2504d598f41a5fb3f75431cadaf58749b4d8d381d8c87f89125c703c8122c916ceb3064e25332d2f8f0c8b9f0b69b28d76f1c71000d515e7e027e2df118da
-  data.tar.gz: 75f379f50a897704e3bb488960920ce2e11e79249d32ad77b851d05ed6ed5c886ce060869c1bad6474b383fdb4ebcb8c117b051bf1e88b9fa590d96cede73284
+  metadata.gz: b165262ab6d8f6e8efadff786d3829a75e96d6893e4235eed961ef5203c66d0f250488e7911964a77c2862df0e196e08619582ce9cda51fed851141785a0a9c4
+  data.tar.gz: ab59bfdd4ca2d73526fb28126fd1f18765ce92703d7bad71c05d7f321f54fa39192db87ad4a7ae65c12441e38eb794264bceae8aad57be84e30a2c06ac65b3f5

data/Readme.md

@@ -198,6 +198,15 @@ end
   end
  ```
 
+### Updating existing resources with id
+
+Setting `id` makes kennel take over a manually created datadog resource.
+When manually creating to import, it is best to remove the `id` and delete the manually created resource.
+
+When an `id` is set and the original resource is deleted, kennel will fail to update,
+removing the `id` will cause kennel to create a new resource in datadog.
+
+
 ### Skipping validations
 
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and
@@ -210,6 +219,7 @@ To link to existing monitors via their kennel_id `projects kennel_id` + `:` + `m
  - Screens `uptime` widgets can use `monitor: {id: "foo:bar"}`
  - Screens `alert_graph` widgets can use `alert_id: "foo:bar"`
  - Monitors `composite` can use `query: -> { "%{foo:bar} || %{foo:baz}" }`
+ - Slos can use `monitor_ids: -> ["foo:bar"]` 
 
 ### Debugging changes locally
 

data/lib/kennel/api.rb

@@ -42,8 +42,11 @@ module Kennel
       request :put, "/api/v1/#{api_resource}/#{id}", body: attributes
     end
 
+    # - force=true to not dead-lock on dependent monitors+slos
+    #   external dependency on kennel managed resources is their problem, we don't block on it
+    #   (?force=true did not work, force for dashboard is not documented but does not blow up)
     def delete(api_resource, id)
-      request :delete, "/api/v1/#{api_resource}/#{id}", ignore_404: true
+      request :delete, "/api/v1/#{api_resource}/#{id}", params: { force: "true" }, ignore_404: true
     end
 
     private

data/lib/kennel/models/dashboard.rb

@@ -178,7 +178,7 @@ module Kennel
       def validate_json(data)
         super
 
-        validate_template_variables data, :widgets
+        validate_template_variables data
 
         # Avoid diff from datadog presets sorting.
         presets = data[:template_variable_presets]

data/lib/kennel/models/monitor.rb

@@ -192,7 +192,7 @@ module Kennel
         end
 
         if type == "query alert"
-          # verify interval is valud
+          # verify interval is valid
           interval = data.fetch(:query)[/\(last_(\S+?)\)/, 1]
           if interval && !QUERY_INTERVALS.include?(interval)
             invalid! "query interval was #{interval}, but must be one of #{QUERY_INTERVALS.join(", ")}"
@@ -200,13 +200,20 @@ module Kennel
         end
 
         if ["query alert", "service check"].include?(type) # TODO: most likely more types need this
-          # verify is_match uses available variables
+          # verify is_match/is_exact_match uses available variables
           message = data.fetch(:message)
-          used = message.scan(/{{\s*#is_match\s*"([a-zA-Z\d_.-]+).name"/).flatten.uniq
-          allowed = data.fetch(:query)[/by\s*[({]([^})]+)[})]/, 1].to_s.gsub(/["']/, "").split(/\s*,\s*/)
-          unsupported = used - allowed
-          if unsupported.any?
-            invalid! "is_match used with #{unsupported}, but metric is only grouped by #{allowed}"
+          used = message.scan(/{{\s*([#^]is(?:_exact)?_match)\s*([^\s}]+)/)
+          if used.any?
+            allowed = data.fetch(:query)[/by\s*[({]([^})]+)[})]/, 1]
+              .to_s.gsub(/["']/, "").split(/\s*,\s*/)
+              .map! { |w| %("#{w}.name") }
+            used.uniq.each do |match, group|
+              next if allowed.include?(group)
+              invalid!(
+                "#{match} used with #{group}, but can only be used with #{allowed.join(", ")}. " \
+                "Group the query by #{group.sub(".name", "").tr('"', "")} or change the #{match}"
+              )
+            end
           end
         end
       end

data/lib/kennel/models/slo.rb

@@ -67,6 +67,7 @@ module Kennel
       end
 
       def resolve_linked_tracking_ids!(id_map, **args)
+        return unless as_json[:monitor_ids] # ignore_default can remove it
         as_json[:monitor_ids] = as_json[:monitor_ids].map do |id|
           id.is_a?(String) ? resolve_link(id, :monitor, id_map, **args) : id
         end

data/lib/kennel/syncer.rb

@@ -38,7 +38,7 @@ module Kennel
     end
 
     def update
-      changed = (@create + @update).map { |_, e| e } unless @create.empty?
+      changed = (@create + @update).map { |_, e| e }
 
       @create.each do |_, e|
         e.resolve_linked_tracking_ids!({}, force: true)
@@ -139,7 +139,8 @@ module Kennel
     def ensure_all_ids_found
       @expected.each do |e|
         next unless id = e.id
-        raise "Unable to find existing #{e.class.api_resource} with id #{id}"
+        resource = e.class.api_resource
+        raise "Unable to find existing #{resource} with id #{id}\nIf the #{resource} was deleted, remove the `id: -> { #{e.id} }` line."
       end
     end
 
@@ -188,7 +189,7 @@ module Kennel
     end
 
     # Do not add tracking-id when working with existing ids on a branch,
-    # so resource do not get deleted fr:om merges to master.
+    # so resource do not get deleted from running an update on master (for example merge->CI).
     # Also make sure the diff still makes sense, by kicking out the now noop-update.
     #
     # Note: ideally we'd never add tracking in the first place, but at that point we do not know the diff yet

data/lib/kennel/template_variables.rb

@@ -16,18 +16,22 @@ module Kennel
 
     # check for queries that do not use the variables and would be misleading
     # TODO: do the same check for apm_query and their group_by
-    def validate_template_variables(data, key)
+    def validate_template_variables(data)
       variables = (data[:template_variables] || []).map { |v| "$#{v.fetch(:name)}" }
-      queries = data[key].flat_map do |widget|
+      return if variables.empty?
+
+      queries = data[:widgets].flat_map do |widget|
         ([widget] + (widget.dig(:definition, :widgets) || [])).flat_map { |w| widget_queries(w) }
       end.compact
-      bad = queries.grep_v(/(#{variables.map { |v| Regexp.escape(v) }.join("|")})\b/)
-      if bad.any?
-        invalid!(
-          "queries #{bad.join(", ")} must use the template variables #{variables.join(", ")}\n" \
-          "If that is not possible, add `validate: -> { false } # query foo in bar does not have baz tag`"
-        )
-      end
+
+      matches = variables.map { |v| Regexp.new "#{Regexp.escape(v)}\\b" }
+      queries.reject! { |q| matches.all? { |m| q.match? m } }
+      return if queries.empty?
+
+      invalid!(
+        "queries #{queries.join(", ")} must use the template variables #{variables.join(", ")}\n" \
+        "If that is not possible, add `validate: -> { false } # query foo in bar does not have baz tag`"
+      )
     end
 
     def widget_queries(widget)

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -180,6 +180,15 @@ end
   end
  ```
 
+### Updating existing resources with id
+
+Setting `id` makes kennel take over a manually created datadog resource.
+When manually creating to import, it is best to remove the `id` and delete the manually created resource.
+
+When an `id` is set and the original resource is deleted, kennel will fail to update,
+removing the `id` will cause kennel to create a new resource in datadog.
+
+
 ### Skipping validations
 
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and
@@ -192,6 +201,7 @@ To link to existing monitors via their kennel_id `projects kennel_id` + `:` + `m
  - Screens `uptime` widgets can use `monitor: {id: "foo:bar"}`
  - Screens `alert_graph` widgets can use `alert_id: "foo:bar"`
  - Monitors `composite` can use `query: -> { "%{foo:bar} || %{foo:baz}" }`
+ - Slos can use `monitor_ids: -> ["foo:bar"]` 
 
 ### Debugging changes locally
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.76.2
+  version: 1.78.2
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday