kennel 1.52.0 → 1.55.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d34d639d4d27f3953211bc4f94f36d559b5ada87d3f289219bf611c8183805d
-  data.tar.gz: c531670c166981073648ae9e12f1ca6c47f27a5642a4b8abf0fc5890134bcead
+  metadata.gz: 6e23afaba22ded8b1fb654a9552ed135247cb3a9a5c5610090bfa9096123ffb4
+  data.tar.gz: 7e4096a43a6fcd52f519131c2238879f2eb551d90c5883a9d5e1e8996f90075c
 SHA512:
-  metadata.gz: 5e4f308f0076d4cc5f290c5041fc37a57a64986fb1d0ec586bf448b9293880fd42e67b6d6de60607369f2918efc7aeb87177fd7a27a1749ca272fdb2c5519d0f
-  data.tar.gz: e1852e1d4c0cceb841f73559ae248357ce5d1fdfe81e3d8a0a348374d2f1e6819befbc9fcdec0caae00cc72808430f91fd10d46b7dd88fe57b721faf55e1d882
+  metadata.gz: bb7d4a1e6f48f645e220169bcabac5ae8fed56f01033a63be6ea855e5308e62ec3d31a4c9326823d99e973d85056f1151a1924ae33ced07b620224b1e716eb8b
+  data.tar.gz: 7bb59bc7ca8bd3b024903c61bdc11c4f816d9fca0fc666cae36dcdb6258d660608ba6cfe16ccbf1877957c54eb9e9feda437055d44fe4f5a3e0abe701623680d

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(
@@ -172,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
@@ -196,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/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 },

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,36 @@ 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}" }
+      abort
+    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.52.0"
+  VERSION = "1.55.1"
 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.52.0
+  version: 1.55.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday