dogwatch 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8bfbcdfb0801515397ad4fab5704b91553df293
-  data.tar.gz: aebfc2813f248bd6c059433e45cf0e44aabb974f
+  metadata.gz: f80269f35dd247c32ccb1374d0eaedce141a7cc8
+  data.tar.gz: ed05ffaa074d3e0601ccf05a45d0ae7964b290f9
 SHA512:
-  metadata.gz: 394be276eb74c9c143511fa8a18d9a72deb5b4a06cfebcfddb7ea0e63b2aa0d5a83fe471bfdcaa7f616d5feb551fedcecd185e19c8a797fae370253d9abee821
-  data.tar.gz: 02a830c39d3011a0ed3ac23a4e2977803b481161651d9883ec7ec838b4dae0d961e6b123d4dbe783b58267cb450878d1262cdec543946e1f3cd083da0a9ad2c9
+  metadata.gz: 34e1af8b2a7dec826c40e73da89758d9ede5e58c7f36fab4764a304067ad9e5934ba7f1f643f1c1b325139cdd8ed28a2af0212335f9cffec9582ff9fd0edf331
+  data.tar.gz: 9219b3221a629b8d60f4ed27893057db5cd105e681a80aa508f7d98df847b765e77cda98ee5f3a39929c57534aa62bb304bf4c3fc8d91278850086eb1e62022c

data/.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
   Exclude:
     - example/**/*
     - test/data/*
+  TargetRubyVersion: 2.2
 
 Encoding:
  Enabled: false
@@ -21,4 +22,4 @@ HashSyntax:
 SpaceInsideStringInterpolation:
   Enabled: false
 DoubleNegation:
-  Enabled: false
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,12 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-12-11 13:32:10 -0500 using RuboCop version 0.35.1.
+# on 2016-06-01 14:50:11 +0100 using RuboCop version 0.40.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 4
-# Configuration parameters: AllowURI, URISchemes.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 90
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/RedundantBlockCall:
+  Exclude:
+    - 'lib/dogwatch/dogfile.rb'

data/README.md

@@ -26,6 +26,8 @@ $ gem install dogwatch
 Generate both an api key and an app key and either place them in a file named `~/.dogwatch/credentials` or pass them via the command line.
 
 A sample credentials file is provided in the `example` directory.
+
+In order to generate these keys, log into your Datadog account.  From there, click on 'Integrations->APIs'.  Keep in mind, your org may be allowed only five API Keys.
 ## Usage
 
 DogWatch is a thin DSL over the [DataDog ruby client](https://github.com/DataDog/dogapi-rb) that handles generating DataDog monitors.
@@ -36,7 +38,7 @@ DogWatch.monitor do
   ## Create a new monitor - monitor name is REQUIRED
   monitor 'MONITOR NAME' do
     type :metric_alert # REQUIRED: One of [:metric_alert | :service_check | :event_alert]
-    query 'QUERY' # REQUIRED
+    query 'time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator' # REQUIRED
     message 'MESSAGE'
     tags %w(A list of tags to associate with your monitor)
 
@@ -52,6 +54,18 @@ DogWatch.monitor do
   end
 end
 ```
+Queries are the combination of several items including a time aggregator (over a window of time), space aggregator (avg, sum, min, or max), a set of tags and an optional order by, and an operator.
+
+From the Datadog documentation:
+
+```
+time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator 
+```
+An example of a query:
+
+```
+avg(last_15m):avg:system.disk.used{region:us-east-1,some-tag:some-tag-value,device:/dev/xvdb} by {cluster} * 100 > 55
+```
 
 Monitors that already exist are matched by name and updated accordingly. If the name isn't matched exactly, DogWatch assumes you want a new monitor.
 
@@ -61,4 +75,4 @@ For a full list of options and a description of each parameter, see [DataDog's A
 
 ## TO DO
 * More descriptive errors
-* Better error handling if a monitor fails local validation
+* Better error handling if a monitor fails local validation

data/lib/dogwatch/model/monitor.rb

@@ -11,7 +11,7 @@ module DogWatch
         metric_alert: 'metric alert',
         service_check: 'service check',
         event_alert: 'event alert'
-      }
+      }.freeze
 
       attr_reader :name
       attr_reader :attributes
@@ -26,6 +26,7 @@ module DogWatch
       # @param [Symbol] type
       # @return [String]
       def type(type)
+        @monitor_type = type
         @attributes.type = TYPE_MAP[type]
       end
 
@@ -50,7 +51,7 @@ module DogWatch
       # @param [Proc] block
       # @return [Hash]
       def options(&block)
-        opts = DogWatch::Model::Options.new
+        opts = DogWatch::Model::Options.new(@monitor_type)
         opts.instance_eval(&block)
         @attributes.options = opts.render
       end

data/lib/dogwatch/model/options.rb

@@ -6,10 +6,19 @@ module DogWatch
     # Handles the options block methods
     ##
     class Options
+      MONITOR_TYPE_OPTIONS_MAP = {
+        :metric_alert => [:thresholds].freeze,
+        :service_check => [:thresholds].freeze
+      }.freeze
+
       attr_reader :attributes
 
-      def initialize
+      # @param [Symbol] monitor_type the monitor type of monitor these
+      #   options belong to. This is used to validate monitor type
+      #   specific options such as thresholds.
+      def initialize(monitor_type = nil)
         @attributes = OpenStruct.new
+        @monitor_type = monitor_type
       end
 
       def render
@@ -55,6 +64,24 @@ module DogWatch
       def include_tags(include = true)
         @attributes.include_tags = !!include
       end
+
+      # @param [Hash{String=>Fixnum}] thresholds
+      def thresholds(thresholds)
+        validate_monitor_type_specific_option!(:thresholds)
+        @attributes.thresholds = thresholds
+      end
+
+      private
+
+      def validate_monitor_type_specific_option!(option)
+        options = Array(MONITOR_TYPE_OPTIONS_MAP[@monitor_type])
+        return true if options.include?(option)
+
+        # rubocop:disable Metrics/LineLength
+        message = "The #{@monitor_type.inspect} monitor type does not support #{option.inspect}."
+        message << " Did you mean one of #{options.join(', ')}?" if options.any?
+        raise NotImplementedError, message
+      end
     end
   end
 end

data/lib/dogwatch/model/response.rb

@@ -8,14 +8,13 @@ module DogWatch
     class Response
       extend Mixin::Colorize
 
-      ERROR = '400'
-      CREATED = '200'
-      ACCEPTED = '202'
+      ERROR = '400'.freeze
+      CREATED = '200'.freeze
+      ACCEPTED = '202'.freeze
       colorize(:action,
                :green => [:created, :accepted, :updated],
                :yellow => [],
-               :red => [:error]
-              )
+               :red => [:error])
 
       attr_accessor :response
 

data/lib/dogwatch/version.rb

@@ -1,6 +1,7 @@
 # nodoc
 module DogWatch
   VERSION = IO.read(File.expand_path('../../../VERSION', __FILE__)) rescue '0.0.1'
-  SUMMARY = 'A DSL to create DataDog Monitors'
+  SUMMARY = 'A DSL to create DataDog Monitors'.freeze
   DESCRIPTION = 'DogWatch provides a simple method for creating DataDog monitors in Ruby.'
+                .freeze
 end

data/test/dogwatch/test_client.rb

@@ -13,7 +13,7 @@ class TestClient < Minitest::Test
       type: 'metric alert',
       query: 'test query'
     ]
-  ]
+  ].freeze
 
   UPDATED_RESPONSE = [
     '200',
@@ -22,7 +22,7 @@ class TestClient < Minitest::Test
       type: :metric_alert,
       query: 'scheduled maintenance query'
     ]
-  ]
+  ].freeze
 
   def setup
     config = DogWatch::Model::Config.new('foo', 'bar')

data/test/dogwatch/test_options.rb

@@ -11,7 +11,7 @@ class TestOptions < Minitest::Test
     escalation_message: 'foobar',
     notify_audit: true,
     include_tags: false
-  }
+  }.freeze
 
   # rubocop:disable Metrics/AbcSize
   def setup
@@ -78,4 +78,25 @@ class TestOptions < Minitest::Test
     assert_equal OPTS, @options.render
     assert_kind_of Hash, @options.render
   end
+
+  def test_invalid_monitor_type_specific_option
+    @options = DogWatch::Model::Options.new(:event_alert)
+
+    assert_raises NotImplementedError do
+      @options.thresholds('critical' => 90, 'warning' => 80)
+    end
+  end
+
+  def test_valid_monitor_type_specific_option
+    @options = DogWatch::Model::Options.new(:metric_alert)
+
+    @options.thresholds('critical' => 90, 'warning' => 80)
+
+    actual = @options.attributes.thresholds
+    assert_includes actual, 'critical'
+    assert_equal actual['critical'], 90
+
+    assert_includes actual, 'warning'
+    assert_equal actual['warning'], 80
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogwatch
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - David Greene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi