kennel 1.97.1 → 1.98.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8d215839f60e7de711646bbe7fa33a6cb6e760abccf0b93eb1aa2bf4a7698d5
-  data.tar.gz: edee1d1856e9573bff15881653f3b6b1c0e28aeea923ce228a292a7d5e9bef77
+  metadata.gz: 1362ca60b0542b017fffad3e47bf1de8baf0b08950cb679a98760de51f0ef9c7
+  data.tar.gz: 7dacd36972ad7cad574d50236b6463a6be11082373b752c6f5f4530a29230a34
 SHA512:
-  metadata.gz: 488aaaff92f09f9176533e8103d86c4eda767cd0ec0d5f6b6982c14f5a0886e7f41ad1ddc9d4d8c2dd4b9906c5fbd90609071af89f4de8c800fa6b8687c171a1
-  data.tar.gz: 0011e0ba0634266a400f224e5855ffdff23142cc111af8acb4f808dfdda29ebf25a4718cf5b70e9222dc600cfdcbd5ae903ffc1d128d9ca2b1b5d475c8eff4c7
+  metadata.gz: '069a8adb906d55515b5b21db21ca7186ab1d132b370bd9319910719df4d641ce71729f613b52e764b42a4127d0b32d0da86fdf9f01d440df870c2ebb52168730'
+  data.tar.gz: ea453b3fc2afa94e9f9d916dcdec01b9e077816ea4fcb9c886e2b0a9e36c0c2a7623b4c63b0fd5c2014fa4e04198f42dd759d6335980df899c7bf0b6c8e7b42f

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/project.rb

@@ -2,7 +2,7 @@
 module Kennel
   module Models
     class Project < Base
-      settings :team, :parts, :tags, :mention
+      settings :team, :parts, :tags, :mention, :name, :kennel_id
       defaults(
         tags: -> { ["service:#{kennel_id}"] + team.tags },
         mention: -> { team.mention }

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.97.1"
+  VERSION = "1.98.3"
 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.97.1
+  version: 1.98.3
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday