kennel 1.78.1 → 1.80.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d12735939d42da2f660773d9ca734a279fdc5c29b6619f6722b163f07f299236
-  data.tar.gz: 14f40ae5314abc2ff5b58672ad096a9d1898b793c1dee490a45d9deefc67e513
+  metadata.gz: 0cc9d71dff0d4c4bf8a29d9c58c1b62efbb739f3ebdc0d63fb7bd1a3e1cfec7c
+  data.tar.gz: 312fbda2e1577d071ba7cad7a6c5571b6b3913517cc3e5e9b92f7858637f96dc
 SHA512:
-  metadata.gz: b5340adfc8b564f648caa8f656b8b10fe9cd48177a6b15e21944adac24209344aeb81aa0bc5190e7a5997e8ebc0dc49af0304daf947abf99112dc8d56f6a9485
-  data.tar.gz: 368fb6dffbc42be889f8692b876e867818cde5eefd04b982151efc7d9dc74a378a046f12a7764f448df5818ebca950e55f22e36d45822c68ed3e8a3442850162
+  metadata.gz: 8d07c6d405178e7114c1ebaf67ce3f92a09a411208d20353bf7d07f453093e322b98f2e8e2f501cf902a601fafa1b352b5fa19bff9d54f1d042e87fc7ef81277
+  data.tar.gz: 9d681c94f1d61bbc60a098ea0b6fe12e3efc5b6e3c771ec49743db8e6edaae1c83a64ae322a9f5759fc677465b199842f0401c8a38973d1bbaa14157f53f94da

data/Readme.md

@@ -83,8 +83,8 @@ end
  - `gem install bundler && bundle install`
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
- - 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=`
+ - create a `API Key` or get an existing one from an admin, then add it to `.env` as `DATADOG_API_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
@@ -296,5 +297,5 @@ Author
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>
 License: MIT<br/>
-[![Build Status](https://travis-ci.org/grosser/kennel.png)](https://travis-ci.org/grosser/kennel)
+![CI](https://github.com/grosser/kennel/workflows/CI/badge.svg)
 <!-- NOT IN -->

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/dashboard.rb

@@ -105,7 +105,7 @@ module Kennel
 
       def as_json
         return @json if @json
-        all_widgets = render_definitions + widgets
+        all_widgets = render_definitions(definitions) + widgets
         expand_q all_widgets
 
         @json = {
@@ -178,14 +178,14 @@ module Kennel
       def validate_json(data)
         super
 
-        validate_template_variables data, :widgets
+        validate_template_variables data
 
         # Avoid diff from datadog presets sorting.
         presets = data[:template_variable_presets]
         invalid! "template_variable_presets must be sorted by name" if presets && presets != presets.sort_by { |p| p[:name] }
       end
 
-      def render_definitions
+      def render_definitions(definitions)
         definitions.map do |title, type, display_type, queries, options = {}, ignored = nil|
           # validate inputs
           if ignored || (!title || !type || !queries || !options.is_a?(Hash))

data/lib/kennel/models/monitor.rb

@@ -12,6 +12,10 @@ module Kennel
         :multi, :matching_downtimes, :overall_state_modified, :overall_state, :restricted_roles
       ]
 
+      MONITOR_DEFAULTS = {
+        priority: nil
+      }.freeze
+
       # defaults that datadog uses when options are not sent, so safe to leave out if our values match their defaults
       MONITOR_OPTION_DEFAULTS = {
         evaluation_delay: nil,
@@ -27,7 +31,7 @@ module Kennel
       settings(
         :query, :name, :message, :escalation_message, :critical, :type, :renotify_interval, :warning, :timeout_h, :evaluation_delay,
         :ok, :no_data_timeframe, :notify_no_data, :notify_audit, :tags, :critical_recovery, :warning_recovery, :require_full_window,
-        :threshold_windows, :new_host_delay
+        :threshold_windows, :new_host_delay, :priority
       )
 
       defaults(
@@ -46,7 +50,8 @@ module Kennel
         evaluation_delay: -> { MONITOR_OPTION_DEFAULTS.fetch(:evaluation_delay) },
         critical_recovery: -> { nil },
         warning_recovery: -> { nil },
-        threshold_windows: -> { nil }
+        threshold_windows: -> { nil },
+        priority: -> { MONITOR_DEFAULTS.fetch(:priority) }
       )
 
       def as_json
@@ -57,6 +62,7 @@ module Kennel
           query: query.strip,
           message: message.strip,
           tags: tags.uniq,
+          priority: priority,
           options: {
             timeout_h: timeout_h,
             notify_no_data: notify_no_data,
@@ -106,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
@@ -129,6 +137,9 @@ module Kennel
 
       def self.normalize(expected, actual)
         super
+
+        ignore_default(expected, actual, MONITOR_DEFAULTS)
+
         options = actual.fetch(:options)
         options.delete(:silenced) # we do not manage silenced, so ignore it when diffing
 
@@ -209,7 +220,10 @@ module Kennel
               .map! { |w| %("#{w}.name") }
             used.uniq.each do |match, group|
               next if allowed.include?(group)
-              invalid! "#{match} used with #{group}, but can only be used with #{allowed.join(", ")}. Add more groupings or fix the #{match}"
+              invalid!(
+                "#{match} used with #{group}, but can only be used with #{allowed.join(", ")}. " \
+                "Group the query by #{group.sub(".name", "").tr('"', "")} or change the #{match}"
+              )
             end
           end
         end

data/lib/kennel/template_variables.rb

@@ -16,18 +16,22 @@ module Kennel
 
     # check for queries that do not use the variables and would be misleading
     # TODO: do the same check for apm_query and their group_by
-    def validate_template_variables(data, key)
+    def validate_template_variables(data)
       variables = (data[:template_variables] || []).map { |v| "$#{v.fetch(:name)}" }
-      queries = data[key].flat_map do |widget|
+      return if variables.empty?
+
+      queries = data[:widgets].flat_map do |widget|
         ([widget] + (widget.dig(:definition, :widgets) || [])).flat_map { |w| widget_queries(w) }
       end.compact
-      bad = queries.grep_v(/(#{variables.map { |v| Regexp.escape(v) }.join("|")})\b/)
-      if bad.any?
-        invalid!(
-          "queries #{bad.join(", ")} must use the template variables #{variables.join(", ")}\n" \
-          "If that is not possible, add `validate: -> { false } # query foo in bar does not have baz tag`"
-        )
-      end
+
+      matches = variables.map { |v| Regexp.new "#{Regexp.escape(v)}\\b" }
+      queries.reject! { |q| matches.all? { |m| q.match? m } }
+      return if queries.empty?
+
+      invalid!(
+        "queries #{queries.join(", ")} must use the template variables #{variables.join(", ")}\n" \
+        "If that is not possible, add `validate: -> { false } # query foo in bar does not have baz tag`"
+      )
     end
 
     def widget_queries(widget)

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -66,8 +66,8 @@ end
  - `gem install bundler && bundle install`
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
- - 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=`
+ - create a `API Key` or get an existing one from an admin, then add it to `.env` as `DATADOG_API_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.78.1
+  version: 1.80.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday