kennel 1.61.5 → 1.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c170afd5f8bc8223b9b7d37bf48a1de593d643fa7de785ec8fc26e631bcdf81c
-  data.tar.gz: 89ec3660c0b7a1022a104a6d6b51eda9ec3291a1bb9cf46d2ae303597e66c30b
+  metadata.gz: 9f80b8b4232aa41c2b405d35ebb4377a6292e6278ab9261fb2ee36a13e9577e2
+  data.tar.gz: 9e677dee555faaab7b3be0cc58d341f5b36a4cf078a30dc79bf7f5210d9f01b5
 SHA512:
-  metadata.gz: a68a43cf73743f9f098259dd5c614cdc6ced148d08cf629907f090689804148e01e857a4434f9410607fec338e3cca50f883e4dfe31200e48b80dffbbb7ff379
-  data.tar.gz: d5c5bf8a43c526611162267d6c4babb64a57aab4d0eddbb0cbf9e1fb507f0066528c6e82f7651911fdfd86d74c6ae520b634c7b0de1b799d8d55a1c695f0e457
+  metadata.gz: a99873dc872ff3c0af64d4ef4bfa04b3822e75a25dc1b4a08c62b4382476f5b68d5d8a80e621e301d7f8ca470c9d899afb68ebb37d28043bc4820b298d9d8cb1
+  data.tar.gz: 3b1ae467dd9845b826a0c0b5bd03f2352e07c80108404c5d7ff818cf6e207de60a1378627b222f5c93e6d585d3eb44c51f56fb7ab21e92c44f4394c94e60bbdb

data/Readme.md

@@ -2,11 +2,12 @@
 
 ![](template/github/cage.jpg?raw=true)
 
-Keep datadog monitors/dashboards/etc in version control, avoid chaotic management via UI.
+Manage datadog monitors/dashboards/slos as code
 
- - Documented, reusable, automated, and searchable configuration
+ - Documented, reusable, and searchable
  - Changes are PR reviewed and auditable
- - Automated deletion when removed from code
+ - Updating shows diff before applying
+ - Automated import of existing monitors/dashboards/slos
 
 ![](template/github/screen.png?raw=true)
 <!-- NOT IN template/Readme.md  -->
@@ -183,6 +184,14 @@ Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a
 
 `rake kennel:validate_mentions` should run as part of CI
 
+### Grepping through all of datadog
+
+`TYPE=monitor rake kennel:dump`
+
+### Find all monitors with No-Data
+
+`rake kennel:nodata TAG=team:foo`
+
 ## Examples
 
 ### Reusable monitors/dashes/etc
@@ -219,10 +228,10 @@ end
 ```Bash
 rake play
 cd template
-rake kennel:plan
+rake plan
 ```
 
-Then make changes to play around, do not commit changes and make sure to revert with a `rake kennel:update` after deleting everything.
+Then make changes to play around, do not commit changes and make sure to revert with a `rake kennel:update_datadog` after deleting everything.
 
 To make changes via the UI, make a new free datadog account and use it's credentaisl instead.
 

data/lib/kennel/api.rb

@@ -43,12 +43,12 @@ module Kennel
     end
 
     def delete(api_resource, id)
-      request :delete, "/api/v1/#{api_resource}/#{id}"
+      request :delete, "/api/v1/#{api_resource}/#{id}", ignore_404: true
     end
 
     private
 
-    def request(method, path, body: nil, params: {})
+    def request(method, path, body: nil, params: {}, ignore_404: false)
       params = params.merge(application_key: @app_key, api_key: @api_key)
       query = Faraday::FlatParamsEncoder.encode(params)
       response = nil
@@ -66,7 +66,7 @@ module Kennel
         Kennel.err.puts "Retrying on server error #{response.status} for #{path}"
       end
 
-      unless response.success?
+      if !response.success? && (response.status != 404 || !ignore_404)
         message = +"Error #{response.status} during #{method.upcase} #{path}\n"
         message << "request:\n#{JSON.pretty_generate(body)}\nresponse:\n" if body
         message << response.body

data/lib/kennel/file_cache.rb

@@ -32,11 +32,12 @@ module Kennel
     private
 
     def load_data
-      @data = begin
-        Marshal.load(File.read(@file)) # rubocop:disable Security/MarshalLoad
-      rescue StandardError
-        {}
-      end
+      @data =
+        begin
+          Marshal.load(File.read(@file)) # rubocop:disable Security/MarshalLoad
+        rescue StandardError
+          {}
+        end
     end
 
     def persist

data/lib/kennel/github_reporter.rb

@@ -7,13 +7,13 @@ module Kennel
     class << self
       def report(token, &block)
         return yield unless token
-        new(token).report(&block)
+        new(token, Utils.capture_sh("git rev-parse HEAD").strip).report(&block)
       end
     end
 
-    def initialize(token)
+    def initialize(token, git_sha)
       @token = token
-      @git_sha = Utils.capture_sh("git rev-parse HEAD").strip
+      @git_sha = git_sha
       origin = ENV["PROJECT_REPOSITORY"] || Utils.capture_sh("git remote -v").split("\n").first
       @repo_part = origin[%r{github\.com[:/](.+?)(\.git|$)}, 1] || raise("no origin found")
     end
@@ -27,8 +27,6 @@ module Kennel
       comment "```\n#{output || "Error"}\n```"
     end
 
-    private
-
     # https://developer.github.com/v3/repos/comments/#create-a-commit-comment
     def comment(body)
       # truncate to maximum allowed comment size for github to avoid 422
@@ -39,6 +37,8 @@ module Kennel
       post "commits/#{@git_sha}/comments", body: body
     end
 
+    private
+
     def post(path, data)
       url = "https://api.github.com/repos/#{@repo_part}/#{path}"
       response = Faraday.post(url, data.to_json, authorization: "token #{@token}")

data/lib/kennel/models/base.rb

@@ -21,7 +21,7 @@ module Kennel
         self.class.name
       end
 
-      def to_json
+      def to_json # rubocop:disable Lint/ToJSON
         raise NotImplementedError, "Use as_json"
       end
     end

data/lib/kennel/models/monitor.rb

@@ -8,7 +8,7 @@ module Kennel
       QUERY_INTERVALS = ["1m", "5m", "10m", "15m", "30m", "1h", "2h", "4h", "1d"].freeze
       OPTIONAL_SERVICE_CHECK_THRESHOLDS = [:ok, :warning].freeze
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
-        :multi, :matching_downtimes, :overall_state_modified, :overall_state
+        :multi, :matching_downtimes, :overall_state_modified, :overall_state, :restricted_roles
       ]
 
       # defaults that datadog uses when options are not sent, so safe to leave out if our values match their defaults
@@ -35,7 +35,7 @@ module Kennel
         ok: -> { nil },
         id: -> { nil },
         notify_no_data: -> { true },
-        no_data_timeframe: -> { notify_no_data ? 60 : nil },
+        no_data_timeframe: -> { 60 },
         notify_audit: -> { true },
         new_host_delay: -> { MONITOR_OPTION_DEFAULTS.fetch(:new_host_delay) },
         tags: -> { @project.tags },
@@ -57,7 +57,7 @@ module Kennel
           options: {
             timeout_h: timeout_h,
             notify_no_data: notify_no_data,
-            no_data_timeframe: no_data_timeframe,
+            no_data_timeframe: notify_no_data ? no_data_timeframe : nil,
             notify_audit: notify_audit,
             require_full_window: require_full_window,
             new_host_delay: new_host_delay,

data/lib/kennel/models/slo.rb

@@ -6,11 +6,12 @@ module Kennel
       DEFAULTS = {
         description: nil,
         query: nil,
+        groups: nil,
         monitor_ids: [],
         thresholds: []
       }.freeze
 
-      settings :type, :description, :thresholds, :query, :tags, :monitor_ids, :monitor_tags, :name
+      settings :type, :description, :thresholds, :query, :tags, :monitor_ids, :monitor_tags, :name, :groups
 
       defaults(
         id: -> { nil },
@@ -18,7 +19,8 @@ module Kennel
         query: -> { DEFAULTS.fetch(:query) },
         description: -> { DEFAULTS.fetch(:description) },
         monitor_ids: -> { DEFAULTS.fetch(:monitor_ids) },
-        thresholds: -> { DEFAULTS.fetch(:thresholds) }
+        thresholds: -> { DEFAULTS.fetch(:thresholds) },
+        groups: -> { DEFAULTS.fetch(:groups) }
       )
 
       def initialize(*)
@@ -39,8 +41,15 @@ module Kennel
           type: type
         }
 
-        data[:query] = query if query
-        data[:id] = id if id
+        if v = query
+          data[:query] = v
+        end
+        if v = id
+          data[:id] = v
+        end
+        if v = groups
+          data[:groups] = v
+        end
 
         @as_json = data
       end

data/lib/kennel/tasks.rb

@@ -119,6 +119,13 @@ namespace :kennel do
     puts Kennel::Importer.new(Kennel.send(:api)).import(resource, id)
   end
 
+  desc "Dump ALL of datadog config as raw json ... useful for grep/search TYPE=slo|monitor|dashboard"
+  task dump: :environment do
+    Kennel.send(:api).list(ENV.fetch("TYPE")).each do |r|
+      Kennel.out.puts JSON.pretty_generate(r)
+    end
+  end
+
   task :environment do
     require "kennel"
     gem "dotenv"

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -2,11 +2,12 @@
 
 ![](github/cage.jpg?raw=true)
 
-Keep datadog monitors/dashboards/etc in version control, avoid chaotic management via UI.
+Manage datadog monitors/dashboards/slos as code
 
- - Documented, reusable, automated, and searchable configuration
+ - Documented, reusable, and searchable
  - Changes are PR reviewed and auditable
- - Automated deletion when removed from code
+ - Updating shows diff before applying
+ - Automated import of existing monitors/dashboards/slos
 
 ![](github/screen.png?raw=true)
 
@@ -165,6 +166,14 @@ Run `rake kennel:alerts TAG=service:my-service` to see all un-muted alerts for a
 
 `rake kennel:validate_mentions` should run as part of CI
 
+### Grepping through all of datadog
+
+`TYPE=monitor rake kennel:dump`
+
+### Find all monitors with No-Data
+
+`rake kennel:nodata TAG=team:foo`
+
 ## Examples
 
 ### Reusable monitors/dashes/etc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.61.5
+  version: 1.65.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday