kennel 1.76.1 → 1.78.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 950dfe31db52b682fe8158995404f60035aeee8be018884db0a9f8bb33900ce3
-  data.tar.gz: 17300f8517cdc04eee3f8a037e77e6f9b3a15f1646b09e2a1f2250a6e565fa85
+  metadata.gz: d12735939d42da2f660773d9ca734a279fdc5c29b6619f6722b163f07f299236
+  data.tar.gz: 14f40ae5314abc2ff5b58672ad096a9d1898b793c1dee490a45d9deefc67e513
 SHA512:
-  metadata.gz: 1356476dbc82439b5fb79f6041e3bf3fdb43b1696fb21da903fb25f9e43c6c33d4cdfb25e30042029f5751744bd0a8da43e8f330d62a3bd033f3cddb07a0ccb2
-  data.tar.gz: e6a7666696af4c04938f79d824442a4315efaf591d8a57be32ae065b528ce09a4fe65aad02650cce5ee422526a57713e3c8f887097964eb3c2e4f3bf9b042f94
+  metadata.gz: b5340adfc8b564f648caa8f656b8b10fe9cd48177a6b15e21944adac24209344aeb81aa0bc5190e7a5997e8ebc0dc49af0304daf947abf99112dc8d56f6a9485
+  data.tar.gz: 368fb6dffbc42be889f8692b876e867818cde5eefd04b982151efc7d9dc74a378a046f12a7764f448df5818ebca950e55f22e36d45822c68ed3e8a3442850162

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,12 +219,13 @@ 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
 
  - rebase on updated `master` to not undo other changes
  - figure out project name by converting the class name to snake-case
- - run `PROJECT=foo bundle exec rake kennel:update_datadog` to test changes for a single project
+ - run `PROJECT=foo bundle exec rake kennel:update_datadog` to test changes for a single project (monitors: remove mentions while debugging to avoid alert spam)
 
 ### Reuse
 

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/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,17 @@ 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(", ")}. Add more groupings or fix the #{match}"
+            end
           end
         end
       end

data/lib/kennel/models/slo.rb

@@ -63,10 +63,11 @@ module Kennel
       end
 
       def self.parse_url(url)
-        url[/\/slo\?slo_id=([a-z\d]+)/, 1]
+        url[/\/slo\?.*slo_id=([a-z\d]+)/, 1]
       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/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kennel
-  VERSION = "1.76.1"
+  VERSION = "1.78.1"
 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,12 +201,13 @@ 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
 
  - rebase on updated `master` to not undo other changes
  - figure out project name by converting the class name to snake-case
- - run `PROJECT=foo bundle exec rake kennel:update_datadog` to test changes for a single project
+ - run `PROJECT=foo bundle exec rake kennel:update_datadog` to test changes for a single project (monitors: remove mentions while debugging to avoid alert spam)
 
 ### Reuse
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.76.1
+  version: 1.78.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday