kennel 1.74.0 → 1.74.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769ede5638522cc0c56394f0fde86207b88aad4ade1ff05e0360018972e52a55
-  data.tar.gz: 467dfab6d84ec29c1efbba1f7ab1df2fad3fd5767521a677c88b38c8bb8f2e19
+  metadata.gz: ca8f1880a71be912c4d52c43b378781001c20eaa1797c923b46c7fab0134a92e
+  data.tar.gz: 5147a4185090e027300f8e74dd07df1b76d1d3a70b03e97986ca7043fa7a60ab
 SHA512:
-  metadata.gz: 64f8dbae6ba9ea0d51be0c20a955a261ca026c760e77cf05e945b0a2514e6ef99527f8a00a9dc39abc053235fd76474435fb13d610e6e1ed1ce4e92d99e81ea9
-  data.tar.gz: 695f7f97b7355291d66b72423ac3c1adcadf804ced559aa35222c431c92198beca00fa625ebbad70ab105173ec8ca0b11eb4ec13a3dd19c04945fa9709821552
+  metadata.gz: 13cef2ac877cf523b13d34ccb969376af5ef451bca24e7484536785e8ebce86e713d2cd4572126cad0fdd62b7ee3d7d39c23563302d697570d18925ba1820e89
+  data.tar.gz: 9865461cb7c846ffabb03b5619ec7aa5833c4f7db1389efc834020b33f25246b4a6e39616df4ecd6cd0846c621a1d9e23d1672c243e43478ec4d747aeb28f36c

data/Readme.md

@@ -1,17 +1,58 @@
-# Kennel
-
 ![](template/github/cage.jpg?raw=true)
 
-Manage datadog monitors/dashboards/slos as code
+Manage Datadog Monitors / Dashboards / Slos as code
 
- - Documented, reusable, and searchable
- - Changes are PR reviewed and auditable
+ - DRY, searchable, audited, documented
+ - Changes are PR reviewed and applied on merge
  - Updating shows diff before applying
- - Automated import of existing monitors/dashboards/slos
+ - Automated import of existing resources
+ - Resources are grouped into projects that belong to teams and inherit tags
+ - No copy-pasting of ids to create new resources
+ - Automated cleanup when removing code
+ - [Helpers](#helpers) for automating common tasks
+ 
+### Applying changes
 
 ![](template/github/screen.png?raw=true)
+
+### Example code
+
+```Ruby
+# teams/foo.rb
+module Teams
+  class Foo < Kennel::Models::Team
+    defaults(mention: -> { "@slack-my-team" })
+  end
+end
+
+# projects/bar.rb
+class Bar < Kennel::Models::Project
+  defaults(
+    team: -> { Teams::Foo.new }, # use mention and tags from the team
+    parts: -> {
+      [
+        Kennel::Models::Monitor.new(
+          self, # the current project
+          type: -> { "query alert" },
+          kennel_id: -> { "load-too-high" }, # pick a unique name
+          name: -> { "Foobar Load too high" }, # nice descriptive name that will show up in alerts and emails
+          message: -> {
+            <<~TEXT
+              This is bad!
+              #{super()} # inserts mention from team
+            TEXT
+          },
+          query: -> { "avg(last_5m):avg:system.load.5{hostgroup:api} by {pod} > #{critical}" },
+          critical: -> { 20 }
+        )
+      ]
+    }
+  )
+end
+```
+
 <!-- NOT IN template/Readme.md  -->
-## Install
+## Installation
 
  - create a new private `kennel` repo for your organization (do not fork this repo)
  - use the template folder as starting point:
@@ -22,8 +63,8 @@ Manage datadog monitors/dashboards/slos as code
     cd kennel && git add . && git commit -m 'initial'
     ```
  - add a basic projects and teams so others can copy-paste to get started
- - setup travis build for your repo
- - uncomment `.travis.yml` section for automated PR planing and datadog updates on merge
+ - setup travis (CI) build for your repo
+ - uncomment `.travis.yml` section for datadog updates on merge
  - follow `Setup` in your repos Readme.md
 <!-- NOT IN -->
 
@@ -176,25 +217,7 @@ To link to existing monitors via their kennel_id
  - 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
 
-### 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
-
-`TYPE=monitor rake kennel:dump`
-
-### Find all monitors with No-Data
-
-`rake kennel:nodata TAG=team:foo`
-
-## Examples
-
-### Reusable monitors/dashes/etc
+### Reuse
 
 Add to `parts/<folder>`.
 
@@ -221,8 +244,30 @@ class Database < Kennel::Models::Project
   )
 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
+
+`TYPE=monitor rake kennel:dump`
+
+### Find all monitors with No-Data
+
+`rake kennel:nodata TAG=team:foo`
+
 <!-- NOT IN template/Readme.md -->
 
+
+## Development
+
 ### Integration testing
 
 ```Bash

data/lib/kennel/models/monitor.rb

@@ -25,7 +25,7 @@ module Kennel
       settings(
         :query, :name, :message, :escalation_message, :critical, :type, :renotify_interval, :warning, :timeout_h, :evaluation_delay,
         :ok, :no_data_timeframe, :notify_no_data, :notify_audit, :tags, :critical_recovery, :warning_recovery, :require_full_window,
-        :threshold_windows, :new_host_delay
+        :threshold_windows, :new_host_delay, :groupby_simple_monitor
       )
 
       defaults(
@@ -44,7 +44,8 @@ module Kennel
         evaluation_delay: -> { MONITOR_OPTION_DEFAULTS.fetch(:evaluation_delay) },
         critical_recovery: -> { nil },
         warning_recovery: -> { nil },
-        threshold_windows: -> { nil }
+        threshold_windows: -> { nil },
+        groupby_simple_monitor: -> { nil }
       )
 
       def as_json
@@ -94,6 +95,11 @@ module Kennel
           end
         end
 
+        # option randomly pops up and cannot be removed
+        unless (group = groupby_simple_monitor).nil?
+          options[:groupby_simple_monitor] = group
+        end
+
         if windows = threshold_windows
           options[:threshold_windows] = windows
         end
@@ -119,7 +125,7 @@ module Kennel
         Utils.path_to_url "/monitors##{id}/edit"
       end
 
-      # datadog uses both / and # as separator in it's links
+      # datadog uses / for show and # for edit as separator in it's links
       def self.parse_url(url)
         return unless id = url[/\/monitors[\/#](\d+)/, 1]
         Integer(id)

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -1,16 +1,57 @@
-# Kennel
-
 ![](github/cage.jpg?raw=true)
 
-Manage datadog monitors/dashboards/slos as code
+Manage Datadog Monitors / Dashboards / Slos as code
 
- - Documented, reusable, and searchable
- - Changes are PR reviewed and auditable
+ - DRY, searchable, audited, documented
+ - Changes are PR reviewed and applied on merge
  - Updating shows diff before applying
- - Automated import of existing monitors/dashboards/slos
+ - Automated import of existing resources
+ - Resources are grouped into projects that belong to teams and inherit tags
+ - No copy-pasting of ids to create new resources
+ - Automated cleanup when removing code
+ - [Helpers](#helpers) for automating common tasks
+ 
+### Applying changes
 
 ![](github/screen.png?raw=true)
 
+### Example code
+
+```Ruby
+# teams/foo.rb
+module Teams
+  class Foo < Kennel::Models::Team
+    defaults(mention: -> { "@slack-my-team" })
+  end
+end
+
+# projects/bar.rb
+class Bar < Kennel::Models::Project
+  defaults(
+    team: -> { Teams::Foo.new }, # use mention and tags from the team
+    parts: -> {
+      [
+        Kennel::Models::Monitor.new(
+          self, # the current project
+          type: -> { "query alert" },
+          kennel_id: -> { "load-too-high" }, # pick a unique name
+          name: -> { "Foobar Load too high" }, # nice descriptive name that will show up in alerts and emails
+          message: -> {
+            <<~TEXT
+              This is bad!
+              #{super()} # inserts mention from team
+            TEXT
+          },
+          query: -> { "avg(last_5m):avg:system.load.5{hostgroup:api} by {pod} > #{critical}" },
+          critical: -> { 20 }
+        )
+      ]
+    }
+  )
+end
+```
+
+
 ## Structure
 
  - `projects/` monitors/dashboards/etc scoped by project
@@ -158,25 +199,7 @@ To link to existing monitors via their kennel_id
  - 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
 
-### 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
-
-`TYPE=monitor rake kennel:dump`
-
-### Find all monitors with No-Data
-
-`rake kennel:nodata TAG=team:foo`
-
-## Examples
-
-### Reusable monitors/dashes/etc
+### Reuse
 
 Add to `parts/<folder>`.
 
@@ -203,3 +226,22 @@ class Database < Kennel::Models::Project
   )
 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
+
+`TYPE=monitor rake kennel:dump`
+
+### 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.74.0
+  version: 1.74.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday