kennel 1.49.0 → 1.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f0aabf5d65787da727c8f2fe6d4e42a3d88bca6cf31a426b2b29efbacc29316
-  data.tar.gz: 8058d85578b7bf7247c26e50c8759fb4036977f22f321068283c1da77cf5e25e
+  metadata.gz: 95c82242166781e34d9132c511942a71c45c480951cb4b986702479cca60e271
+  data.tar.gz: 44ab3de5ad5709b6be941bfc8706ae4b712f94a3d1b9ae75a2f028a4e2c42926
 SHA512:
-  metadata.gz: 80e9d102685107b747629f2df6045b30f588a1f9f9f7df2a668bfa7513fb96f47606c929d5276734282031328766210ae7c8dc260ef0e259a6cac4e36e915b22
-  data.tar.gz: 762d5d95e419700fd9deb1b0c56fcaed33a460e3c65a4ed8d8f4ebd8c60875438d402423b48d62a086efe3b79019e72b64fd43bb59251ed20308039735f9f01a
+  metadata.gz: eb2bf40bccca3072b58c6eb7e7342de8ed51f6a716eba29eb5d717aeb013da18e082fdc0b4565fa666d6a7146d8dd77bc085f343b06d08fb81a285da7d64d520
+  data.tar.gz: be449f1b2c32d1f5996d16d17baa3e215c4446ae2ce4c865bd3cb160baece6bd8f56049cc7e29a56f025339a660ba474b6258fc042d808222a156cc2eb90f8e5

data/Readme.md

@@ -154,12 +154,19 @@ end
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and
 to unblock use the `validate: -> { false }` option.
 
+### Monitor re-notification
+
+Monitors inherit the re-notification setting from their `project.team`.
+Set this to for example `renotify_interval: -> { 120 }` minutes,
+to make alerts not get ignored by popping back up if they are still alerting.
+
 ### Linking with kennel_ids
 
 To link to existing monitors via their kennel_id
 
  - 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}" }`
 
 ### Debugging changes locally
 

data/lib/kennel/importer.rb

@@ -53,6 +53,9 @@ module Kennel
         if query && critical
           query.sub!(/([><=]) (#{Regexp.escape(critical.to_f.to_s)}|#{Regexp.escape(critical.to_i.to_s)})$/, "\\1 \#{critical}")
         end
+      elsif resource == "dashboard"
+        widgets = data[:widgets]&.flat_map { |widget| widget.dig(:definition, :widgets) || [widget] }
+        widgets&.each { |widget| dry_up_query!(widget) }
       end
 
       # simplify template_variables to array of string when possible
@@ -71,6 +74,20 @@ module Kennel
 
     private
 
+    # reduce duplication in imports by using dry `q: :metadata` when possible
+    def dry_up_query!(widget)
+      (widget.dig(:definition, :requests) || []).each do |request|
+        next unless request.is_a?(Hash)
+        next unless metadata = request[:metadata]
+        next unless query = request[:q]&.dup
+        metadata.each do |m|
+          next unless exp = m[:expression]
+          query.sub!(exp, "")
+        end
+        request[:q] = :metadata if query.delete(", ") == ""
+      end
+    end
+
     def pretty_print(hash)
       sort_widgets hash
 
@@ -84,6 +101,7 @@ module Kennel
               .gsub(/(^\s*)"([a-zA-Z][a-zA-Z\d_]*)":/, "\\1\\2:") # "foo": 1 -> foo: 1
               .gsub(/: \[\n\s+\]/, ": []") # empty arrays on a single line
               .gsub(/^/, "    ") # indent
+              .gsub('q: "metadata"', "q: :metadata") # bring symbols back
 
             "\n#{pretty}\n  "
           elsif k == :message

data/lib/kennel/models/base.rb

@@ -148,6 +148,13 @@ 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)
+        end
+      end
+
       # let users know which project/resource failed when something happens during diffing where the backtrace is hidden
       def invalid!(message)
         raise ValidationError, "#{tracking_id} #{message}"

data/lib/kennel/models/dashboard.rb

@@ -39,7 +39,7 @@ module Kennel
             pair.each do |b|
               b[:widgets]&.each do |w|
                 if formats = w.dig(:definition, :conditional_formats)
-                  w[:definition][:conditional_formats] = formats.sort_by { |h| h[:value].to_f }
+                  w[:definition][:conditional_formats] = formats.sort_by(&:hash)
                 end
               end
             end
@@ -73,12 +73,15 @@ module Kennel
 
       def as_json
         return @json if @json
+        all_widgets = render_definitions + widgets
+        expand_q all_widgets
+
         @json = {
           layout_type: layout_type,
           title: "#{title}#{LOCK}",
           description: description,
           template_variables: render_template_variables,
-          widgets: render_definitions + widgets
+          widgets: all_widgets
         }
 
         @json[:id] = id if id
@@ -98,11 +101,13 @@ module Kennel
           case definition[:type]
           when "uptime"
             if ids = definition[:monitor_ids]
-              definition[:monitor_ids] = ids.map { |id| resolve_link(id, id_map) }
+              definition[:monitor_ids] = ids.map do |id|
+                tracking_id?(id) ? resolve_link(id, id_map, force: false) : id
+              end
             end
           when "alert_graph"
-            if id = definition[:alert_id]
-              definition[:alert_id] = resolve_link(id, id_map).to_s
+            if (id = definition[:alert_id]) && tracking_id?(id)
+              definition[:alert_id] = resolve_link(id, id_map, force: false).to_s
             end
           end
         end
@@ -110,16 +115,24 @@ module Kennel
 
       private
 
-      def resolve_link(id, id_map)
-        return id unless tracking_id?(id)
-        id_map[id] ||
-          Kennel.err.puts("Unable to find #{id} in existing monitors (they need to be created first to link them)")
-      end
-
       def tracking_id?(id)
         id.is_a?(String) && !id.match?(/\A\d+\z/)
       end
 
+      # creates queries from metadata to avoid having to keep q and expression in sync
+      #
+      # {q: :metadata, metadata: [{expression: "sum:bar", alias_name: "foo"}, ...], }
+      # -> {q: "sum:bar, ...", metadata: ..., }
+      def expand_q(widgets)
+        widgets = widgets.flat_map { |w| w.dig(:definition, :widgets) || w } # expand groups
+        widgets.each do |w|
+          w.dig(:definition, :requests)&.each do |request|
+            next unless request.is_a?(Hash) && request[:q] == :metadata
+            request[:q] = request.fetch(:metadata).map { |m| m.fetch(:expression) }.join(", ")
+          end
+        end
+      end
+
       def validate_json(data)
         super
 

data/lib/kennel/models/monitor.rb

@@ -15,7 +15,7 @@ module Kennel
         evaluation_delay: nil,
         new_host_delay: 300,
         timeout_h: 0,
-        renotify_interval: 120,
+        renotify_interval: 0,
         no_data_timeframe: nil # this works out ok since if notify_no_data is on, it would never be nil
       }.freeze
       DEFAULT_ESCALATION_MESSAGE = ["", nil].freeze
@@ -29,7 +29,7 @@ module Kennel
       defaults(
         message: -> { "\n\n@slack-#{project.slack}" },
         escalation_message: -> { DEFAULT_ESCALATION_MESSAGE.first },
-        renotify_interval: -> { MONITOR_OPTION_DEFAULTS.fetch(:renotify_interval) },
+        renotify_interval: -> { project.team.renotify_interval },
         warning: -> { nil },
         ok: -> { nil },
         id: -> { nil },
@@ -108,6 +108,16 @@ module Kennel
         @as_json = data
       end
 
+      # resolve composite monitors ... only works when referenced monitors already exist
+      # since leaving names or bad ids in the query breaks the monitor update
+      def resolve_linked_tracking_ids(id_map)
+        if as_json[:type] == "composite"
+          as_json[:query] = as_json[:query].gsub(/%\{(.*?)\}/) do
+            resolve_link($1, id_map, force: true)
+          end
+        end
+      end
+
       def self.api_resource
         "monitor"
       end

data/lib/kennel/models/team.rb

@@ -2,9 +2,10 @@
 module Kennel
   module Models
     class Team < Base
-      settings :slack, :email, :tags, :kennel_id
+      settings :slack, :email, :tags, :renotify_interval, :kennel_id
       defaults(
-        tags: -> { ["team:#{kennel_id.sub(/^teams_/, "")}"] }
+        tags: -> { ["team:#{kennel_id.sub(/^teams_/, "")}"] },
+        renotify_interval: -> { 0 }
       )
 
       def initialize(*)

data/lib/kennel/syncer.rb

@@ -72,11 +72,22 @@ module Kennel
         filter_by_project! actual
 
         details_cache do |cache|
-          actual.each do |a|
-            id = a.fetch(:id)
+          items = actual.map do |a|
             e = matching_expected(a)
             if e && @expected.delete(e)
-              fill_details(a, cache) if e.class::API_LIST_INCOMPLETE
+              [e, a]
+            else
+              [nil, a]
+            end
+          end
+
+          # fill details of things we need to compare (only do this part in parallel for safety & balancing)
+          Utils.parallel(items.select { |e, _| e && e.class::API_LIST_INCOMPLETE }) { |_, a| fill_details(a, cache) }
+
+          # pick out things to update or delete
+          items.each do |e, a|
+            id = a.fetch(:id)
+            if e
               diff = e.diff(a)
               @update << [id, e, a, diff] if diff.any?
             elsif tracking_id(a) # was previously managed

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -136,12 +136,18 @@ end
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and
 to unblock use the `validate: -> { false }` option.
 
+### Monitor re-notification
+
+Monitors inherit the re-notification setting from their projects team.
+By default this is `renotify_interval: -> { 120 }` minutes, which will make alerts not get ignored by popping back up.
+
 ### Linking with kennel_ids
 
 To link to existing monitors via their kennel_id
 
  - 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}" }`
 
 ### Debugging changes locally
 

metadata

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