kennel 1.74.0 → 1.76.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769ede5638522cc0c56394f0fde86207b88aad4ade1ff05e0360018972e52a55
-  data.tar.gz: 467dfab6d84ec29c1efbba1f7ab1df2fad3fd5767521a677c88b38c8bb8f2e19
+  metadata.gz: 950dfe31db52b682fe8158995404f60035aeee8be018884db0a9f8bb33900ce3
+  data.tar.gz: 17300f8517cdc04eee3f8a037e77e6f9b3a15f1646b09e2a1f2250a6e565fa85
 SHA512:
-  metadata.gz: 64f8dbae6ba9ea0d51be0c20a955a261ca026c760e77cf05e945b0a2514e6ef99527f8a00a9dc39abc053235fd76474435fb13d610e6e1ed1ce4e92d99e81ea9
-  data.tar.gz: 695f7f97b7355291d66b72423ac3c1adcadf804ced559aa35222c431c92198beca00fa625ebbad70ab105173ec8ca0b11eb4ec13a3dd19c04945fa9709821552
+  metadata.gz: 1356476dbc82439b5fb79f6041e3bf3fdb43b1696fb21da903fb25f9e43c6c33d4cdfb25e30042029f5751744bd0a8da43e8f330d62a3bd033f3cddb07a0ccb2
+  data.tar.gz: e6a7666696af4c04938f79d824442a4315efaf591d8a57be32ae065b528ce09a4fe65aad02650cce5ee422526a57713e3c8f887097964eb3c2e4f3bf9b042f94

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 CI build for your repo (travis and Github Actions supported)
+ - uncomment `.travis.yml` section for datadog updates on merge (TODO: example setup for Github Actions)
  - follow `Setup` in your repos Readme.md
 <!-- NOT IN -->
 
@@ -109,7 +150,7 @@ end
  - alternatively: `bundle exec rake generate` to only locally update the generated `json` files
  - review changes then `git commit`
  - make a PR ... get reviewed ... merge
- - datadog is updated by travis
+ - datadog is updated by CI
 
 ### Adding a new dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
@@ -164,7 +205,7 @@ to unblock use the `validate: -> { false }` option.
 
 ### Linking with kennel_ids
 
-To link to existing monitors via their kennel_id
+To link to existing monitors via their kennel_id `projects kennel_id` + `:` + `monitors kennel id`
 
  - Screens `uptime` widgets can use `monitor: {id: "foo:bar"}`
  - Screens `alert_graph` widgets can use `alert_id: "foo:bar"`
@@ -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,31 @@ 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
+
+`rake kennel:dump`
+focus on a single type: `TYPE=monitors`
+
+### Find all monitors with No-Data
+
+`rake kennel:nodata TAG=team:foo`
+
 <!-- NOT IN template/Readme.md -->
 
+
+## Development
+
 ### Integration testing
 
 ```Bash

data/lib/kennel/github_reporter.rb

@@ -15,8 +15,10 @@ module Kennel
     def initialize(token, git_sha)
       @token = token
       @git_sha = git_sha
-      origin = ENV["PROJECT_REPOSITORY"] || Utils.capture_sh("git remote -v").split("\n").first
-      @repo_part = origin[%r{github\.com[:/](.+?)(\.git|$)}, 1] || raise("no origin found")
+      @repo_part = ENV["GITHUB_REPOSITORY"] || begin
+        origin = ENV["PROJECT_REPOSITORY"] || Utils.capture_sh("git remote -v").split("\n").first
+        origin[%r{github\.com[:/](\S+?)(\.git|$)}, 1] || raise("no origin found in #{origin}")
+      end
     end
 
     def report(&block)

data/lib/kennel/importer.rb

@@ -42,10 +42,15 @@ module Kennel
 
       case resource
       when "monitor"
-        # flatten monitor options so they are all on the base
+        # flatten monitor options so they are all on the base which is how Monitor builds them
         data.merge!(data.delete(:options))
         data.merge!(data.delete(:thresholds) || {})
-        [:notify_no_data, :notify_audit].each { |k| data.delete(k) if data[k] } # monitor uses true by default
+
+        # clean up values that are the default
+        data.delete(:notify_no_data) if data[:notify_no_data] # Monitor uses true by default
+        data.delete(:notify_audit) unless data[:notify_audit] # Monitor uses false by default
+
+        # keep all values that are settable
         data = data.slice(*model.instance_methods)
 
         # make query use critical method if it matches
@@ -61,6 +66,8 @@ module Kennel
         widgets&.each { |widget| dry_up_query!(widget) }
       end
 
+      data.delete(:tags) if data[:tags] == [] # do not create super + [] call
+
       # simplify template_variables to array of string when possible
       if vars = data[:template_variables]
         vars.map! { |v| v[:default] == "*" && v[:prefix] == v[:name] ? v[:name] : v }

data/lib/kennel/models/monitor.rb

@@ -18,7 +18,9 @@ module Kennel
         new_host_delay: 300,
         timeout_h: 0,
         renotify_interval: 0,
-        no_data_timeframe: nil # this works out ok since if notify_no_data is on, it would never be nil
+        notify_audit: false,
+        no_data_timeframe: nil, # this works out ok since if notify_no_data is on, it would never be nil
+        groupby_simple_monitor: false
       }.freeze
       DEFAULT_ESCALATION_MESSAGE = ["", nil].freeze
 
@@ -35,9 +37,9 @@ module Kennel
         warning: -> { nil },
         ok: -> { nil },
         id: -> { nil },
-        notify_no_data: -> { true },
+        notify_no_data: -> { true }, # datadog sets this to false by default, but true is the safer
         no_data_timeframe: -> { 60 },
-        notify_audit: -> { true },
+        notify_audit: -> { MONITOR_OPTION_DEFAULTS.fetch(:notify_audit) },
         new_host_delay: -> { MONITOR_OPTION_DEFAULTS.fetch(:new_host_delay) },
         tags: -> { @project.tags },
         timeout_h: -> { MONITOR_OPTION_DEFAULTS.fetch(:timeout_h) },
@@ -119,7 +121,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/tasks.rb

@@ -68,15 +68,16 @@ namespace :kennel do
     Kennel.update
   end
 
-  desc "update if this is a push to the default branch, otherwise plan"
-  task :travis do
-    on_default_branch = (ENV["TRAVIS_BRANCH"] == (ENV["DEFAULT_BRANCH"] || "master"))
-    is_push = (ENV["TRAVIS_PULL_REQUEST"] == "false")
+  desc "update on push to the default branch, otherwise show plan"
+  task :ci do
+    branch = (ENV["TRAVIS_BRANCH"] || ENV["GITHUB_REF"]).to_s.sub(/^refs\/heads\//, "")
+    on_default_branch = (branch == (ENV["DEFAULT_BRANCH"] || "master"))
+    is_push = (ENV["TRAVIS_PULL_REQUEST"] == "false" || ENV["GITHUB_EVENT_NAME"] == "push")
     task_name =
       if on_default_branch && is_push
         "kennel:update_datadog"
       else
-        "kennel:plan" # show plan in travis logs
+        "kennel:plan" # show plan in CI logs
       end
 
     Rake::Task[task_name].invoke
@@ -123,10 +124,18 @@ namespace :kennel do
     Kennel.out.puts Kennel::Importer.new(Kennel.send(:api)).import(resource, id)
   end
 
-  desc "Dump ALL of datadog config as raw json ... useful for grep/search TYPE=slo|monitor|dashboard"
+  desc "Dump ALL of datadog config as raw json ... useful for grep/search [TYPE=slo|monitor|dashboard]"
   task dump: :environment do
-    Kennel.send(:api).list(ENV.fetch("TYPE")).each do |r|
-      Kennel.out.puts JSON.pretty_generate(r)
+    resources =
+      if type = ENV["TYPE"]
+        [type]
+      else
+        Kennel::Models::Record.subclasses.map(&:api_resource)
+      end
+    resources.each do |resource|
+      Kennel.send(:api).list(resource).each do |r|
+        Kennel.out.puts JSON.pretty_generate(r)
+      end
     end
   end
 

data/lib/kennel/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kennel
-  VERSION = "1.74.0"
+  VERSION = "1.76.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
@@ -91,7 +132,7 @@ end
  - alternatively: `bundle exec rake generate` to only locally update the generated `json` files
  - review changes then `git commit`
  - make a PR ... get reviewed ... merge
- - datadog is updated by travis
+ - datadog is updated by CI
 
 ### Adding a new dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
@@ -146,7 +187,7 @@ to unblock use the `validate: -> { false }` option.
 
 ### Linking with kennel_ids
 
-To link to existing monitors via their kennel_id
+To link to existing monitors via their kennel_id `projects kennel_id` + `:` + `monitors kennel id`
 
  - Screens `uptime` widgets can use `monitor: {id: "foo:bar"}`
  - Screens `alert_graph` widgets can use `alert_id: "foo:bar"`
@@ -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,23 @@ 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
+
+`rake kennel:dump`
+focus on a single type: `TYPE=monitors`
+
+### 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.76.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday