dogwatch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d79c2c09e6613e01aebac074584db2d77fb0cec
+  data.tar.gz: a45e5c711c68224dae11e425b249e60ba2e56862
+SHA512:
+  metadata.gz: e61f782beb109454fc226473554a4da0c00b0e809c598228215be23bd00f7c3d85e3623dea6bb27a17e917c5772c72b4036a42c995da1db51badcf8f23ce2a35
+  data.tar.gz: e6ed10925ee458aec58a752fcae1680e113cc628e5914d5c1c087b0881012a2a403da9f7eb0c45de430d4bafa9bcb8f59857ade2f296b2297a0b9600e5b0b8fc

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+.DS_Store
+mkmf.log
+
+keys
+VERSION
+attic

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - lib/**/*
+    - bin/**/*
+    - test/**/*
+    - Gemfile
+    - Rakefile
+    - Thorfile
+  Exclude:
+    - example/**/*
+    - test/data/*
+
+Encoding:
+ Enabled: false
+RescueModifier:
+ Enabled: false
+HashSyntax:
+ Enabled: false
+SpaceInsideStringInterpolation:
+  Enabled: false
+DoubleNegation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,25 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-12-02 13:53:58 -0500 using RuboCop version 0.34.2.
+# 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: 2
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 83
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Exclude:
+    - 'dogwatch.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'lib/dogwatch/version.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in convection.gemspec
+gemspec
+
+group :development do
+  gem 'bundler', '~> 1.7'
+  gem 'minitest'
+  gem 'minitest-reporters', '>= 0.5.0'
+  gem 'rake', '~> 10.0'
+  gem 'rubocop', '~> 0.34'
+  gem 'simplecov'
+  gem 'thor-scmversion', '= 1.7.0'
+end

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 David Greene, Rapid7 LLC.
+
+MIT License
+===========
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# DogWatch
+
+_A DSL to create DataDog monitors_
+
+This gem is designed to provide a simple method for creating DataDog monitors in Ruby.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dogwatch'
+```
+
+And then execute:
+```shell
+$ bundle exec dogwatch create [--dogfile=DOGFILE] [--api_key=API KEY] [--app_key=APP KEY]
+```
+Or install it yourself as:
+```shell
+$ gem install dogwatch
+```
+
+## Credentials
+[DataDog API credentials](https://app.datadoghq.com/account/settings#api) are required.
+
+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.
+## Usage
+
+DogWatch is a thin DSL over the [DataDog ruby client](https://github.com/DataDog/dogapi-rb) that handles generating DataDog monitors.
+
+The following is an example of a `Dogfile`:
+```ruby
+require 'dogwatch'
+
+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
+    message 'MESSAGE'
+    tags %w(A list of tags to associate with your monitor)
+
+    options do
+      silenced '*': nil
+      notify_no_data false
+      no_data_timeframe 3
+      timeout_h 99
+      renotify_interval 60
+      escalation_message 'oh snap'
+      include_tags true
+    end
+  end
+end
+```
+
+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.
+
+A sample `Dogfile` is provided in the `example` directory.
+
+For a full list of options and a description of each parameter, see [DataDog's API documentation](http://docs.datadoghq.com/api/#monitors).
+
+## TO DO
+* More descriptive errors
+* Better error handling if a monitor fails local validation

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rake/testtask'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+end
+
+task :default => [:test, :rubocop]

data/Thorfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'bundler/setup'
+require 'thor/scmversion'

data/bin/dogwatch

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'thor'
+require 'dogwatch/dogfile'
+
+module DogWatch
+  ##
+  # DogWatch CLI
+  ##
+  class CLI < Thor
+    class_option :dogfile, :type => :string, :default => 'Dogfile'
+    class_option :api_key, :type => :string, :default => nil
+    class_option :app_key, :type => :string, :default => nil
+    def initialize(*args)
+      super
+      @cwd = Dir.getwd
+      @dogfile = DogWatch::DogFile.new
+    end
+
+    desc 'create', 'Create a monitor from a Dogfile'
+    def create
+      @dogfile.configure(File.absolute_path(options['dogfile'], @cwd),
+                         options['api_key'], options['app_key'])
+      @dogfile.create { |c| say_status(*c.to_thor) }
+    end
+  end
+end
+
+DogWatch::CLI.start(ARGV)

data/dogwatch.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dogwatch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dogwatch'
+  spec.version       = DogWatch::VERSION
+  spec.authors       = ['David Greene']
+  spec.email         = ['David_Greene@rapid7.com']
+  spec.summary       = DogWatch::SUMMARY
+  spec.description   = DogWatch::DESCRIPTION
+  spec.homepage      = 'https://github.com/rapid7/dogwatch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dogapi', '~> 1.21'
+  spec.add_runtime_dependency 'thor', '~> 0.19'
+end

data/example/Dogfile

@@ -0,0 +1,23 @@
+require_relative '../lib/dogwatch'
+
+DogWatch.monitor do
+  monitor 'test_alert' do
+    type :metric_alert
+    query 'avg(last_1m):avg:system.cpu.user{region:us-east-1} > 20'
+    message 'A message to include with notifications for this monitor.'\
+            'Email notifications can be sent to specific users by '\
+            'using the same \'@username\' notation as events.'
+
+    tags %w(A list of tags to associate with your monitor)
+
+    options do
+      silenced '*': nil
+      notify_no_data false
+      no_data_timeframe 3
+      timeout_h 99
+      renotify_interval 60
+      escalation_message 'oh snap'
+      include_tags true
+    end
+  end
+end

data/example/credentials.example

@@ -0,0 +1,2 @@
+api_key: YOUR API KEY
+app_key: YOUR APP KEY

data/lib/dogwatch.rb

@@ -0,0 +1,13 @@
+##
+# Root module
+##
+module DogWatch
+  class << self
+    def monitor(*args, &block)
+      DogWatch::Monitor.new(*args, &block)
+    end
+  end
+end
+
+require_relative 'dogwatch/version'
+require_relative 'dogwatch/monitor'

data/lib/dogwatch/dogfile.rb

@@ -0,0 +1,27 @@
+require_relative 'model/config'
+require_relative 'model/client'
+
+module DogWatch
+  ##
+  # Manage the execution of the Dogfile
+  ##
+  class DogFile
+    # @param [String] dogfile
+    # @param [String|Object] api_key
+    # @param [String|Object] app_key
+    def configure(dogfile, api_key = nil, app_key = nil)
+      @dogfile = dogfile
+      @config = DogWatch::Model::Config.new(api_key, app_key)
+    end
+
+    # @param [Proc] block
+    def create(&block)
+      monitor = instance_eval(IO.read(@dogfile), @dogfile, 1)
+      monitor.config = @config
+      monitor.client
+
+      monitor.get
+      monitor.responses.each { |r| block.call(r) }
+    end
+  end
+end

data/lib/dogwatch/model/client.rb

@@ -0,0 +1,92 @@
+require 'dogapi'
+require_relative 'config'
+require_relative 'response'
+
+module DogWatch
+  module Model
+    ##
+    # Client interface for the DataDog API
+    ##
+    class Client
+      attr_accessor :client
+      attr_accessor :config
+      attr_reader :response
+
+      # @param [DogWatch::Model::Config] config
+      def initialize(config)
+        @config = config
+        @client = Dogapi::Client.new(@config.api_key, @config.app_key)
+        @all_monitors = all_monitors
+      end
+
+      # @param [DogWatch::Model::Monitor] monitor
+      def execute(monitor)
+        if monitor_exists?(monitor.name)
+          update_monitor(monitor)
+        else
+          new_monitor(monitor)
+        end
+      end
+
+      # @param [DogWatch::Model::Monitor] monitor
+      # @return [DogWatch::Model::Response]
+      def update_monitor(monitor)
+        options = options(monitor)
+        existing_monitor = get_monitor(monitor.name)
+        response = @client.update_monitor(existing_monitor['id'],
+                                          monitor.attributes.query,
+                                          options)
+        updated = %w(200 202).include?(response[0])
+        @response = DogWatch::Model::Response.new(response, updated)
+      end
+
+      # @param [DogWatch::Model::Monitor] monitor
+      # @return [DogWatch::Model::Response]
+      def new_monitor(monitor)
+        options = options(monitor)
+        response = @client.monitor(monitor.attributes.type,
+                                   monitor.attributes.query,
+                                   options)
+        @response = DogWatch::Model::Response.new(response)
+      end
+
+      private
+
+      # @param [DogWatch::Model::Monitor] monitor
+      # @return [Hash]
+      def options(monitor)
+        {
+          name: monitor.name,
+          message: monitor.attributes.message,
+          tags: monitor.attributes.tags,
+          options: monitor.attributes.options
+        }
+      end
+
+      # @param [String] name
+      # @return [TrueClass|FalseClass]
+      def monitor_exists?(name)
+        @all_monitors.count { |m| m['name'] == name } > 0
+      end
+
+      # @param [String] name
+      # @return [Hash]
+      def get_monitor(name)
+        @all_monitors.find { |m| m['name'] == name }
+      end
+
+      # @return [Array]
+      def all_monitors
+        response = @client.get_all_monitors if @all_monitors.nil?
+        @all_monitors = response[1] if response[0] == '200'
+        @all_monitors
+      end
+
+      # @return [DogWatch::Model::Config]
+      def config
+        @config = DogWatch::Model::Config.new if @config.nil?
+        @config
+      end
+    end
+  end
+end

data/lib/dogwatch/model/config.rb

@@ -0,0 +1,36 @@
+require 'yaml'
+
+module DogWatch
+  module Model
+    ##
+    # Manages API configuration. Currently handles
+    # credential only.
+    ##
+    class Config
+      attr_accessor :api_key
+      attr_accessor :app_key
+
+      # @param [String] api_key
+      # @param [String] app_key
+      def initialize(api_key = nil, app_key = nil)
+        @api_key = api_key unless api_key.nil?
+        @app_key = app_key unless app_key.nil?
+        return unless app_key.nil? || api_key.nil?
+
+        from_file
+      end
+
+      def from_file
+        begin
+          config_file = IO.read("#{Dir.home}/.dogwatch/credentials")
+        rescue
+          raise('No credentials supplied')
+        end
+
+        credentials = YAML.load(config_file)
+        @api_key = credentials['api_key']
+        @app_key = credentials['app_key']
+      end
+    end
+  end
+end