kennel 1.62.1 → 1.66.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5ad82b24cba6eef0e7733dac0b4c0f51e54fb728338112c8505ddf84284df23
-  data.tar.gz: c6bf110be71f0296d352797ed7f8ac364dfa18e580a632ef1ad21e427da65111
+  metadata.gz: 97bb44fcc344bb6e906a6cd364ccbd8e00cdbe499257b349ed3b30190087fa58
+  data.tar.gz: 17db69d7a4de5599aed07dac93db2563943be29bfa456099f330efd5f0dc2c55
 SHA512:
-  metadata.gz: 85b2929f6e429c64be88d96dbbfb76f057fa56d1dea6eb81668e728b214ff4cd91a6345899199f95034c75414444519d6d7f585174687866f99c20481e547172
-  data.tar.gz: 55412cc487dffdf9de2e4f715fb3773690591753793fe2ea799677f853b3c42348e1fbc6ed13a8e7adc3d45d0fd3ac9141a825ef10d4a2066cdb58350e3632ff
+  metadata.gz: 7385074e9d4d3b2e1868f501d74850510f9e6412474a55b8bb3b863c637e02bd4ca2ba065429c1566b86044ef66978e4e4aabff25bb6a3501d22cf388c009f79
+  data.tar.gz: 62c6acd58e137e577016e8f79b690a85ab9637ffab527382e94fdbf07cd752b767371ed468e9413f154c0d8dd61198c105be37a968b86ce814013d84c5ba86c1

data/Readme.md

@@ -2,11 +2,12 @@
 
 ![](template/github/cage.jpg?raw=true)
 
-Keep datadog monitors/dashboards/etc in version control, avoid chaotic management via UI.
+Manage datadog monitors/dashboards/slos as code
 
- - Documented, reusable, automated, and searchable configuration
+ - Documented, reusable, and searchable
  - Changes are PR reviewed and auditable
- - Automated deletion when removed from code
+ - Updating shows diff before applying
+ - Automated import of existing monitors/dashboards/slos
 
 ![](template/github/screen.png?raw=true)
 <!-- NOT IN template/Readme.md  -->
@@ -183,6 +184,14 @@ Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a
 
 `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
@@ -219,10 +228,10 @@ end
 ```Bash
 rake play
 cd template
-rake kennel:plan
+rake plan
 ```
 
-Then make changes to play around, do not commit changes and make sure to revert with a `rake kennel:update` after deleting everything.
+Then make changes to play around, do not commit changes and make sure to revert with a `rake kennel:update_datadog` after deleting everything.
 
 To make changes via the UI, make a new free datadog account and use it's credentaisl instead.
 

data/lib/kennel/api.rb

@@ -43,12 +43,12 @@ module Kennel
     end
 
     def delete(api_resource, id)
-      request :delete, "/api/v1/#{api_resource}/#{id}"
+      request :delete, "/api/v1/#{api_resource}/#{id}", ignore_404: true
     end
 
     private
 
-    def request(method, path, body: nil, params: {})
+    def request(method, path, body: nil, params: {}, ignore_404: false)
       params = params.merge(application_key: @app_key, api_key: @api_key)
       query = Faraday::FlatParamsEncoder.encode(params)
       response = nil
@@ -66,7 +66,7 @@ module Kennel
         Kennel.err.puts "Retrying on server error #{response.status} for #{path}"
       end
 
-      unless response.success?
+      if !response.success? && (response.status != 404 || !ignore_404)
         message = +"Error #{response.status} during #{method.upcase} #{path}\n"
         message << "request:\n#{JSON.pretty_generate(body)}\nresponse:\n" if body
         message << response.body

data/lib/kennel/file_cache.rb

@@ -32,11 +32,12 @@ module Kennel
     private
 
     def load_data
-      @data = begin
-        Marshal.load(File.read(@file)) # rubocop:disable Security/MarshalLoad
-      rescue StandardError
-        {}
-      end
+      @data =
+        begin
+          Marshal.load(File.read(@file)) # rubocop:disable Security/MarshalLoad
+        rescue StandardError
+          {}
+        end
     end
 
     def persist

data/lib/kennel/github_reporter.rb

@@ -7,13 +7,13 @@ module Kennel
     class << self
       def report(token, &block)
         return yield unless token
-        new(token).report(&block)
+        new(token, Utils.capture_sh("git rev-parse HEAD").strip).report(&block)
       end
     end
 
-    def initialize(token)
+    def initialize(token, git_sha)
       @token = token
-      @git_sha = Utils.capture_sh("git rev-parse HEAD").strip
+      @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")
     end
@@ -27,8 +27,6 @@ module Kennel
       comment "```\n#{output || "Error"}\n```"
     end
 
-    private
-
     # https://developer.github.com/v3/repos/comments/#create-a-commit-comment
     def comment(body)
       # truncate to maximum allowed comment size for github to avoid 422
@@ -39,6 +37,8 @@ module Kennel
       post "commits/#{@git_sha}/comments", body: body
     end
 
+    private
+
     def post(path, data)
       url = "https://api.github.com/repos/#{@repo_part}/#{path}"
       response = Faraday.post(url, data.to_json, authorization: "token #{@token}")

data/lib/kennel/models/base.rb

@@ -21,7 +21,7 @@ module Kennel
         self.class.name
       end
 
-      def to_json
+      def to_json # rubocop:disable Lint/ToJSON
         raise NotImplementedError, "Use as_json"
       end
     end

data/lib/kennel/models/monitor.rb

@@ -132,7 +132,7 @@ module Kennel
 
         case actual[:type]
         when "event alert"
-          # setting 0 results in thresholds not getting returned from the api
+          # setting nothing results in thresholds not getting returned from the api
           options[:thresholds] ||= { critical: 0 }
 
         when "service check"

data/lib/kennel/models/record.rb

@@ -42,7 +42,10 @@ module Kennel
 
         self.class.send(:normalize, expected, actual)
 
-        HashDiff.diff(actual, expected, use_lcs: false)
+        # strict: ignore Integer vs Float
+        # similarity: show diff when not 100% similar
+        # use_lcs: saner output
+        Hashdiff.diff(actual, expected, use_lcs: false, strict: false, similarity: 1)
       end
 
       def tracking_id

data/lib/kennel/models/slo.rb

@@ -6,11 +6,12 @@ module Kennel
       DEFAULTS = {
         description: nil,
         query: nil,
+        groups: nil,
         monitor_ids: [],
         thresholds: []
       }.freeze
 
-      settings :type, :description, :thresholds, :query, :tags, :monitor_ids, :monitor_tags, :name
+      settings :type, :description, :thresholds, :query, :tags, :monitor_ids, :monitor_tags, :name, :groups
 
       defaults(
         id: -> { nil },
@@ -18,7 +19,8 @@ module Kennel
         query: -> { DEFAULTS.fetch(:query) },
         description: -> { DEFAULTS.fetch(:description) },
         monitor_ids: -> { DEFAULTS.fetch(:monitor_ids) },
-        thresholds: -> { DEFAULTS.fetch(:thresholds) }
+        thresholds: -> { DEFAULTS.fetch(:thresholds) },
+        groups: -> { DEFAULTS.fetch(:groups) }
       )
 
       def initialize(*)
@@ -39,8 +41,15 @@ module Kennel
           type: type
         }
 
-        data[:query] = query if query
-        data[:id] = id if id
+        if v = query
+          data[:query] = v
+        end
+        if v = id
+          data[:id] = v
+        end
+        if v = groups
+          data[:groups] = v
+        end
 
         @as_json = data
       end

data/lib/kennel/syncer.rb

@@ -3,6 +3,7 @@ module Kennel
   class Syncer
     CACHE_FILE = "tmp/cache/details" # keep in sync with .travis.yml caching
     TRACKING_FIELDS = [:message, :description].freeze
+    DELETE_ORDER = ["dashboard", "slo", "monitor"].freeze # dashboards references monitors + slos, slos reference monitors
 
     def initialize(api, expected, project: nil)
       @api = api
@@ -98,6 +99,8 @@ module Kennel
         ensure_all_ids_found
         @create = @expected.map { |e| [nil, e] }
       end
+
+      @delete.sort_by! { |_, _, a| DELETE_ORDER.index a.fetch(:api_resource) }
     end
 
     # Make diff work even though we cannot mass-fetch definitions

data/lib/kennel/tasks.rb

@@ -111,14 +111,21 @@ namespace :kennel do
     end
   end
 
-  desc "Convert existing resources to copy-pastable definitions to import existing resources RESOURCE=dash ID=1234"
+  desc "Convert existing resources to copy-pastable definitions to import existing resources RESOURCE=[dashboard,monitor,slo] ID=1234"
   task import: :environment do
-    resource = ENV["RESOURCE"] || Kennel::Tasks.abort("Call with RESOURCE=dash") # TODO: add others
+    resource = ENV["RESOURCE"] || Kennel::Tasks.abort("Call with RESOURCE=dashboard or monitor or slo")
     id = ENV["ID"] || Kennel::Tasks.abort("Call with ID=1234")
     id = Integer(id) if id =~ /^\d+$/ # dashboards can have alphanumeric ids
     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"
+  task dump: :environment do
+    Kennel.send(:api).list(ENV.fetch("TYPE")).each do |r|
+      Kennel.out.puts JSON.pretty_generate(r)
+    end
+  end
+
   task :environment do
     require "kennel"
     gem "dotenv"

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -2,11 +2,12 @@
 
 ![](github/cage.jpg?raw=true)
 
-Keep datadog monitors/dashboards/etc in version control, avoid chaotic management via UI.
+Manage datadog monitors/dashboards/slos as code
 
- - Documented, reusable, automated, and searchable configuration
+ - Documented, reusable, and searchable
  - Changes are PR reviewed and auditable
- - Automated deletion when removed from code
+ - Updating shows diff before applying
+ - Automated import of existing monitors/dashboards/slos
 
 ![](github/screen.png?raw=true)
 
@@ -165,6 +166,14 @@ Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a
 
 `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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.62.1
+  version: 1.66.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent-retry
   requirement: !ruby/object:Gem::Requirement