kennel 1.62.0 → 1.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46e59b9fbb4e26336ff51f94150419fbe3dfdcc6754c05f425b6ce7059c03bb5
-  data.tar.gz: 10e2eed990407521ca3ae5923387f7e893d52e98af8e739b565ca6cd85c50d2a
+  metadata.gz: 0bfed774a67cfbd29eea6800403e1a61c16a182e96ea69fe730770c2e4fa392c
+  data.tar.gz: 2bd236d4dc087fc81e39282d5b7efa26b3422565fd75a62a601966a02a6c8a8c
 SHA512:
-  metadata.gz: 31de1f04bce918536b6c752e73e06e398e9ecef92bf6b67265fd79939f1e23f278f549ac668f88f7391626c248d6db8b2a8193ca3cc19c69bb2a080a910a0276
-  data.tar.gz: ace9e229690a761b0b11e7b95a83a24fd93c777ddd617deb1fd7a31c58652126bc4993ca0715f4a8d8546e5190fd41d814593ac337e4f2ea58617831c2f2d704
+  metadata.gz: 47944bbb4119eb15b998aaacafa53a2738b18031017ba8b0688f5470ce4067e263360f77b9ebd18348398ce328fb75b99ed5805a2ab3d4df56e6fb38180aa955
+  data.tar.gz: 575bc37d35aec741c6479c1f8370992305f1c8f17058d52cfd257f7f638e3663954c88e5d14cf2d045fcbd6ddd21bb573039032ff6171f3f0e30dc9bf381a840

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

@@ -8,7 +8,7 @@ module Kennel
       QUERY_INTERVALS = ["1m", "5m", "10m", "15m", "30m", "1h", "2h", "4h", "1d"].freeze
       OPTIONAL_SERVICE_CHECK_THRESHOLDS = [:ok, :warning].freeze
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
-        :multi, :matching_downtimes, :overall_state_modified, :overall_state
+        :multi, :matching_downtimes, :overall_state_modified, :overall_state, :restricted_roles
       ]
 
       # defaults that datadog uses when options are not sent, so safe to leave out if our values match their defaults
@@ -54,7 +54,6 @@ module Kennel
           query: query.strip,
           message: message.strip,
           tags: tags.uniq,
-          restricted_roles: nil,
           options: {
             timeout_h: timeout_h,
             notify_no_data: notify_no_data,
@@ -133,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/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.0"
+  VERSION = "1.66.0"
 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.0
+  version: 1.66.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-02-21 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