kennel 1.78.0 → 1.79.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d1a7ffddfc55955603d8ac9826ab2f46af2f223cb92f829ac1be0f2dc29af4c
-  data.tar.gz: fe2a7fa8bdf812bb7e4cf79a3e14ab8923225f8464ac352723ab18e54be9fc3f
+  metadata.gz: e2a8b643d03deb142461d127a97ae6ad45144cffffb3bae2925cc60cf6a1d683
+  data.tar.gz: 1baaa314a376a99317163a871e5ec6df10dcd33a2cdd3cbc36d2bed9283fe288
 SHA512:
-  metadata.gz: af3734bc932520ec215baa7cbf31f40553d50b48f0c61d80835a030cb728af8cb139c4e7296ad82792a54b699971a6892da227674b1b50f659bd787cbe743a0c
-  data.tar.gz: 9f01dd98d5467bf60cdfa2943925fa0edece4d74970ba2e17888b5dcce51f6f59a15cd70c6d6208e1e83c5ebd65339e7a2e7f5c52f490ece1cffce0ad170f8b3
+  metadata.gz: e4a2266131f58c1d833172e95e3b87b80b49f120675b27baf5e70bd0c5cf191a1dafeb0374b407ff983b5d5e793479d79fdfd548921f161e2644df1dbb86abb8
+  data.tar.gz: d791193329518eb1c277a24543abe1c3d4b62621af0046bd58a3347cdab3faa74da06dcc639dcd8c4d12ac0c76536652d91ada35db63b3d2fb71c7d618afa6b8

data/Readme.md

@@ -83,7 +83,7 @@ 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`
+ - 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=`
  - 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
@@ -198,6 +198,15 @@ end
   end
  ```
 
+### Updating existing resources with id
+
+Setting `id` makes kennel take over a manually created datadog resource.
+When manually creating to import, it is best to remove the `id` and delete the manually created resource.
+
+When an `id` is set and the original resource is deleted, kennel will fail to update,
+removing the `id` will cause kennel to create a new resource in datadog.
+
+
 ### Skipping validations
 
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and
@@ -287,5 +296,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/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,
@@ -129,6 +135,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 +218,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/syncer.rb

@@ -139,7 +139,8 @@ module Kennel
     def ensure_all_ids_found
       @expected.each do |e|
         next unless id = e.id
-        raise "Unable to find existing #{e.class.api_resource} with id #{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."
       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.0"
+  VERSION = "1.79.0"
 end

data/template/Readme.md

@@ -66,7 +66,7 @@ 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`
+ - 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=`
  - 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
@@ -180,6 +180,15 @@ end
   end
  ```
 
+### Updating existing resources with id
+
+Setting `id` makes kennel take over a manually created datadog resource.
+When manually creating to import, it is best to remove the `id` and delete the manually created resource.
+
+When an `id` is set and the original resource is deleted, kennel will fail to update,
+removing the `id` will cause kennel to create a new resource in datadog.
+
+
 ### Skipping validations
 
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and

metadata

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