kennel 2.20.0 → 2.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d41a632f2e488aacff6253cdb1b161d628d7522ffd4b7ce3e006455b912ca16d
-  data.tar.gz: 0ffe3c8a9ec7d828aa397460af8f06af307f14e4a9740ff0e1a1693bc6c65950
+  metadata.gz: 9487ffad47b72d1a4e4781239ef3fbd500f806e5d63590c03326d7c6b689529e
+  data.tar.gz: ec5258bd90e47766deb06f71ab8041b3009f6242279a7d9d9bdede0d36da67ec
 SHA512:
-  metadata.gz: 8151f10629556f4b9dbad8b11c69e032fca8ebbd00a50e888482a2bb37659ce70028a8740606a90745de3b3808967165b4cc10c1faeac2ccce707bfc57cb8811
-  data.tar.gz: 6682f0c4815aacd911464f92c94f376110e52219c465f6f482dfbb85399b0ec4ea2b5d33d78ae394f753a04ef959b6b766325bd4bbc2f0b461dd172a24ed1349
+  metadata.gz: 2a02de737a11b72651a05c4fbf5bd6e8180cffb95f9d398696e70ee8c8a8c0217e264892582f842a22c9c73ab1f559035c23e1e8da0f74c14680bcf9757c0c63
+  data.tar.gz: 7a2ad8b0f2561a624d410453c601da3c39184625c0565ba5d78a51689bcde28a5a623e3791ee316f7cc3d4141f0d5482735f643ad46c60364f7122ae8e2e5adf

data/lib/kennel/api.rb

@@ -22,8 +22,9 @@ module Kennel
       @client = Faraday.new(url: url)
     end
 
-    def show(api_resource, id, params = {})
-      response = request :get, "/api/v1/#{api_resource}/#{id}", params: params
+    def show(api_resource, id, params = {}, ignore_404: false)
+      response = request :get, "/api/v1/#{api_resource}/#{id}", params: params, ignore_404: ignore_404
+      return if response.nil? # 404 that was ignored
       response = response.fetch(:data) if api_resource == "slo"
       response[:id] = response.delete(:public_id) if api_resource == "synthetics/tests"
       self.class.with_tracking(api_resource, response)
@@ -74,7 +75,12 @@ module Kennel
     # fill the resource with the full response from the `show` if `list` does not return it
     def fill_details!(api_resource, list)
       details_cache do |cache|
-        Utils.parallel(list) { |a| fill_detail!(api_resource, a, cache) }.sum
+        results = Utils.parallel(list) { |a| fill_detail!(api_resource, a, cache) }
+
+        # drop resources that were not found (race condition between listing and showing)
+        list.select!.with_index { |_, i| results[i][1] }
+
+        results.count { |uncached, _| uncached }
       end
     end
 
@@ -96,15 +102,16 @@ module Kennel
     end
 
     # Make diff work even though we cannot mass-fetch definitions
+    # @return [uncached, found]
     def fill_detail!(api_resource, a, cache)
-      uncached = 0
+      uncached = false
       args = [api_resource, a.fetch(:id)]
       full = cache.fetch(args, a.fetch(:modified_at)) do
-        uncached += 1
-        show(*args)
+        uncached = true
+        show(*args, ignore_404: true)
       end
-      a.merge!(full)
-      uncached
+      a.merge!(full) if full
+      [uncached, !!full]
     end
 
     def details_cache(&block)
@@ -117,29 +124,18 @@ module Kennel
       cached = (ENV["FORCE_GET_CACHE"] && method == :get)
 
       with_cache cached, path do
-        response = nil
-        tries.times do |i|
-          response = Utils.retry Faraday::ConnectionFailed, Faraday::TimeoutError, times: 2 do
-            @client.send(method, path) do |request|
-              request.body = JSON.generate(body) if body
-              request.headers["Content-type"] = "application/json"
-              request.headers["DD-API-KEY"] = @api_key
-              request.headers["DD-APPLICATION-KEY"] = @app_key
-            end
-          end
-
-          if response.status == 429
-            sleep_until_rate_limit_resets(response)
-            redo
+        response = request_with_retries(path, tries) do
+          @client.send(method, path) do |request|
+            request.body = JSON.generate(body) if body
+            request.headers["Content-type"] = "application/json"
+            request.headers["DD-API-KEY"] = @api_key
+            request.headers["DD-APPLICATION-KEY"] = @app_key
           end
-
-          last_try = (i == tries - 1)
-          break if last_try || response.status < 500
-          Kennel.err.puts "Retrying on server error #{response.status} for #{path}"
-          sleep retry_backoff_time(i)
         end
 
-        if !response.success? && (response.status != 404 || !ignore_404)
+        next if response.status == 404 && ignore_404
+
+        unless response.success?
           message = "Error #{response.status} during #{method.upcase} #{path}\n"
           message << "request:\n#{JSON.pretty_generate(body)}\nresponse:\n" if body
           message << response.body.encode(message.encoding, invalid: :replace, undef: :replace)
@@ -154,6 +150,28 @@ module Kennel
       end
     end
 
+    # retry on rate-limits and server errors, giving up after `tries` attempts
+    def request_with_retries(path, tries, &block)
+      raise ArgumentError, "tries must be > 0" if tries < 1
+      response = nil
+      tries.times do |i|
+        response = Utils.retry Faraday::ConnectionFailed, Faraday::TimeoutError, times: 2, &block
+
+        # we do not count 429s into the "tries", tries are only for real errors
+        # so this could loop forever if datadog consistently 429s
+        if response.status == 429
+          sleep_until_rate_limit_resets(response)
+          redo
+        end
+
+        last_try = (i == tries - 1)
+        break if last_try || response.status < 500
+        Kennel.err.puts "Retrying on server error #{response.status} for #{path}"
+        sleep retry_backoff_time(i)
+      end
+      response
+    end
+
     def sleep_until_rate_limit_resets(response)
       limit = response.headers["x-ratelimit-limit"]
       period = response.headers["x-ratelimit-period"]

data/lib/kennel/importer.rb

@@ -86,7 +86,14 @@ module Kennel
         end
       when "synthetics/tests"
         data[:locations] = :all if data[:locations].sort == Kennel::Models::SyntheticTest::LOCATIONS.sort
-      else
+      when "slo"
+        # sli_specification it is only used by datadog if the user switched to "Bad Events"
+        # otherwise user would be trying to set sli_specification but the slo does not change since query is used
+        if data.key?(:query) && data.key?(:sli_specification)
+          delete = (data.dig(:sli_specification, :count, :bad_events_formula) ? :query : :sli_specification)
+          data.delete delete
+        end
+      else # uncovered
         # noop
       end
 

data/lib/kennel/models/project.rb

@@ -10,10 +10,16 @@ module Kennel
 
       def self.file_location
         return @file_location if defined?(@file_location)
-        if (location = instance_methods(false).first)
-          @file_location = force_relative_path(instance_method(location).source_location.first)
+        methods = instance_methods(false)
+        if methods.any?
+          @file_location = methods.detect do |method|
+            location = instance_method(method).source_location.first
+            if (path = find_relative_path(location))
+              break path
+            end
+          end || raise("Unable to find file_location for #{name}")
         else
-          @file_location = nil
+          @file_location = nil # not sure if this is actually needed
         end
       end
 
@@ -29,11 +35,9 @@ module Kennel
 
       private
 
-      private_class_method def self.force_relative_path(path)
+      private_class_method def self.find_relative_path(path)
         return path unless File.absolute_path?(path)
-        path.dup.sub!("#{Bundler.root}/", "") ||
-          path.dup.sub!("#{Dir.pwd}/", "") ||
-          raise("Unable to make path #{path} relative with bundler root #{Bundler.root} or pwd #{Dir.pwd}")
+        path.dup.sub!("#{Bundler.root}/", "") || path.dup.sub!("#{Dir.pwd}/", "")
       end
 
       # hook for users to add custom filtering via `prepend`

data/lib/kennel/models/slo.rb

@@ -15,7 +15,8 @@ module Kennel
         groups: nil,
         monitor_ids: [],
         thresholds: [],
-        primary: nil
+        primary: nil,
+        sli_specification: nil
       }.freeze
 
       settings :type, :description, :thresholds, :query, :tags, :monitor_ids, :monitor_tags, :name, :groups, :sli_specification, :primary
@@ -27,7 +28,8 @@ module Kennel
         monitor_ids: -> { DEFAULTS.fetch(:monitor_ids) },
         thresholds: -> { DEFAULTS.fetch(:thresholds) },
         groups: -> { DEFAULTS.fetch(:groups) },
-        primary: -> { DEFAULTS.fetch(:primary) }
+        primary: -> { DEFAULTS.fetch(:primary) },
+        sli_specification: -> { DEFAULTS.fetch(:sli_specification) }
       )
 
       def build_json
@@ -50,9 +52,8 @@ module Kennel
           data[:target_threshold] = threshold[:target]
         end
 
-        # TODO: if user set sli_specification but we don't use it we should raise, but sadly we can't detect that easily
-        if type == "time_slice"
-          data[:sli_specification] = sli_specification
+        if (v = sli_specification)
+          data[:sli_specification] = v
         elsif (v = query)
           data[:query] = v
         end
@@ -102,10 +103,14 @@ module Kennel
           [:timeframe, :warning_threshold, :target_threshold].each { |k| actual.delete k }
         end
 
-        # datadog always sets this, but we only set it for time_slice, so discard it for everything else to avoid diff
-        if expected[:type] != "time_slice"
-          actual.delete :sli_specification
-        end
+        # discard deprecated query which stays in datadog forever when we are trying to set sli_specification
+        # (downgrading to query by setting sli_specification=nil is not supported in the api)
+        actual.delete :query if expected[:sli_specification]
+
+        # user set query so let's not worry about sli_specification even if this might be hiding bugs
+        # ideally we'd validate and tell the user that this will have no effect (see importer logic)
+        # but I'm not confident this will always be right
+        actual.delete :sli_specification if expected[:query]
 
         ignore_default(expected, actual, DEFAULTS)
       end

data/lib/kennel/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 2.20.0
+  version: 2.21.1
 platform: ruby
 authors:
 - Michael Grosser