kennel 1.74.1 → 1.76.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca8f1880a71be912c4d52c43b378781001c20eaa1797c923b46c7fab0134a92e
-  data.tar.gz: 5147a4185090e027300f8e74dd07df1b76d1d3a70b03e97986ca7043fa7a60ab
+  metadata.gz: f414fdeaa15b105fde4fa0cbcf70956246bcafafd31aa3d4a48dbed37e3a31ff
+  data.tar.gz: b29014f8c562d772429a09ede70ad92d7ad892f4359628c66e24535cd50e4232
 SHA512:
-  metadata.gz: 13cef2ac877cf523b13d34ccb969376af5ef451bca24e7484536785e8ebce86e713d2cd4572126cad0fdd62b7ee3d7d39c23563302d697570d18925ba1820e89
-  data.tar.gz: 9865461cb7c846ffabb03b5619ec7aa5833c4f7db1389efc834020b33f25246b4a6e39616df4ecd6cd0846c621a1d9e23d1672c243e43478ec4d747aeb28f36c
+  metadata.gz: 2cb2504d598f41a5fb3f75431cadaf58749b4d8d381d8c87f89125c703c8122c916ceb3064e25332d2f8f0c8b9f0b69b28d76f1c71000d515e7e027e2df118da
+  data.tar.gz: 75f379f50a897704e3bb488960920ce2e11e79249d32ad77b851d05ed6ed5c886ce060869c1bad6474b383fdb4ebcb8c117b051bf1e88b9fa590d96cede73284

data/Readme.md

@@ -63,8 +63,8 @@ end
     cd kennel && git add . && git commit -m 'initial'
     ```
  - add a basic projects and teams so others can copy-paste to get started
- - setup travis (CI) build for your repo
- - uncomment `.travis.yml` section for 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 -->
 
@@ -150,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
@@ -205,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"`
@@ -215,7 +215,7 @@ To link to existing monitors via their kennel_id
 
  - 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
+ - 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
 
@@ -257,7 +257,8 @@ Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a
 
 ### Grepping through all of datadog
 
-`TYPE=monitor rake kennel:dump`
+`rake kennel:dump`
+focus on a single type: `TYPE=monitors`
 
 ### Find all monitors with No-Data
 

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,14 +18,16 @@ 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
 
       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, :groupby_simple_monitor
+        :threshold_windows, :new_host_delay
       )
 
       defaults(
@@ -35,17 +37,16 @@ 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) },
         evaluation_delay: -> { MONITOR_OPTION_DEFAULTS.fetch(:evaluation_delay) },
         critical_recovery: -> { nil },
         warning_recovery: -> { nil },
-        threshold_windows: -> { nil },
-        groupby_simple_monitor: -> { nil }
+        threshold_windows: -> { nil }
       )
 
       def as_json
@@ -95,11 +96,6 @@ 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

data/lib/kennel/models/slo.rb

@@ -63,7 +63,7 @@ module Kennel
       end
 
       def self.parse_url(url)
-        url[/\/slo\?slo_id=([a-z\d]+)/, 1]
+        url[/\/slo\?.*slo_id=([a-z\d]+)/, 1]
       end
 
       def resolve_linked_tracking_ids!(id_map, **args)

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.1"
+  VERSION = "1.76.2"
 end

data/template/Readme.md

@@ -132,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
@@ -187,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"`
@@ -197,7 +197,7 @@ To link to existing monitors via their kennel_id
 
  - 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
+ - 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
 
@@ -239,7 +239,8 @@ Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a
 
 ### Grepping through all of datadog
 
-`TYPE=monitor rake kennel:dump`
+`rake kennel:dump`
+focus on a single type: `TYPE=monitors`
 
 ### Find all monitors with No-Data
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.74.1
+  version: 1.76.2
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday