kennel 1.101.0 → 1.103.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11220aba046ce1fbc63b8b62e5a60f0cbd4b04862ff7394c0ad43a1776bc34a6
-  data.tar.gz: 257808a3036f97c8b994c35ce0c4c621bafd1a29a43da0cba6c113a9fe8297ff
+  metadata.gz: bee3140dd0001488c0ec264244c7a28b30f3a5f877db23438884afca5181aef5
+  data.tar.gz: eb0071ea0aac8be39f1517738093fd61a211cb65e61ccb1f457030b999a58487
 SHA512:
-  metadata.gz: 1bcd69ba301375d93c1c72f9cb1ffcf057e06d4aa3f604baada0ed4dce5cd0d4e7675227d9d4ef8f09a80198bc3e14268fcdb4cd1f3623d3a810818bbbe6d4b2
-  data.tar.gz: c189ecb33b4800d9d0e382f82fedbcfa8723f3ff0a27bbd2554528de60d50f774309da9d30c27374ae3365863861f81fae438d4843a34519c4d0a044a4d250ce
+  metadata.gz: 442611b5ef920684f95c698e654a53c3c367fc6c48a8def218dd40d130dba349ab512e880e88c7d9c0fb7634887bb78b40381314a81a2457a393301cee169b18
+  data.tar.gz: a26df226bd670a252539b4001401cb2d3dc9e32883fc2811b36cb01b26a6a9c23bc5da970c68b71cdac174432f7d4e2df5643b4a893adc9a85ce8908dcbf14e6

data/lib/kennel/id_map.rb

@@ -15,10 +15,6 @@ module Kennel
       @map[type][tracking_id] = id
     end
 
-    def set_new(type, tracking_id)
-      @map[type][tracking_id] = NEW
-    end
-
     def new?(type, tracking_id)
       @map[type][tracking_id] == NEW
     end

data/lib/kennel/importer.rb

@@ -137,7 +137,7 @@ module Kennel
             pretty = convert_strings_to_heredoc(pretty)
 
             "\n#{pretty}\n  "
-          elsif k == :message
+          elsif [:message, :description].include?(k)
             "\n    <<~TEXT\n#{v.each_line.map { |l| l.strip.empty? ? "\n" : "      #{l}" }.join}\n      \#{super()}\n    TEXT\n  "
           elsif k == :tags
             " super() + #{v.inspect} "

data/lib/kennel/syncer.rb

@@ -3,7 +3,6 @@ module Kennel
   class Syncer
     DELETE_ORDER = ["dashboard", "slo", "monitor", "synthetics/tests"].freeze # dashboards references monitors + slos, slos reference monitors
     LINE_UP = "\e[1A\033[K" # go up and clear
-    DEFAULT_BRANCH = "master"
 
     def initialize(api, expected, project: nil)
       @api = api
@@ -18,6 +17,7 @@ module Kennel
       if noop?
         Kennel.out.puts Utils.color(:green, "Nothing to do")
       else
+        @warnings.each { |message| Kennel.out.puts Utils.color(:yellow, "Warning: #{message}") }
         print_plan "Create", @create, :green
         print_plan "Update", @update, :yellow
         print_plan "Delete", @delete, :red
@@ -27,7 +27,6 @@ module Kennel
     def confirm
       return false if noop?
       return true if ENV["CI"] || !STDIN.tty?
-      warn_about_deleting_resources_with_id if @project_filter
       Utils.ask("Execute Plan ?")
     end
 
@@ -60,30 +59,6 @@ module Kennel
 
     private
 
-    # this is brittle/hacky since it relies on knowledge from the generation + git + branch knowledge
-    def warn_about_deleting_resources_with_id
-      @delete.each do |_, _, a|
-        tracking_id = a.fetch(:tracking_id)
-        api_resource = a.fetch(:klass).api_resource
-
-        file = "generated/#{tracking_id.sub(":", "/")}.json"
-        old = `true && git show #{DEFAULT_BRANCH}:#{file.shellescape} 2>&1` # true && to not crash on missing git
-
-        next unless $?.success?
-        old =
-          begin
-            JSON.parse(old)
-          rescue StandardError
-            false
-          end
-        next if !old || !old["id"]
-
-        Kennel.out.puts(
-          Utils.color(:red, "WARNING: deleting #{api_resource} #{tracking_id} will break #{DEFAULT_BRANCH} branch")
-        )
-      end
-    end
-
     # loop over items until everything is resolved or crash when we get stuck
     # this solves cases like composite monitors depending on each other or monitor->monitor slo->slo monitor chains
     def each_resolved(list)
@@ -120,6 +95,7 @@ module Kennel
     end
 
     def calculate_diff
+      @warnings = []
       @update = []
       @delete = []
       @id_map = IdMap.new
@@ -181,7 +157,11 @@ module Kennel
       @expected.each do |e|
         next unless id = e.id
         resource = e.class.api_resource
-        raise "Unable to find existing #{resource} with id #{id}\nIf the #{resource} was deleted, remove the `id: -> { #{e.id} }` line."
+        if Kennel.strict_imports
+          raise "Unable to find existing #{resource} with id #{id}\nIf the #{resource} was deleted, remove the `id: -> { #{id} }` line."
+        else
+          @warnings << "#{resource} #{e.tracking_id} specifies id #{id}, but no such #{resource} exists. 'id' will be ignored. Remove the `id: -> { #{id} }` line."
+        end
       end
     end
 
@@ -254,15 +234,28 @@ module Kennel
     end
 
     def populate_id_map(expected, actual)
+      # mark everything as new
       expected.each do |e|
-        @id_map.set_new(e.class.api_resource, e.tracking_id)
+        @id_map.set(e.class.api_resource, e.tracking_id, IdMap::NEW)
+        if e.class.api_resource == "synthetics/tests"
+          @id_map.set(Kennel::Models::Monitor.api_resource, e.tracking_id, IdMap::NEW)
+        end
       end
 
+      # override resources that exist with their id
+      project_prefix = @project_filter && "#{@project_filter}:"
       actual.each do |a|
+        # ignore when not managed by kennel
         next unless tracking_id = a.fetch(:tracking_id)
-        next unless @id_map.get(a.fetch(:klass).api_resource, tracking_id)
 
-        @id_map.set(a.fetch(:klass).api_resource, tracking_id, a.fetch(:id))
+        # ignore when deleted from the codebase
+        # (when running with project filter we cannot see the other resources in the codebase)
+        api_resource = a.fetch(:klass).api_resource
+        next if
+          !@id_map.get(api_resource, tracking_id) &&
+          (!project_prefix || tracking_id.start_with?(project_prefix))
+
+        @id_map.set(api_resource, tracking_id, a.fetch(:id))
         if a[:klass].api_resource == "synthetics/tests"
           @id_map.set(Kennel::Models::Monitor.api_resource, tracking_id, a.fetch(:monitor_id))
         end

data/lib/kennel/tasks.rb

@@ -3,6 +3,7 @@ require "English"
 require "kennel"
 require "kennel/unmuted_alerts"
 require "kennel/importer"
+require "json"
 
 module Kennel
   module Tasks
@@ -75,6 +76,7 @@ namespace :kennel do
     is_push = (ENV["TRAVIS_PULL_REQUEST"] == "false" || ENV["GITHUB_EVENT_NAME"] == "push")
     task_name =
       if on_default_branch && is_push
+        Kennel.strict_imports = false
         "kennel:update_datadog"
       else
         "kennel:plan" # show plan in CI logs
@@ -89,7 +91,7 @@ namespace :kennel do
     Kennel::UnmutedAlerts.print(Kennel.send(:api), tag)
   end
 
-  desc "show monitors with no data by TAG, for example TAG=team:foo"
+  desc "show monitors with no data by TAG, for example TAG=team:foo [THRESHOLD_DAYS=7] [FORMAT=json]"
   task nodata: :environment do
     tag = ENV["TAG"] || Kennel::Tasks.abort("Call with TAG=foo:bar")
     monitors = Kennel.send(:api).list("monitor", monitor_tags: tag, group_states: "no data")
@@ -97,16 +99,45 @@ namespace :kennel do
     monitors.reject! { |m| m[:tags].include? "nodata:ignore" }
     if monitors.any?
       Kennel.err.puts <<~TEXT
-        This is a useful task to find monitors that have mis-spelled metrics or never received data at any time.
-        To ignore monitors with nodata, tag the monitor with "nodata:ignore"
+        To ignore monitors with expected nodata, tag it with "nodata:ignore"
 
       TEXT
     end
 
+    now = Time.now
     monitors.each do |m|
-      Kennel.out.puts m[:name]
-      Kennel.out.puts Kennel::Utils.path_to_url("/monitors/#{m[:id]}")
-      Kennel.out.puts
+      m[:days_in_no_data] =
+        if m[:overall_state_modified]
+          since = Date.parse(m[:overall_state_modified]).to_time
+          ((now - since) / (24 * 60 * 60)).to_i
+        else
+          999
+        end
+    end
+
+    if threshold = ENV["THRESHOLD_DAYS"]
+      monitors.select! { |m| m[:days_in_no_data] > Integer(threshold) }
+    end
+
+    monitors.each { |m| m[:url] = Kennel::Utils.path_to_url("/monitors/#{m[:id]}") }
+
+    if ENV["FORMAT"] == "json"
+      report = monitors.map do |m|
+        match = m[:message].to_s.match(/-- Managed by kennel (\S+:\S+) in (\S+), /) || []
+        m.slice(:url, :name, :tags, :days_in_no_data).merge(
+          kennel_tracking_id: match[1],
+          kennel_source: match[2]
+        )
+      end
+
+      Kennel.out.puts JSON.pretty_generate(report)
+    else
+      monitors.each do |m|
+        Kennel.out.puts m[:name]
+        Kennel.out.puts Kennel::Utils.path_to_url("/monitors/#{m[:id]}")
+        Kennel.out.puts "No data since #{m[:days_in_no_data]}d"
+        Kennel.out.puts
+      end
     end
   end
 

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -2,7 +2,6 @@
 require "faraday"
 require "json"
 require "zeitwerk"
-require "shellwords"
 require "English"
 
 require "kennel/version"
@@ -42,9 +41,10 @@ module Kennel
 
   @out = $stdout
   @err = $stderr
+  @strict_imports = true
 
   class << self
-    attr_accessor :out, :err
+    attr_accessor :out, :err, :strict_imports
 
     def generate
       store generated

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.101.0
+  version: 1.103.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday