kennel 1.98.0 → 1.98.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a596895475dbc4577d69916cb277fecfb45add58faf0bf1b6e06d314f161c3
-  data.tar.gz: 1f618cd4aa9a8eed2ad38ec067876e21f6d3f148d541a96bcc9afaa79619a48d
+  metadata.gz: 4d0b70ee90aae5a476b1e9a324e02346856e9d76881082d46a2b219efcfe2267
+  data.tar.gz: 86bc3f4777ec06a9b8c171e93ea95b50e9117a74283e3e6c1785d81e87889a4d
 SHA512:
-  metadata.gz: 4324951f97ef28dd0a5081231ea6aa676b81c3f405598dcf683d0ad5abc5dc346333d0e5029e84c5c742aa896b90aa1c11cd5891483f5c3bb5e67f0bec6ba6a8
-  data.tar.gz: 44e1c9af9868579db4497c2a9807a814bc6a78e49956c165d0b954fd4cbc0d6511ee046a43777354ef4f18c79ab70e5ae5061468ab5fd410aab5f55f1f219af2
+  metadata.gz: d0c6f38a11af7b0876a5637648fe16168aa4c5f6a16bba06f51322c240b02d520bd3abf566bf04b547df7431453d500f97be06b3a03da850ca5395b6ccf04bed
+  data.tar.gz: 45a77a1b2995f12da465a5b2ed64c6f21c93dba68b154367cf06c2a88202b648e223f0f1f80da7052e536b64f66a3cdc72a607fabfb913db3c7657f9e4000051

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 large sub-projects / large organiations
+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::Modesl::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/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kennel
-  VERSION = "1.98.0"
+  VERSION = "1.98.1"
 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 large sub-projects / large organiations
+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::Modesl::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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.98.0
+  version: 1.98.1
 platform: ruby
 authors:
 - Michael Grosser