kennel 1.76.3 → 1.78.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17d17b2d23505b0d282fcab382a0bb43f452a132826c35a9fead4544631457db
-  data.tar.gz: d27f3363aafacb7885f833cf0c5d0d925d0b15f22a4d4aced5ff41377375b333
+  metadata.gz: 1606ccb73f8c7b4e4a0ac2d6c4cf7473d320ece51d38bab7d7b574366086476d
+  data.tar.gz: 1ce0a1b1edd186c0acaf392ca5dd668419ccf891388e197cdbb40b611ec6cfc4
 SHA512:
-  metadata.gz: f5558fd02af6b9662955686724c4c406e23393de685ca5db815f02470439d1ece2f446400b154fdd700ac7d71507500022f4b0c1527e9f0b8769fcf99edfe699
-  data.tar.gz: 3969b3ae9a00f29bc9882ba4395b019d70e3562cbc2b2c6beca72a65352167d47c80fab7b560183a62c312f24f2ec7b147cf30385877b63044e137d26b7e65a3
+  metadata.gz: f39e476825364d1d6eca54cefab1173008894c02bcb749457c2c2b3d8a0995553b6bfbc44f281e61f9e031f316d1a8c06bf81f2bfaefea618258bf536bfcb555
+  data.tar.gz: 8588a48b7a5886b04d4ba9030e1cd6b27fc7ba3271150edab3447d7aae977e3b47100218b5c1ac2597d4176f969194c326a28434d825311b69710ec14bcb8ef5

data/Readme.md

@@ -83,7 +83,7 @@ end
  - `gem install bundler && bundle install`
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
- - copy any `API Key` and add it to `.env` as `DATADOG_API_KEY`
+ - create a `API Key` or get an existing one from an admin, then add it to `.env` as `DATADOG_API_KEY`
  - find or create (check last page) your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=`
  - change the `DATADOG_SUBDOMAIN=app` in `.env` to your companies subdomain if you have one
  - verify it works by running `rake plan`, it might show some diff, but should not crash
@@ -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/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.3"
+  VERSION = "1.78.3"
 end

data/template/Readme.md

@@ -66,7 +66,7 @@ end
  - `gem install bundler && bundle install`
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
- - copy any `API Key` and add it to `.env` as `DATADOG_API_KEY`
+ - create a `API Key` or get an existing one from an admin, then add it to `.env` as `DATADOG_API_KEY`
  - find or create (check last page) your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=`
  - change the `DATADOG_SUBDOMAIN=app` in `.env` to your companies subdomain if you have one
  - verify it works by running `rake plan`, it might show some diff, but should not crash
@@ -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.3
+  version: 1.78.3
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday