kennel 1.98.0 → 1.99.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a596895475dbc4577d69916cb277fecfb45add58faf0bf1b6e06d314f161c3
-  data.tar.gz: 1f618cd4aa9a8eed2ad38ec067876e21f6d3f148d541a96bcc9afaa79619a48d
+  metadata.gz: 0363ce2c85e194b4c6eca7e657a614d3eb0e27d7c0a5f4a55871bf39fc90f5f9
+  data.tar.gz: 075f01f5fa4f153f1a8c07ec000b7abf246e3c0dd9082d5709661240191b07f1
 SHA512:
-  metadata.gz: 4324951f97ef28dd0a5081231ea6aa676b81c3f405598dcf683d0ad5abc5dc346333d0e5029e84c5c742aa896b90aa1c11cd5891483f5c3bb5e67f0bec6ba6a8
-  data.tar.gz: 44e1c9af9868579db4497c2a9807a814bc6a78e49956c165d0b954fd4cbc0d6511ee046a43777354ef4f18c79ab70e5ae5061468ab5fd410aab5f55f1f219af2
+  metadata.gz: 6834defb05ea8844a19fdaa80a8e3cb7154305bbf3dbc6a66c24d76cc4b050305020c14ca7712a105d1514c421cf4a1f4674b9dfccc93b694e17daba8d8abf8b
+  data.tar.gz: 87f2c790faa21b2e63beaca026c565e6c940aa9dae0cc624b7060d81ed4b6cfce7894c77ccf56b60751a9fb3d1ed0b1dfc2c2c27a893ea88e0097b2d44138a05

data/Readme.md

@@ -16,7 +16,6 @@ Manage Datadog Monitors / Dashboards / Slos as code
 ![](template/github/screen.png?raw=true)
 
 ### Example code
-
 ```Ruby
 # teams/foo.rb
 module Teams
@@ -52,9 +51,7 @@ end
 ```
 
 <!-- NOT IN template/Readme.md  -->
-
 ## Installation
-
  - create a new private `kennel` repo for your organization (do not fork this repo)
  - use the template folder as starting point:
     ```Bash
@@ -70,14 +67,12 @@ end
 <!-- NOT IN -->
 
 ## Structure
-
  - `projects/` monitors/dashboards/etc scoped by project
  - `teams/` team definitions
  - `parts/` monitors/dashboards/etc that are used by multiple projects
  - `generated/` projects as json, to show current state and proposed changes in PRs
 
 ## Workflows
-
 <!-- ONLY IN template/Readme.md
 ### Setup
  - clone the repo
@@ -91,7 +86,6 @@ end
 -->
 
 ### Adding a team
-
  - `mention` is used for all team monitors via `super()`
  - `renotify_interval` is used for all team monitors (defaults to `0` / off)
  - `tags` is used for all team monitors/dashboards (defaults to `team:<team-name>`)
@@ -208,14 +202,30 @@ When manually creating to import, it is best to remove the `id` and delete the m
 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.
 
+### Organizing many projects
+Having many projects (and their sub-resources) can quickly get out of hand.
 
-### Skipping validations
+Use this class structure to keep things organized:
+```Ruby
+# projects/project_a/base.rb
+module ProjectA
+  class Base < Kennel::Models::Project
+    defaults(
+      kennel_id: -> { "project_a" },
+      ...
+
+# projects/project_a/monitors/foo_alert.rb
+module ProjectA
+  module Monitors
+    class FooAlert < Kennel::Models::Monitor
+      ...
+```
 
+### 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
 to unblock use the `validate: -> { false }` option.
 
 ### Linking resources with kennel_id
-
 Link resources with their kennel_id in the format `project kennel_id` + `:` + `resource kennel_id`,
 this should be used to create dependent resources like monitor + slos,
 so they can be created in a single update and can be re-created if any of them is deleted.
@@ -230,13 +240,11 @@ so they can be created in a single update and can be re-created if any of them i
 |Slo|monitor|`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 (monitors: remove mentions while debugging to avoid alert spam)
 
 ### Reuse
-
 Add to `parts/<folder>`.
 
 ```Ruby
@@ -266,15 +274,12 @@ end
 ## Helpers
 
 ### Listing un-muted alerts
-
 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
 
 ### Grepping through all of datadog
-
 ```Bash
 rake kennel:dump > tmp/dump
 cat tmp/dump | grep foo
@@ -289,7 +294,6 @@ https://foo.datadog.com/monitor/123
 ```
 
 ### Find all monitors with No-Data
-
 `rake kennel:nodata TAG=team:foo`
 
 <!-- NOT IN template/Readme.md -->
@@ -297,11 +301,9 @@ https://foo.datadog.com/monitor/123
 ## Development
 
 ### Benchmarking
-
 Setting `FORCE_GET_CACHE=true` will cache all get requests, which makes benchmarking improvements more reliable.
 
 ### Integration testing
-
 ```Bash
 rake play
 cd template

data/lib/kennel/models/monitor.rb

@@ -214,27 +214,47 @@ module Kennel
         end
 
         if ["query alert", "service check"].include?(type) # TODO: most likely more types need this
-          # verify is_match/is_exact_match uses available variables
-          message = data.fetch(:message)
-          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
+          validate_message_variables(data)
         end
 
         unless ALLOWED_PRIORITY_CLASSES.include?(priority.class)
           invalid! "priority needs to be an Integer"
         end
       end
+
+      # verify is_match/is_exact_match and {{foo.name}} uses available variables
+      def validate_message_variables(data)
+        message = data.fetch(:message)
+
+        used =
+          message.scan(/{{\s*(?:[#^]is(?:_exact)?_match)\s*"([^\s}]+)"/) + # {{#is_match "environment.name" "production"}}
+          message.scan(/{{\s*([^}]+\.name)\s*}}/) # Pod {{pod.name}} failed
+        return if used.empty?
+        used.flatten!(1)
+        used.uniq!
+
+        # TODO
+        # - also match without by
+        # - separate parsers for query and service
+        # - service must always allow `host`, maybe others
+        return unless match = data.fetch(:query).match(/(?:{([^}]*)}\s*)?by\s*[({]([^})]+)[})]/)
+
+        allowed =
+          match[1].to_s.split(/\s*,\s*/).map { |k| k.split(":", 2)[-2] } + # {a:b} -> a TODO: does not work for service check
+          match[2].to_s.gsub(/["']/, "").split(/\s*,\s*/) # by {a} -> a
+
+        allowed.compact!
+        allowed.uniq!
+        allowed.map! { |w| "#{w.tr('"', "")}.name" }
+
+        forbidden = used - allowed
+        return if forbidden.empty?
+
+        invalid! <<~MSG.rstrip
+          Used #{forbidden.join(", ")} in the message, but can only be used with #{allowed.join(", ")}.
+          Group or filter the query by #{forbidden.map { |f| f.sub(".name", "") }.join(", ")} to use it.
+        MSG
+      end
     end
   end
 end

data/lib/kennel/models/synthetic_test.rb

@@ -26,7 +26,7 @@ module Kennel
           type: type,
           subtype: subtype,
           options: options,
-          name: name,
+          name: "#{name}#{LOCK}",
           locations: locations == :all ? LOCATIONS : locations
         }
 

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -16,7 +16,6 @@ Manage Datadog Monitors / Dashboards / Slos as code
 ![](github/screen.png?raw=true)
 
 ### Example code
-
 ```Ruby
 # teams/foo.rb
 module Teams
@@ -53,14 +52,12 @@ end
 
 
 ## Structure
-
  - `projects/` monitors/dashboards/etc scoped by project
  - `teams/` team definitions
  - `parts/` monitors/dashboards/etc that are used by multiple projects
  - `generated/` projects as json, to show current state and proposed changes in PRs
 
 ## Workflows
-
 ### Setup
  - clone the repo
  - `gem install bundler && bundle install`
@@ -72,7 +69,6 @@ end
  - verify it works by running `rake plan`, it might show some diff, but should not crash
 
 ### Adding a team
-
  - `mention` is used for all team monitors via `super()`
  - `renotify_interval` is used for all team monitors (defaults to `0` / off)
  - `tags` is used for all team monitors/dashboards (defaults to `team:<team-name>`)
@@ -189,14 +185,30 @@ When manually creating to import, it is best to remove the `id` and delete the m
 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.
 
+### Organizing many projects
+Having many projects (and their sub-resources) can quickly get out of hand.
 
-### Skipping validations
+Use this class structure to keep things organized:
+```Ruby
+# projects/project_a/base.rb
+module ProjectA
+  class Base < Kennel::Models::Project
+    defaults(
+      kennel_id: -> { "project_a" },
+      ...
+
+# projects/project_a/monitors/foo_alert.rb
+module ProjectA
+  module Monitors
+    class FooAlert < Kennel::Models::Monitor
+      ...
+```
 
+### 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
 to unblock use the `validate: -> { false }` option.
 
 ### Linking resources with kennel_id
-
 Link resources with their kennel_id in the format `project kennel_id` + `:` + `resource kennel_id`,
 this should be used to create dependent resources like monitor + slos,
 so they can be created in a single update and can be re-created if any of them is deleted.
@@ -211,13 +223,11 @@ so they can be created in a single update and can be re-created if any of them i
 |Slo|monitor|`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 (monitors: remove mentions while debugging to avoid alert spam)
 
 ### Reuse
-
 Add to `parts/<folder>`.
 
 ```Ruby
@@ -247,15 +257,12 @@ end
 ## Helpers
 
 ### Listing un-muted alerts
-
 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
 
 ### Grepping through all of datadog
-
 ```Bash
 rake kennel:dump > tmp/dump
 cat tmp/dump | grep foo
@@ -270,6 +277,5 @@ https://foo.datadog.com/monitor/123
 ```
 
 ### Find all monitors with No-Data
-
 `rake kennel:nodata TAG=team:foo`
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.98.0
+  version: 1.99.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday