kennel 1.51.0 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf65db42c0f1dbd43a7f2a6d0910a018565db65e431cea3c39b88d796b1ccce0
-  data.tar.gz: 1d0db8fca3e1f1b9d4085ae1e783b2b6f28a0ae3682ba9b2b743612b1b71b5dc
+  metadata.gz: adc230a06e4f7f969147e0c299ba61c4536d5623de432cfe3e247bece944962a
+  data.tar.gz: ae6d3ebe5db8fe7a5f406cda15e0a85d8a19b8d5f991a9787a63376a01572e70
 SHA512:
-  metadata.gz: a774657cac63f4080d9767453ccf5e9c301aaaf2cae15486e26f87e54c851dc9246421cb6aa16f585a7311748dc6031ed6a65124c1cf01d19669ca1604ff78ab
-  data.tar.gz: a922269b47847376d1287e42a06aed1fe4fdbab3c0a8f550f9983fe1d2823314c186e3f809dbb2ea607446d67fd6f168d28e113dd8f0d33428ead5979deae804
+  metadata.gz: 3013cb61dd5c33a7dd1772b54645d62e7cf7e70bb5202f85950ab4f2a102e723d1583725200da513a54d66020af14ca9c57b63bc50e43b1a27a4d765d478c2fb
+  data.tar.gz: 28f5812c2795043927ca2161712d6e16f100cf6999e21fc64c3ee8e557d663c526a30dc9eef3069d2f229a699304d5f1029eb61176c3c51f4f825f5a45ac9e56

data/Readme.md

@@ -42,19 +42,23 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
  - `gem install bundler && bundle install`
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
- - find or create your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=` (will be on the last page if new)
  - 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
 -->
 
 ### Adding a team
 
+ - `mention` is used for all team monitors via `super()`
+ - `renotify_interval` is used for all team monitors (defaults to `0` / off)
+ - `tags` is used for all team monitors/dashboards (defaults to `team:<team-name>`)
+
 ```Ruby
 # teams/my_team.rb
 module Teams
   class MyTeam < Kennel::Models::Team
     defaults(
-      slack: -> { "my-alerts" },
-      email: -> { "my-team@example.com" }
+      mention: -> { "@slack-my-team" }
     )
   end
 end
@@ -62,13 +66,14 @@ end
 
 ### Adding a new monitor
  - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to create a monitor
- - get the `id` from the url
- - `RESOURCE=monitor ID=12345 bundle exec rake kennel:import`
  - see below
 
 ### Updating an existing monitor
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to find a monitor
+ - get the `id` from the url
+ - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
- - add a monitor to `parts: [` list
+ - add the monitor to `parts: [` list, for example:
   ```Ruby
   # projects/my_project.rb
   class MyProject < Kennel::Models::Project
@@ -83,7 +88,8 @@ end
             kennel_id: -> { "load-too-high" }, # make up a unique name
             name: -> { "Foobar Load too high" }, # nice descriptive name that will show up in alerts and emails
             message: -> {
-              # Explain what behavior to expect and how to fix the cause. Use #{super()} to add team notifications.
+              # Explain what behavior to expect and how to fix the cause
+              # Use #{super()} to add team notifications.
               <<~TEXT
                 Foobar will be slow and that could cause Barfoo to go down.
                 Add capacity or debug why it is suddenly slow.
@@ -98,21 +104,22 @@ end
     )
   end
   ```
- - `bundle exec rake plan` update to existing should be shown (not Create / Delete)
- - alternatively: `bundle exec rake generate` to only update the generated `json` files
+ - run `PROJECT=my_project bundle exec rake plan`, an Update to the existing monitor should be shown (not Create / Delete)
+ - alternatively: `bundle exec rake generate` to only locally update the generated `json` files
  - review changes then `git commit`
  - make a PR ... get reviewed ... merge
  - datadog is updated by travis
 
 ### Adding a new dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
- - get the `id` from the url
- - `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import`
  - see below
 
 ### Updating an existing dashboard
+ - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to find a dashboard
+ - get the `id` from the url
+ - run `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
- - add a dashboard to `parts: [` list
+ - add a dashboard to `parts: [` list, for example:
   ```Ruby
   class MyProject < Kennel::Models::Project
     defaults(
@@ -160,6 +167,7 @@ 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
 
@@ -171,6 +179,10 @@ To link to existing monitors via their kennel_id
 
 Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a given datadog monitor tag.
 
+### Validating mentions work
+
+`rake kennel:validate_mentions` should run as part of CI
+
 ## Examples
 
 ### Reusable monitors/dashes/etc
@@ -195,7 +207,7 @@ Reuse it in multiple projects.
 ```Ruby
 class Database < Kennel::Models::Project
   defaults(
-    team: -> { Kennel::Models::Team.new(slack: -> { 'foo' }, kennel_id: -> { 'foo' }) },
+    team: -> { Kennel::Models::Team.new(mention: -> { '@slack-foo' }, kennel_id: -> { 'foo' }) },
     parts: -> { [Monitors::LoadTooHigh.new(self, critical: -> { 13 })] }
   )
 end

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

@@ -101,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
@@ -113,6 +115,10 @@ module Kennel
 
       private
 
+      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"}, ...], }
@@ -127,16 +133,6 @@ module Kennel
         end
       end
 
-      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
-
       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
@@ -27,9 +27,9 @@ module Kennel
       )
 
       defaults(
-        message: -> { "\n\n@slack-#{project.slack}" },
+        message: -> { "\n\n#{project.mention}" },
         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/project.rb

@@ -2,10 +2,10 @@
 module Kennel
   module Models
     class Project < Base
-      settings :team, :parts, :tags, :slack
+      settings :team, :parts, :tags, :mention
       defaults(
         tags: -> { ["service:#{kennel_id}"] + team.tags },
-        slack: -> { team.slack }
+        mention: -> { team.mention }
       )
 
       def self.file_location

data/lib/kennel/models/team.rb

@@ -2,19 +2,11 @@
 module Kennel
   module Models
     class Team < Base
-      settings :slack, :email, :tags, :kennel_id
+      settings :mention, :tags, :renotify_interval, :kennel_id
       defaults(
-        tags: -> { ["team:#{kennel_id.sub(/^teams_/, "")}"] }
+        tags: -> { ["team:#{kennel_id.sub(/^teams_/, "")}"] },
+        renotify_interval: -> { 0 }
       )
-
-      def initialize(*)
-        super
-        invalid! "remove leading # from slack" if slack.to_s.start_with?("#")
-      end
-
-      def tracking_id
-        kennel_id
-      end
     end
   end
 end

data/lib/kennel/tasks.rb

@@ -12,6 +12,35 @@ namespace :kennel do
     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)
+  # https://help.datadoghq.com/hc/en-us/requests/254114 for automatic validation
+  desc "Verify that all used monitor  mentions are valid"
+  task validate_mentions: :environment do
+    known = Kennel.send(:api)
+      .send(:request, :get, "/monitor/notifications")
+      .fetch(:handles)
+      .values
+      .flatten(1)
+      .map { |v| v.fetch(:value) }
+
+    known += ENV["KNOWN"].to_s.split(",")
+
+    bad = []
+    Dir["generated/**/*.json"].each do |f|
+      next unless message = JSON.parse(File.read(f))["message"]
+      used = message.scan(/\s(@[^\s{,'"]+)/).flatten(1)
+        .grep(/^@.*@|^@.*-/) # ignore @here etc handles ... datadog uses @foo@bar.com for emails and @foo-bar for integrations
+      (used - known).each { |v| bad << [f, v] }
+    end
+
+    if bad.any?
+      subdomain = ENV["DATADOG_SUBDOMAIN"]
+      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}" }
+    end
+  end
+
   desc "generate local definitions"
   task generate: :environment do
     Kennel.generate

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -25,18 +25,22 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
  - `gem install bundler && bundle install`
  - `cp .env.example .env`
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
- - find or create your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=` (will be on the last page if new)
  - 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
 
 ### Adding a team
 
+ - `mention` is used for all team monitors via `super()`
+ - `renotify_interval` is used for all team monitors (defaults to `0` / off)
+ - `tags` is used for all team monitors/dashboards (defaults to `team:<team-name>`)
+
 ```Ruby
 # teams/my_team.rb
 module Teams
   class MyTeam < Kennel::Models::Team
     defaults(
-      slack: -> { "my-alerts" },
-      email: -> { "my-team@example.com" }
+      mention: -> { "@slack-my-team" }
     )
   end
 end
@@ -44,13 +48,14 @@ end
 
 ### Adding a new monitor
  - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to create a monitor
- - get the `id` from the url
- - `RESOURCE=monitor ID=12345 bundle exec rake kennel:import`
  - see below
 
 ### Updating an existing monitor
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to find a monitor
+ - get the `id` from the url
+ - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
- - add a monitor to `parts: [` list
+ - add the monitor to `parts: [` list, for example:
   ```Ruby
   # projects/my_project.rb
   class MyProject < Kennel::Models::Project
@@ -65,7 +70,8 @@ end
             kennel_id: -> { "load-too-high" }, # make up a unique name
             name: -> { "Foobar Load too high" }, # nice descriptive name that will show up in alerts and emails
             message: -> {
-              # Explain what behavior to expect and how to fix the cause. Use #{super()} to add team notifications.
+              # Explain what behavior to expect and how to fix the cause
+              # Use #{super()} to add team notifications.
               <<~TEXT
                 Foobar will be slow and that could cause Barfoo to go down.
                 Add capacity or debug why it is suddenly slow.
@@ -80,21 +86,22 @@ end
     )
   end
   ```
- - `bundle exec rake plan` update to existing should be shown (not Create / Delete)
- - alternatively: `bundle exec rake generate` to only update the generated `json` files
+ - run `PROJECT=my_project bundle exec rake plan`, an Update to the existing monitor should be shown (not Create / Delete)
+ - alternatively: `bundle exec rake generate` to only locally update the generated `json` files
  - review changes then `git commit`
  - make a PR ... get reviewed ... merge
  - datadog is updated by travis
 
 ### Adding a new dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
- - get the `id` from the url
- - `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import`
  - see below
 
 ### Updating an existing dashboard
+ - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to find a dashboard
+ - get the `id` from the url
+ - run `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
- - add a dashboard to `parts: [` list
+ - add a dashboard to `parts: [` list, for example:
   ```Ruby
   class MyProject < Kennel::Models::Project
     defaults(
@@ -142,6 +149,7 @@ 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
 
@@ -177,7 +185,7 @@ Reuse it in multiple projects.
 ```Ruby
 class Database < Kennel::Models::Project
   defaults(
-    team: -> { Kennel::Models::Team.new(slack: -> { 'foo' }, kennel_id: -> { 'foo' }) },
+    team: -> { Kennel::Models::Team.new(mention: -> { '@slack-foo' }, kennel_id: -> { 'foo' }) },
     parts: -> { [Monitors::LoadTooHigh.new(self, critical: -> { 13 })] }
   )
 end

metadata

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