kennel 1.79.0 → 1.80.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2a8b643d03deb142461d127a97ae6ad45144cffffb3bae2925cc60cf6a1d683
-  data.tar.gz: 1baaa314a376a99317163a871e5ec6df10dcd33a2cdd3cbc36d2bed9283fe288
+  metadata.gz: 0cc9d71dff0d4c4bf8a29d9c58c1b62efbb739f3ebdc0d63fb7bd1a3e1cfec7c
+  data.tar.gz: 312fbda2e1577d071ba7cad7a6c5571b6b3913517cc3e5e9b92f7858637f96dc
 SHA512:
-  metadata.gz: e4a2266131f58c1d833172e95e3b87b80b49f120675b27baf5e70bd0c5cf191a1dafeb0374b407ff983b5d5e793479d79fdfd548921f161e2644df1dbb86abb8
-  data.tar.gz: d791193329518eb1c277a24543abe1c3d4b62621af0046bd58a3347cdab3faa74da06dcc639dcd8c4d12ac0c76536652d91ada35db63b3d2fb71c7d618afa6b8
+  metadata.gz: 8d07c6d405178e7114c1ebaf67ce3f92a09a411208d20353bf7d07f453093e322b98f2e8e2f501cf902a601fafa1b352b5fa19bff9d54f1d042e87fc7ef81277
+  data.tar.gz: 9d681c94f1d61bbc60a098ea0b6fe12e3efc5b6e3c771ec49743db8e6edaae1c83a64ae322a9f5759fc677465b199842f0401c8a38973d1bbaa14157f53f94da

data/Readme.md

@@ -84,7 +84,7 @@ end
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
  - create a `API Key` or get an existing one from an admin, then 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=`
+ - open [Datadog API Settings](https://app.datadoghq.com/access/application-keys) and create a new key, then 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
 -->
@@ -219,6 +219,7 @@ To link to existing monitors via their kennel_id `projects kennel_id` + `:` + `m
  - Screens `uptime` widgets can use `monitor: {id: "foo:bar"}`
  - Screens `alert_graph` widgets can use `alert_id: "foo:bar"`
  - Monitors `composite` can use `query: -> { "%{foo:bar} || %{foo:baz}" }`
+ - Monitors `slo alert` can use `query: -> { "error_budget(\"%{foo:bar}\").over(\"7d\") > 123.0" }`
  - Slos can use `monitor_ids: -> ["foo:bar"]` 
 
 ### Debugging changes locally

data/lib/kennel.rb

@@ -39,12 +39,7 @@ module Kennel
     attr_accessor :out, :err
 
     def generate
-      FileUtils.rm_rf("generated")
-      generated.each do |part|
-        path = "generated/#{part.tracking_id.sub(":", "/")}.json"
-        FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, JSON.pretty_generate(part.as_json) << "\n")
-      end
+      store generated
     end
 
     def plan
@@ -58,6 +53,35 @@ module Kennel
 
     private
 
+    def store(parts)
+      Progress.progress "Storing" do
+        old = Dir["generated/**/*"]
+        used = []
+
+        Utils.parallel(parts, max: 2) do |part|
+          path = "generated/#{part.tracking_id.tr("/", ":").sub(":", "/")}.json"
+          used << File.dirname(path) # only 1 level of sub folders, so this is safe
+          used << path
+          write_file_if_necessary(path, JSON.pretty_generate(part.as_json) << "\n")
+        end
+
+        # deleting all is slow, so only delete the extras
+        (old - used).each { |p| FileUtils.rm_rf(p) }
+      end
+    end
+
+    def write_file_if_necessary(path, content)
+      # 99% case
+      begin
+        return if File.read(path) == content
+      rescue Errno::ENOENT
+        FileUtils.mkdir_p(File.dirname(path))
+      end
+
+      # slow 1% case
+      File.write(path, content)
+    end
+
     def syncer
       @syncer ||= Syncer.new(api, generated, project: ENV["PROJECT"])
     end
@@ -73,8 +97,12 @@ module Kennel
           parts = Models::Project.recursive_subclasses.flat_map do |project_class|
             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
+          parts.group_by(&:tracking_id).each do |tracking_id, same|
+            next if same.size == 1
+            raise <<~ERROR
+              #{tracking_id} is defined #{same.size} times
+              use a different `kennel_id` when defining multiple projects/monitors/dashboards to avoid this conflict
+            ERROR
           end
           parts
         end

data/lib/kennel/models/monitor.rb

@@ -112,9 +112,11 @@ module Kennel
       end
 
       def resolve_linked_tracking_ids!(id_map, **args)
-        if as_json[:type] == "composite"
-          as_json[:query] = as_json[:query].gsub(/%\{(.*?)\}/) do
-            resolve_link($1, :monitor, id_map, **args)
+        case as_json[:type]
+        when "composite", "slo alert"
+          type = (as_json[:type] == "composite" ? :monitor : :slo)
+          as_json[:query] = as_json[:query].gsub(/%{(.*?)}/) do
+            resolve_link($1, type, id_map, **args)
           end
         end
       end

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -67,7 +67,7 @@ end
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
  - create a `API Key` or get an existing one from an admin, then 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=`
+ - open [Datadog API Settings](https://app.datadoghq.com/access/application-keys) and create a new key, then 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
 
@@ -201,6 +201,7 @@ To link to existing monitors via their kennel_id `projects kennel_id` + `:` + `m
  - Screens `uptime` widgets can use `monitor: {id: "foo:bar"}`
  - Screens `alert_graph` widgets can use `alert_id: "foo:bar"`
  - Monitors `composite` can use `query: -> { "%{foo:bar} || %{foo:baz}" }`
+ - Monitors `slo alert` can use `query: -> { "error_budget(\"%{foo:bar}\").over(\"7d\") > 123.0" }`
  - Slos can use `monitor_ids: -> ["foo:bar"]` 
 
 ### Debugging changes locally

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.79.0
+  version: 1.80.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday