kennel 1.73.0 → 1.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d99d149867f4ae8fefb711537a756a1d450ae396f5ac371b48f7db555b81d880
-  data.tar.gz: 6faa7915de915d57051a3722ba76eef833e464340dd14e211aedd6075ef13a9a
+  metadata.gz: a109923efbaef4c2beb6ccf136ea593a43c06b92e45add81d7f07fcbd594779e
+  data.tar.gz: 44a1b83e6b2e708eb3f91d98c19e90aeb663f4a6cf0926f296faae2b2570064d
 SHA512:
-  metadata.gz: aa4907af5eb82756b646cd4e89f6ff6b69832c6cd7ce20ceb18d2cf9da57913866c5237293916e6299baaa35a84254d941cf2dbd7a89ca7e2364f06b6b7e197f
-  data.tar.gz: f8beb5d100df9b205d7759e8f338fb5d01a267f5f22ab312f0793085aff78c0b1e51546cde2555f1f2cda34c62978ba0e60953ac21a87461411892cd52674806
+  metadata.gz: bfb64f23ff80eca8a8034a2bbb7c2cb08e867ec356879b85b487b093cea1109a5fca0da431355fdd597693a4da2b6a42231b99deb23398d562dfd74650448b64
+  data.tar.gz: e3034cd7215d04fd2020e6d12e27c1831f8e4167c3befaf24cd6725c81e9caafc71c7b14a8813d55fdd8439ae7ec4a4efa09a58a9c2d1c4616d302c77ed87a20

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
@@ -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.rb

@@ -29,7 +29,6 @@ require "kennel/models/project"
 require "kennel/models/team"
 
 module Kennel
-  MISSING_ID = 1
   class ValidationError < RuntimeError
   end
 

data/lib/kennel/importer.rb

@@ -40,11 +40,17 @@ module Kennel
           Kennel::Utils.parameterize(title)
         end
 
-      if resource == "monitor"
-        # flatten monitor options so they are all on the base
+      case resource
+      when "monitor"
+        # 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
@@ -55,11 +61,13 @@ module Kennel
         end
 
         data[:type] = "query alert" if data[:type] == "metric alert"
-      elsif resource == "dashboard"
+      when "dashboard"
         widgets = data[:widgets]&.flat_map { |widget| widget.dig(:definition, :widgets) || [widget] }
         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/dashboard.rb

@@ -132,7 +132,7 @@ module Kennel
         url[/\/dashboard\/([a-z\d-]+)/, 1]
       end
 
-      def resolve_linked_tracking_ids(id_map)
+      def resolve_linked_tracking_ids!(id_map, **args)
         widgets = as_json[:widgets].flat_map { |w| [w, *w.dig(:definition, :widgets) || []] }
         widgets.each do |widget|
           next unless definition = widget[:definition]
@@ -140,16 +140,16 @@ module Kennel
           when "uptime"
             if ids = definition[:monitor_ids]
               definition[:monitor_ids] = ids.map do |id|
-                tracking_id?(id) ? resolve_link(id, :monitor, id_map) : id
+                tracking_id?(id) ? resolve_link(id, :monitor, id_map, **args) : id
               end
             end
           when "alert_graph"
             if (id = definition[:alert_id]) && tracking_id?(id)
-              definition[:alert_id] = resolve_link(id, :monitor, id_map).to_s
+              definition[:alert_id] = resolve_link(id, :monitor, id_map, **args).to_s
             end
           when "slo"
             if (id = definition[:slo_id]) && tracking_id?(id)
-              definition[:slo_id] = resolve_link(id, :slo, id_map).to_s
+              definition[:slo_id] = resolve_link(id, :slo, id_map, **args).to_s
             end
           end
         end

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) },
@@ -103,11 +105,10 @@ module Kennel
         @as_json = data
       end
 
-      def resolve_linked_tracking_ids(id_map)
+      def resolve_linked_tracking_ids!(id_map, **args)
         if as_json[:type] == "composite"
           as_json[:query] = as_json[:query].gsub(/%\{(.*?)\}/) do
-            # need force here since it validates the id exists
-            resolve_link($1, :monitor, id_map, force: true)
+            resolve_link($1, :monitor, id_map, **args)
           end
         end
       end
@@ -120,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)
@@ -202,7 +203,7 @@ module Kennel
           # verify is_match uses available variables
           message = data.fetch(:message)
           used = message.scan(/{{\s*#is_match\s*"([a-zA-Z\d_.-]+).name"/).flatten.uniq
-          allowed = data.fetch(:query)[/by\s*[\({]([^\}\)]+)[}\)]/, 1].to_s.gsub(/["']/, "").split(/\s*,\s*/)
+          allowed = data.fetch(:query)[/by\s*[({]([^})]+)[})]/, 1].to_s.gsub(/["']/, "").split(/\s*,\s*/)
           unsupported = used - allowed
           if unsupported.any?
             invalid! "is_match used with #{unsupported}, but metric is only grouped by #{allowed}"

data/lib/kennel/models/record.rb

@@ -60,23 +60,22 @@ module Kennel
         "#{project.kennel_id}:#{kennel_id}"
       end
 
-      def resolve_linked_tracking_ids(*)
+      def resolve_linked_tracking_ids!(*)
       end
 
       private
 
-      def resolve_link(id, type, id_map, force: false)
-        found = id_map[id]
-        return found if found && found != :new
-        api_resource = self.class.api_resource
-
-        if found == :new
+      def resolve_link(id, type, id_map, force:)
+        value = id_map[id]
+        if value == :new
           if force
-            invalid! "#{api_resource.capitalize} #{id} will be created in the current run and can only be used after that"
+            # TODO: remove the need for this by sorting monitors by missing resolutions
+            invalid! "#{id} needs to already exist, try again"
           else
-            Kennel.err.puts "#{api_resource.capitalize} #{id} will be created in the current run, the next run will link it properly"
-            Kennel::MISSING_ID
+            id # will be re-resolved by syncer after the linked object was created
           end
+        elsif value
+          value
         else
           invalid! "Unable to find #{type} #{id} (does not exist and is not being created by the current run)"
         end

data/lib/kennel/models/slo.rb

@@ -66,9 +66,9 @@ module Kennel
         url[/\/slo\?slo_id=([a-z\d]+)/, 1]
       end
 
-      def resolve_linked_tracking_ids(id_map)
+      def resolve_linked_tracking_ids!(id_map, **args)
         as_json[:monitor_ids] = as_json[:monitor_ids].map do |id|
-          id.is_a?(String) ? resolve_link(id, :monitor, id_map) : id
+          id.is_a?(String) ? resolve_link(id, :monitor, id_map, **args) : id
         end
       end
 

data/lib/kennel/syncer.rb

@@ -38,12 +38,23 @@ module Kennel
     end
 
     def update
+      changed = (@create + @update).map { |_, e| e } unless @create.empty?
+
       @create.each do |_, e|
+        e.resolve_linked_tracking_ids!({}, force: true)
+
         reply = @api.create e.class.api_resource, e.as_json
-        Kennel.out.puts "Created #{e.class.api_resource} #{tracking_id(e.as_json)} #{e.url(reply.fetch(:id))}"
+        id = reply.fetch(:id)
+
+        # resolve ids we could previously no resolve
+        changed.delete e
+        resolve_linked_tracking_ids! from: [reply], to: changed
+
+        Kennel.out.puts "Created #{e.class.api_resource} #{tracking_id(e.as_json)} #{e.url(id)}"
       end
 
       @update.each do |id, e|
+        e.resolve_linked_tracking_ids!({}, force: true)
         @api.update e.class.api_resource, id, e.as_json
         Kennel.out.puts "Updated #{e.class.api_resource} #{tracking_id(e.as_json)} #{e.url(id)}"
       end
@@ -65,12 +76,10 @@ module Kennel
       @delete = []
 
       actual = Progress.progress("Downloading definitions") { download_definitions }
-
-      resolve_linked_tracking_ids actual
+      resolve_linked_tracking_ids! from: actual, to: @expected
+      filter_by_project! actual
 
       Progress.progress "Diffing" do
-        filter_by_project! actual
-
         items = actual.map do |a|
           e = matching_expected(a)
           if e && @expected.delete(e)
@@ -98,6 +107,7 @@ module Kennel
 
         ensure_all_ids_found
         @create = @expected.map { |e| [nil, e] }
+        @create.sort_by! { |_, e| -DELETE_ORDER.index(e.class.api_resource) }
       end
 
       @delete.sort_by! { |_, _, a| DELETE_ORDER.index a.fetch(:api_resource) }
@@ -178,7 +188,7 @@ module Kennel
     end
 
     # Do not add tracking-id when working with existing ids on a branch,
-    # so resource do not get deleted from merges to master.
+    # so resource do not get deleted fr:om merges to master.
     # Also make sure the diff still makes sense, by kicking out the now noop-update.
     #
     # Note: ideally we'd never add tracking in the first place, but at that point we do not know the diff yet
@@ -203,10 +213,10 @@ module Kennel
       end
     end
 
-    def resolve_linked_tracking_ids(actual)
-      map = actual.each_with_object({}) { |a, lookup| lookup[tracking_id(a)] = a.fetch(:id) }
-      @expected.each { |e| map[e.tracking_id] ||= :new }
-      @expected.each { |e| e.resolve_linked_tracking_ids(map) }
+    def resolve_linked_tracking_ids!(from:, to:)
+      map = from.each_with_object({}) { |a, lookup| lookup[tracking_id(a)] = a.fetch(:id) }
+      to.each { |e| map[e.tracking_id] ||= :new }
+      to.each { |e| e.resolve_linked_tracking_ids!(map, force: false) }
     end
 
     def filter_by_project!(definitions)

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.73.0"
+  VERSION = "1.76.0"
 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
@@ -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.73.0
+  version: 1.76.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday