kennel 1.58.0 → 1.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffd28c1dcb7db623d9e93d2238e143e78c928f76573d97781c1bdcd058c0ab1c
-  data.tar.gz: 6948f95652b107a8ccf3f58585cd2e3c4e908554a8c99ecade86ad6233eb8d14
+  metadata.gz: c20add02263916021ed0498253e11e79193b5bf603651c28cbacbf614b02287c
+  data.tar.gz: ec8ff5e6fa15c10b2f3113feb7f3459f48b9520259952ab91786f56001192f53
 SHA512:
-  metadata.gz: 3c5bbfb1b9bc9a9c32e9200b3572f01bb201aade69081dc651dbb499d35816d157593a41aa057669f0dc2fd6f9e2cd4d99235b88a7c7e09b70f032a5c2e0ae80
-  data.tar.gz: fdbfa3f3f8b9c654e60e072909bcb1f6d30580142a03a5365220f781b062e821f6d8313538b2aefc87ed64974f239df0f0c9b4a7798ca5ad4560d5aa3656c907
+  metadata.gz: b69a0f24eeca1fb532c4b46f18f398e5df1630ae5f8da96b3ea7a263e68e3a211b31e4762f979ff022290ec5fc54a011ba3177a3ee9156ee4ee20541385b48e8
+  data.tar.gz: 30e5d810b9351afb83ec40f29c17d9828bd85d41ecea39c3e273011f3ed32ffa2c1729d495aeaad1668bb958e4b407f696916dd57eb3992da08588cf4bf8576e

data/Readme.md

@@ -45,6 +45,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
  - copy any `API Key` and add it to `.env` as `DATADOG_API_KEY`
  - find or create (check last page) your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=`
  - change the `DATADOG_SUBDOMAIN=app` in `.env` to your companies subdomain if you have one
+ - verify it works by running `rake plan`, it might show some diff, but should not crash
 -->
 
 ### Adding a team

data/lib/kennel.rb

@@ -29,6 +29,10 @@ require "kennel/models/project"
 require "kennel/models/team"
 
 module Kennel
+  MISSING_ID = 1
+  class ValidationError < RuntimeError
+  end
+
   @out = $stdout
   @err = $stderr
 
@@ -68,7 +72,7 @@ module Kennel
         Progress.progress "Generating" do
           load_all
           parts = Models::Project.recursive_subclasses.flat_map do |project_class|
-            project_class.new.parts
+            project_class.new.validated_parts
           end
           parts.map(&:tracking_id).group_by { |id| id }.select do |id, same|
             raise "#{id} is defined #{same.size} times" if same.size != 1

data/lib/kennel/api.rb

@@ -13,7 +13,22 @@ module Kennel
     end
 
     def list(api_resource, params = {})
-      request :get, "/api/v1/#{api_resource}", params: params
+      if api_resource == "slo"
+        raise ArgumentError if params[:limit] || params[:offset]
+        limit = 1000
+        offset = 0
+        all = []
+
+        loop do
+          result = request :get, "/api/v1/#{api_resource}", params: params.merge(limit: limit, offset: offset)
+          data = result.fetch(:data)
+          all.concat data
+          break all if data.size < limit
+          offset += limit
+        end
+      else
+        request :get, "/api/v1/#{api_resource}", params: params
+      end
     end
 
     def create(api_resource, attributes)

data/lib/kennel/models/dashboard.rb

@@ -101,16 +101,16 @@ module Kennel
           when "uptime"
             if ids = definition[:monitor_ids]
               definition[:monitor_ids] = ids.map do |id|
-                tracking_id?(id) ? resolve_link(id, id_map, force: false) : id
+                tracking_id?(id) ? resolve_link(id, id_map) : id
               end
             end
           when "alert_graph"
             if (id = definition[:alert_id]) && tracking_id?(id)
-              definition[:alert_id] = resolve_link(id, id_map, force: false).to_s
+              definition[:alert_id] = resolve_link(id, id_map).to_s
             end
           when "slo"
             if (id = definition[:slo_id]) && tracking_id?(id)
-              definition[:slo_id] = resolve_link(id, id_map, force: false).to_s
+              definition[:slo_id] = resolve_link(id, id_map).to_s
             end
           end
         end

data/lib/kennel/models/monitor.rb

@@ -105,6 +105,7 @@ module Kennel
       def resolve_linked_tracking_ids(id_map)
         if as_json[:type] == "composite"
           as_json[:query] = as_json[:query].gsub(/%\{(.*?)\}/) do
+            # need force here since it validates the id exists
             resolve_link($1, id_map, force: true)
           end
         end

data/lib/kennel/models/project.rb

@@ -14,6 +14,18 @@ module Kennel
           instance_method(method_in_file).source_location.first.sub("#{Bundler.root}/", "")
         end
       end
+
+      def validated_parts
+        all = parts
+        validate_parts(all)
+        all
+      end
+
+      private
+
+      # hook for users to add custom validations via `prepend`
+      def validate_parts(parts)
+      end
     end
   end
 end

data/lib/kennel/models/record.rb

@@ -13,9 +13,6 @@ module Kennel
       }.freeze
       API_LIST_INCOMPLETE = false
 
-      class ValidationError < RuntimeError
-      end
-
       settings :id, :kennel_id
 
       class << self
@@ -81,10 +78,19 @@ module Kennel
 
       private
 
-      def resolve_link(id, id_map, force:)
-        id_map[id] || begin
-          message = "Unable to find #{id} in existing monitors (they need to be created first to link them)"
-          force ? invalid!(message) : Kennel.err.puts(message)
+      def resolve_link(id, id_map, force: false)
+        found = id_map[id]
+        return found if found && found != :new
+
+        if found == :new
+          if force
+            invalid! "Monitor #{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::MISSING_ID
+          end
+        else
+          invalid! "Unable to find monitor #{id} (does not exist and is not being created by the current run)"
         end
       end
 

data/lib/kennel/models/slo.rb

@@ -55,7 +55,7 @@ module Kennel
 
       def resolve_linked_tracking_ids(id_map)
         as_json[:monitor_ids] = as_json[:monitor_ids].map do |id|
-          id.is_a?(String) ? resolve_link(id, id_map, force: false) || 1 : id
+          id.is_a?(String) ? resolve_link(id, id_map) : id
         end
       end
 

data/lib/kennel/syncer.rb

@@ -195,6 +195,7 @@ module Kennel
 
     def resolve_linked_tracking_ids(actual)
       map = actual.each_with_object({}) { |a, lookup| lookup[tracking_id(a)] = a.fetch(:id) }
+      @expected.each { |e| map[e.tracking_id] ||= :new }
       @expected.each { |e| e.resolve_linked_tracking_ids(map) }
     end
 

data/lib/kennel/tasks.rb

@@ -4,12 +4,23 @@ require "kennel"
 require "kennel/unmuted_alerts"
 require "kennel/importer"
 
+module Kennel
+  module Tasks
+    class << self
+      def abort(message = nil)
+        Kennel.err.puts message if message
+        raise SystemExit.new(1), message
+      end
+    end
+  end
+end
+
 namespace :kennel do
   desc "Ensure there are no uncommited changes that would be hidden from PR reviewers"
   task no_diff: :generate do
     result = `git status --porcelain`.strip
-    abort "Diff found:\n#{result}\nrun `rake generate` and commit the diff to fix" unless result == ""
-    abort "Error during diffing" unless $CHILD_STATUS.success?
+    Kennel::Tasks.abort "Diff found:\n#{result}\nrun `rake generate` and commit the diff to fix" unless result == ""
+    Kennel::Tasks.abort "Error during diffing" unless $CHILD_STATUS.success?
   end
 
   # ideally do this on every run, but it's slow (~1.5s) and brittle (might not find all + might find false-positives)
@@ -38,7 +49,7 @@ namespace :kennel do
       url = (subdomain ? "https://zendesk.datadoghq.com" : "") + "/account/settings"
       puts "Invalid mentions found, either ignore them by adding to `KNOWN` env var or add them via #{url}"
       bad.each { |f, v| puts "Invalid mention #{v} in monitor message of #{f}" }
-      abort
+      Kennel::Tasks.abort
     end
   end
 
@@ -76,16 +87,16 @@ namespace :kennel do
 
   desc "show unmuted alerts filtered by TAG, for example TAG=team:foo"
   task alerts: :environment do
-    tag = ENV["TAG"] || abort("Call with TAG=foo:bar")
+    tag = ENV["TAG"] || Kennel::Tasks.abort("Call with TAG=foo:bar")
     Kennel::UnmutedAlerts.print(Kennel.send(:api), tag)
   end
 
   desc "show monitors with no data by TAG, for example TAG=team:foo"
   task nodata: :environment do
-    tag = ENV["TAG"] || abort("Call with TAG=foo:bar")
+    tag = ENV["TAG"] || Kennel::Tasks.abort("Call with TAG=foo:bar")
     monitors = Kennel.send(:api).list("monitor", monitor_tags: tag, group_states: "no data")
     monitors.select! { |m| m[:overall_state] == "No Data" }
-    monitors.reject! { |m| m[:tags].include? ["nodata:ignore"] }
+    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.
@@ -103,8 +114,8 @@ namespace :kennel do
 
   desc "Convert existing resources to copy-pastable definitions to import existing resources RESOURCE=dash ID=1234"
   task import: :environment do
-    resource = ENV["RESOURCE"] || abort("Call with RESOURCE=dash") # TODO: add others
-    id = ENV["ID"] || abort("Call with ID=1234")
+    resource = ENV["RESOURCE"] || Kennel::Tasks.abort("Call with RESOURCE=dash") # TODO: add others
+    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

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -28,6 +28,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
  - copy any `API Key` and add it to `.env` as `DATADOG_API_KEY`
  - find or create (check last page) your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=`
  - change the `DATADOG_SUBDOMAIN=app` in `.env` to your companies subdomain if you have one
+ - verify it works by running `rake plan`, it might show some diff, but should not crash
 
 ### Adding a team
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.58.0
+  version: 1.59.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday