kennel 1.60.1 → 1.61.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d555de2128376fcfe551b2e7d95dfb724c819adc9f5b401ec155ba2d278607cb
-  data.tar.gz: bfa004cefabf58c7328118878e0cc1ffc10253098a6176b53ce3ae295adc41c6
+  metadata.gz: ddec1e52bda24d78c94d0cce08ef0ec8069831d21fa7b5c708093173a1d17b7e
+  data.tar.gz: 16ce37dbdfdd641b358800a75c54183a430d31536e68ad821fe48d7ada98129c
 SHA512:
-  metadata.gz: c02a3b3308a8149e8efb2f014156017dc8e1cf8a5ad06507939f69f807c463f295554cddf48affd07706d0699e5df1a965fb44db2a8cb3459dd97401f511d70d
-  data.tar.gz: 06e3f9c53a1f2d9b7646a0ebc556eb6970957ff700ddcd448869844e46e0fa4564ae91bbc6ab57f5dd7eb713bce351171fbd038399d24de80a177dc7d8e5dee8
+  metadata.gz: 76747928bf1fc2b8208add017d9f43953366f5de8c0b305cfe74b725ddd8bc40a02d2593b4c00a9d4f1f43652c32e83bd3261424ef2e9fe55a0f01b61a5b7190
+  data.tar.gz: 34ec05f6b7d198fea07a20c7bcf4fdd580c4551fc07d0c61c9820f37da9968994f6da9f4301db37d31d3a76a73ed63cb3f3529b1f2838ade6974607e02b784a8

data/Readme.md

@@ -6,8 +6,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
 
  - Documented, reusable, automated, and searchable configuration
  - Changes are PR reviewed and auditable
- - Good defaults like no-data / re-notify are preselected
- - Reliable cleanup with automated deletion
+ - Automated deletion when removed from code
 
 ![](template/github/screen.png?raw=true)
 <!-- NOT IN template/Readme.md  -->
@@ -18,7 +17,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
     ```Bash
     git clone git@github.com:your-org/kennel.git
     git clone git@github.com:grosser/kennel.git seed
-    mv seed/teamplate/* kennel/
+    mv seed/template/* kennel/
     cd kennel && git add . && git commit -m 'initial'
     ```
  - add a basic projects and teams so others can copy-paste to get started
@@ -31,7 +30,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
 
  - `projects/` monitors/dashboards/etc scoped by project
  - `teams/` team definitions
- - `parts/` monitors/dashes/etc that are used by multiple projects
+ - `parts/` monitors/dashboards/etc that are used by multiple projects
  - `generated/` projects as json, to show current state and proposed changes in PRs
 
 ## Workflows

data/lib/kennel/models/dashboard.rb

@@ -13,6 +13,7 @@ module Kennel
       REQUEST_DEFAULTS = {
         style: { line_width: "normal", palette: "dog_classic", line_type: "solid" }
       }.freeze
+      TIMESERIES_DEFAULTS = { show_legend: false, legend_size: "0" }.freeze
       SUPPORTED_DEFINITION_OPTIONS = [:events, :markers, :precision].freeze
 
       settings :title, :description, :definitions, :widgets, :layout_type
@@ -32,39 +33,68 @@ module Kennel
         def normalize(expected, actual)
           super
 
-          base_pairs(expected, actual).each do |pair|
+          widgets_pairs(expected, actual).each do |pair|
             # datadog always adds 2 to slo widget height
             # need to check fir layout since some monitors have height/width in their definition
-            pair.dig(1, :widgets)&.each do |widget|
+            pair[1].each do |widget|
               if widget.dig(:definition, :type) == "slo" && widget.dig(:layout, :height)
                 widget[:layout][:height] -= 2
               end
             end
 
             # conditional_formats ordering is randomly changed by datadog, compare a stable ordering
-            pair.each do |b|
-              b[:widgets]&.each do |w|
-                if formats = w.dig(:definition, :conditional_formats)
-                  w[:definition][:conditional_formats] = formats.sort_by(&:hash)
+            pair.each do |widgets|
+              widgets.each do |widget|
+                if formats = widget.dig(:definition, :conditional_formats)
+                  widget[:definition][:conditional_formats] = formats.sort_by(&:hash)
                 end
               end
             end
 
-            ignore_request_defaults(*pair, :widgets, :definition)
-            pair.each { |dash| dash[:widgets]&.each { |w| w.delete(:id) } }
+            ignore_definition_defaults_for_type pair, "timeseries", TIMESERIES_DEFAULTS
+
+            ignore_request_defaults(*pair)
+
+            # ids are kinda random so we always discard them
+            pair.each { |widgets| widgets.each { |w| w.delete(:id) } }
           end
         end
 
         private
 
+        def ignore_definition_defaults_for_type(pair, type, defaults)
+          pair.map(&:size).max.times do |i|
+            if pair.all? { |w| w.dig(i, :definition, :type) == type }
+              ignore_defaults(pair[0], pair[1], defaults, nesting: :definition)
+            end
+          end
+        end
+
+        # discard styles/conditional_formats/aggregator if nothing would change when we applied (both are default or nil)
+        def ignore_request_defaults(expected, actual)
+          [expected.size, actual.size].max.times do |i|
+            a_r = actual.dig(i, :definition, :requests) || []
+            e_r = expected.dig(i, :definition, :requests) || []
+            ignore_defaults e_r, a_r, REQUEST_DEFAULTS
+          end
+        end
+
+        def ignore_defaults(expected, actual, defaults, nesting: nil)
+          [expected.size, actual.size].max.times do |i|
+            e = expected.dig(i, *nesting) || {}
+            a = actual.dig(i, *nesting) || {}
+            ignore_default(e, a, defaults)
+          end
+        end
+
         # expand nested widgets into expected/actual pairs for default resolution
-        # [a, e] -> [[a, e], [aw1, ew1], ...]
-        def base_pairs(*pair)
-          result = [pair]
-          slots = pair.map { |d| d[:widgets]&.size }.compact.max.to_i
+        # [a, e] -> [[a-w, e-w], [a-w1-w1, e-w1-w1], ...]
+        def widgets_pairs(*pair)
+          result = [pair.map { |d| d[:widgets] || [] }]
+          slots = result[0].map(&:size).max
           slots.times do |i|
-            nested = pair.map { |d| d.dig(:widgets, i, :definition) || {} }
-            result << nested if nested.any? { |d| d.key?(:widgets) }
+            nested = pair.map { |d| d.dig(:widgets, i, :definition, :widgets) || [] }
+            result << nested if nested.any?(&:any?)
           end
           result
         end
@@ -95,7 +125,8 @@ module Kennel
       end
 
       def resolve_linked_tracking_ids(id_map)
-        as_json[:widgets].each do |widget|
+        widgets = as_json[:widgets].flat_map { |w| [w, *w.dig(:definition, :widgets) || []] }
+        widgets.each do |widget|
           next unless definition = widget[:definition]
           case definition[:type]
           when "uptime"

data/lib/kennel/models/record.rb

@@ -6,11 +6,6 @@ module Kennel
       READONLY_ATTRIBUTES = [
         :deleted, :id, :created, :created_at, :creator, :org_id, :modified, :modified_at, :api_resource
       ].freeze
-      REQUEST_DEFAULTS = {
-        style: { width: "normal", palette: "dog_classic", type: "solid" },
-        conditional_formats: [],
-        aggregator: "avg"
-      }.freeze
       API_LIST_INCOMPLETE = false
 
       settings :id, :kennel_id
@@ -22,25 +17,6 @@ module Kennel
           self::READONLY_ATTRIBUTES.each { |k| actual.delete k }
         end
 
-        # discard styles/conditional_formats/aggregator if nothing would change when we applied (both are default or nil)
-        def ignore_request_defaults(expected, actual, level1, level2)
-          actual = actual[level1] || {}
-          expected = expected[level1] || {}
-          [expected.size.to_i, actual.size.to_i].max.times do |i|
-            a_r = actual.dig(i, level2, :requests) || []
-            e_r = expected.dig(i, level2, :requests) || []
-            ignore_defaults e_r, a_r, self::REQUEST_DEFAULTS
-          end
-        end
-
-        def ignore_defaults(expected, actual, defaults)
-          [expected&.size.to_i, actual&.size.to_i].max.times do |i|
-            e = expected[i] || {}
-            a = actual[i] || {}
-            ignore_default(e, a, defaults)
-          end
-        end
-
         def ignore_default(expected, actual, defaults)
           definitions = [actual, expected]
           defaults.each do |key, default|
@@ -81,16 +57,17 @@ module Kennel
       def resolve_link(id, id_map, force: false)
         found = id_map[id]
         return found if found && found != :new
+        api_resource = self.class.api_resource
 
         if found == :new
           if force
-            invalid! "Monitor #{id} will be created in the current run and can only be used after that"
+            invalid! "#{api_resource.capitalize} #{id} will be created in the current run and can only be used after that"
           else
-            Kennel.err.puts "Monitor #{id} will be created in the current run, the next run will link it properly"
+            Kennel.err.puts "#{api_resource.capitalize} #{id} will be created in the current run, the next run will link it properly"
             Kennel::MISSING_ID
           end
         else
-          invalid! "Unable to find monitor #{id} (does not exist and is not being created by the current run)"
+          invalid! "Unable to find #{api_resource} #{id} (does not exist and is not being created by the current run)"
         end
       end
 

data/lib/kennel/syncer.rb

@@ -147,7 +147,8 @@ module Kennel
     def print_plan(step, list, color)
       return if list.empty?
       list.each do |_, e, a, diff|
-        Kennel.out.puts Utils.color(color, "#{step} #{tracking_id(e&.as_json || a)}")
+        api_resource = (e ? e.class.api_resource : a.fetch(:api_resource))
+        Kennel.out.puts Utils.color(color, "#{step} #{api_resource} #{tracking_id(e&.as_json || a)}")
         print_diff(diff) if diff # only for update
       end
     end

data/lib/kennel/template_variables.rb

@@ -25,7 +25,7 @@ module Kennel
       if bad.any?
         invalid!(
           "queries #{bad.join(", ")} must use the template variables #{variables.join(", ")}\n" \
-          "If that is not possible, add `validate_template_variables: -> { false } # query foo in bar does not have baz tag`"
+          "If that is not possible, add `validate: -> { false } # query foo in bar does not have baz tag`"
         )
       end
     end

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -6,8 +6,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
 
  - Documented, reusable, automated, and searchable configuration
  - Changes are PR reviewed and auditable
- - Good defaults like no-data / re-notify are preselected
- - Reliable cleanup with automated deletion
+ - Automated deletion when removed from code
 
 ![](github/screen.png?raw=true)
 
@@ -15,7 +14,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
 
  - `projects/` monitors/dashboards/etc scoped by project
  - `teams/` team definitions
- - `parts/` monitors/dashes/etc that are used by multiple projects
+ - `parts/` monitors/dashboards/etc that are used by multiple projects
  - `generated/` projects as json, to show current state and proposed changes in PRs
 
 ## Workflows

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.60.1
+  version: 1.61.4
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2020-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Keep datadog monitors/dashboards/etc in version control, avoid chaotic management