interferon 0.1.0 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9fbb5fdb83e9978e96990983e1c815fd18e7cdc
+  data.tar.gz: 0d5b080a2ad8dbdd8a16edd1bcae27aadfb6c366
+SHA512:
+  metadata.gz: 542ec78306622d95e55f698f2c0b35b7f0a8365a8eb0f2f85d0faff851fd22f5ddaef5d5b5c2f8adf585f0a297d23f0684cf5293122073729bd326cd23dab530
+  data.tar.gz: 271d43056cc9be797fb8e4ae3f98d4370518481f71bcf4b1f0d749b09e1433e36666b9ca701439d4bc6167a9857a2c53977836131d7f5a55355e44fa6d140c9d

data/.rubocop.yml

@@ -0,0 +1,4 @@
+# REVIEWERS airbnb/security airbnb/rubocop
+
+inherit_from:
+  - .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,83 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 50000`
+# on 2017-06-05 13:58:15 -0700 using RuboCop version 0.41.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.
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+  Max: 6
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Enabled: false
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Enabled: false
+  Max: 5
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+  Max: 7
+
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Enabled: false
+  EnforcedStyle: nested
+  SupportedStyles:
+  - nested
+  - compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Enabled: false
+  EnforcedStyle: format
+  SupportedStyles:
+  - format
+  - sprintf
+  - percent
+
+# Offense count: 3
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Enabled: false
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  - has_
+  - have_
+
+
+Style/TrailingCommaInLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -1,7 +1,10 @@
+---
 language: ruby
 sudo: false
 cache: bundler
-script: bundle exec rspec
+script:
+- bundle exec rspec
+- bundle exec rubocop
 rvm:
   - 1.9.3
   - 2.1.10

data/bin/interferon

@@ -4,13 +4,13 @@ require 'yaml'
 require 'optparse'
 require 'interferon'
 
-options={}
+options = {}
 
 # set command line options
 optparse = OptionParser.new do |opts|
-  opts.banner = %{Usage: interferon --config /path/to/interferon/config}
+  opts.banner = %(Usage: interferon --config /path/to/interferon/config)
 
-  opts.on('-c config','--config config', String, 'Path to interferon config') do |key,value|
+  opts.on('-c config', '--config config', String, 'Path to interferon config') do |key, _value|
     options[:config] = key
   end
 
@@ -26,7 +26,7 @@ end
 
 def parseconfig(filename)
   begin
-    c = YAML::parse(File.read(filename))
+    c = YAML.parse(File.read(filename))
   rescue Errno::ENOENT => e
     raise ArgumentError, "config file does not exist:\n#{e.inspect}"
   rescue Errno::EACCES => e
@@ -34,7 +34,7 @@ def parseconfig(filename)
   rescue YAML::SyntaxError => e
     raise "config file #{filename} contains invalid YAML:\n#{e.inspect}"
   end
-  return c.to_ruby
+  c.to_ruby
 end
 
 # parse command line arguments
@@ -46,8 +46,8 @@ end
 
 # validate that required options are present
 config = parseconfig(options[:config])
-%w{alerts_repo_path host_sources destinations}.each do |req|
-  unless config.include?(req) && ! config[req].empty?
+%w(alerts_repo_path host_sources destinations).each do |req|
+  unless config.include?(req) && !config[req].empty?
     puts "config file has no #{req} defined; exiting"
     exit 2
   end
@@ -59,8 +59,9 @@ a = Interferon::Interferon.new(
   config['alerts_repo_path'],
   config['group_sources'] || {},
   config['host_sources'],
-  config['destinations'])
+  config['destinations']
+)
 
 a.run(options[:dry_run])
 
-puts "interferon signaling complete!"
+puts 'interferon signaling complete!'

data/interferon.gemspec

@@ -4,27 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'interferon/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "interferon"
+  gem.name          = 'interferon'
   gem.version       = Interferon::VERSION
-  gem.authors       = ["Igor Serebryany", "Jimmy Ngo"]
-  gem.email         = ["igor.serebryany@airbnb.com", "jimmy.ngo@airbnb.com"]
-  gem.description   = %q{: Store metrics alerts in code!}
-  gem.summary       = %q{: Store metrics alerts in code!}
-  gem.homepage      = "https://www.github.com/airbnb/interferon"
+  gem.authors       = ['Igor Serebryany', 'Jimmy Ngo']
+  gem.email         = ['igor.serebryany@airbnb.com', 'jimmy.ngo@airbnb.com']
+  gem.description   = %(: Store metrics alerts in code!)
+  gem.summary       = %(: Store metrics alerts in code!)
+  gem.homepage      = 'https://www.github.com/airbnb/interferon'
   gem.licenses      = ['MIT']
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
 
-  gem.add_runtime_dependency "dogapi", "~> 1.11", ">= 1.11.1"
-  gem.add_runtime_dependency "aws-sdk", "~> 1.35", ">= 1.35.1"
-  gem.add_runtime_dependency "dogstatsd-ruby", "~> 1.4", ">= 1.4.1"
-  gem.add_runtime_dependency "diffy", "~> 3.1.0", ">= 3.1.0"
-  gem.add_runtime_dependency "parallel", "~> 1.9", ">= 1.9.0"
-  gem.add_runtime_dependency "nokogiri", "< 1.7.0"
-  gem.add_runtime_dependency "tzinfo", "~> 1.2.2", ">= 1.2.2"
+  gem.add_runtime_dependency 'dogapi', '~> 1.27', '>= 1.27.0'
+  gem.add_runtime_dependency 'aws-sdk', '~> 1.35', '>= 1.35.1'
+  gem.add_runtime_dependency 'dogstatsd-ruby', '~> 1.4', '>= 1.4.1'
+  gem.add_runtime_dependency 'diffy', '~> 3.1.0', '>= 3.1.0'
+  gem.add_runtime_dependency 'parallel', '~> 1.9', '>= 1.9.0'
+  gem.add_runtime_dependency 'nokogiri', '< 1.7.0'
+  gem.add_runtime_dependency 'tzinfo', '~> 1.2.2', '>= 1.2.2'
 
-  gem.add_development_dependency "rspec", "~> 3.2"
-  gem.add_development_dependency "pry", "~> 0.10"
+  gem.add_development_dependency 'rspec', '~> 3.2'
+  gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'rubocop', '0.41.2'
 end

data/lib/interferon/alert.rb

@@ -23,27 +23,21 @@ module Interferon
     end
 
     def change_name(name)
-      unless @dsl
-        raise "This alert has not yet been evaluated"
-      end
+      raise 'This alert has not yet been evaluated' unless @dsl
 
       @dsl.name(name)
     end
 
     def silence
-      unless @dsl
-        raise "This alert has not yet been evaluated"
-      end
+      raise 'This alert has not yet been evaluated' unless @dsl
 
       @dsl.silenced(true)
     end
 
     def [](attr)
-      unless @dsl
-        raise "This alert has not yet been evaluated"
-      end
+      raise 'This alert has not yet been evaluated' unless @dsl
 
-      return @dsl.send(attr)
+      @dsl.send(attr)
     end
   end
 end

data/lib/interferon/alert_dsl.rb

@@ -6,15 +6,16 @@ module Interferon
       @hostinfo = hostinfo
     end
 
-    def method_missing(meth, *args, &block)
+    def method_missing(meth, *_args)
       raise ArgumentError, "No such alerts field '#{meth}'"
     end
 
     def [](arg)
-      self.send(arg)
+      send(arg)
     end
 
     private
+
     def get_or_set(field, val, block, default)
       if val.nil? && block.nil?
         f = instance_variable_get(field)
@@ -33,7 +34,7 @@ module Interferon
     include DSLMixin
 
     def name(v = nil, &block)
-      get_or_set(:@name, v, block, '') { |val| val.strip }
+      get_or_set(:@name, v, block, '', &:strip)
     end
 
     def message(v = nil, &block)
@@ -53,7 +54,7 @@ module Interferon
         if val.is_a? Hash
           val
         elsif val == true
-          { "*" => nil }
+          { '*' => nil }
         else
           {}
         end
@@ -90,15 +91,19 @@ module Interferon
       get_or_set(:@thresholds, v, block, nil)
     end
 
+    def evaluation_delay(v = nil, &block)
+      get_or_set(:@evaluation_delay, v, block, nil)
+    end
+
     def require_full_window(v = nil, &block)
       get_or_set(:@require_full_window, v, block, nil)
     end
 
-    def notify(v = nil)
+    def notify(_v = nil)
       @notify ||= NotifyDSL.new(@hostinfo)
     end
 
-    def metric(v = nil)
+    def metric(_v = nil)
       @metric ||= MetricDSL.new(@hostinfo)
     end
   end
@@ -123,7 +128,7 @@ module Interferon
     include DSLMixin
 
     def datadog_query(v = nil, &block)
-      get_or_set(:@datadog_query, v, block, '') { |val| val.strip }
+      get_or_set(:@datadog_query, v, block, '', &:strip)
     end
   end
 end

data/lib/interferon/destinations/datadog.rb

@@ -11,10 +11,10 @@ module Interferon::Destinations
     include ::Interferon::Logging
 
     attr_accessor :concurrency
-    ALERT_KEY = 'This alert was created via the alerts framework'
+    ALERT_KEY = 'This alert was created via the alerts framework'.freeze
 
     def initialize(options)
-      %w{app_key api_key}.each do |req|
+      %w(app_key api_key).each do |req|
         unless options[req]
           raise ArgumentError, "missing required argument #{req}"
         end
@@ -48,17 +48,17 @@ module Interferon::Destinations
       @retries = options['retries'] || 3
 
       @stats = {
-        :alerts_created => 0,
-        :alerts_to_be_created => 0,
-        :alerts_updated => 0,
-        :alerts_to_be_updated => 0,
-        :alerts_deleted => 0,
-        :alerts_to_be_deleted => 0,
-        :alerts_silenced => 0,
-        :api_successes => 0,
-        :api_client_errors => 0,
-        :api_unknown_errors => 0,
-        :manually_created_alerts => 0,
+        alerts_created: 0,
+        alerts_to_be_created: 0,
+        alerts_updated: 0,
+        alerts_to_be_updated: 0,
+        alerts_deleted: 0,
+        alerts_to_be_deleted: 0,
+        alerts_silenced: 0,
+        api_successes: 0,
+        api_client_errors: 0,
+        api_unknown_errors: 0,
+        manually_created_alerts: 0,
       }
     end
 
@@ -67,10 +67,10 @@ module Interferon::Destinations
     end
 
     def generate_message(message, people)
-      [message, ALERT_KEY, people.map{ |p| "@#{p}" }].flatten.join("\n")
+      [message, ALERT_KEY, people.map { |p| "@#{p}" }].flatten.join("\n")
     end
 
-    def get_existing_alerts
+    def fetch_existing_alerts
       alerts = Queue.new
       has_more = true
 
@@ -84,26 +84,24 @@ module Interferon::Destinations
             log.info("Failed to retrieve existing alerts from datadog. #{code}: #{resp[1].inspect}")
           else
             alerts_page = resp[1]
-            if alerts_page.length < @page_size
-              has_more = false
-            end
+            has_more = false if alerts_page.length < @page_size
             alerts_page.map { |alert| alerts.push(alert) }
             successful = true
             break
           end
         end
 
-        if !successful
+        unless successful
           # Out of retries
-          raise "Retries exceeded for fetching data from datadog."
+          raise 'Retries exceeded for fetching data from datadog.'
         end
       end
-      alerts.size.times.map { alerts.pop }
+      Array.new(alerts.size) { alerts.pop }
     end
 
     def existing_alerts
       unless @existing_alerts
-        alerts = get_existing_alerts
+        alerts = fetch_existing_alerts
 
         # key alerts by name
         @existing_alerts = {}
@@ -119,9 +117,9 @@ module Interferon::Destinations
 
         # count how many are manually created
         @stats[:manually_created_alerts] = \
-          @existing_alerts.reject{|n,a| a['message'].include?(ALERT_KEY)}.length
+          @existing_alerts.reject { |_n, a| a['message'].include?(ALERT_KEY) }.length
 
-        log.info "datadog: found %d existing alerts; %d were manually created" % [
+        log.info 'datadog: found %d existing alerts; %d were manually created' % [
           @existing_alerts.length,
           @stats[:manually_created_alerts],
         ]
@@ -138,18 +136,22 @@ module Interferon::Destinations
 
       # create the hash of options to send to datadog
       alert_options = {
-        :notify_audit => alert['notify']['audit'],
-        :notify_no_data => alert['notify_no_data'],
-        :no_data_timeframe => alert['no_data_timeframe'],
-        :silenced => alert['silenced'],
-        :timeout_h => alert['timeout_h'],
+        notify_audit: alert['notify']['audit'],
+        notify_no_data: alert['notify_no_data'],
+        no_data_timeframe: alert['no_data_timeframe'],
+        silenced: alert['silenced'],
+        timeout_h: alert['timeout_h'],
       }
 
-      if !alert['require_full_window'].nil?
+      unless alert['evaluation_delay'].nil?
+        alert_options[:evaluation_delay] = alert['evaluation_delay']
+      end
+
+      unless alert['require_full_window'].nil?
         alert_options[:require_full_window] = alert['require_full_window']
       end
 
-      if !alert['thresholds'].nil?
+      unless alert['thresholds'].nil?
         alert_options[:thresholds] = alert['thresholds']
       end
 
@@ -171,11 +173,11 @@ module Interferon::Destinations
       log_datadog_response_code(resp, code, action, alert)
 
       # assume this was a success
-      if !(code >= 400 || code == -1)
+      unless code >= 400 || code == -1
         # assume this was a success
         @stats[:alerts_created] += 1 if action == :creating
         @stats[:alerts_updated] += 1 if action == :updating
-        @stats[:alerts_silenced] += 1 if !alert_options[:silenced].empty?
+        @stats[:alerts_silenced] += 1 unless alert_options[:silenced].empty?
       end
 
       id = resp[1].nil? ? nil : [resp[1]['id']]
@@ -198,17 +200,17 @@ EOM
       @dog.monitor(
         alert['monitor_type'],
         datadog_query,
-        :name => alert['name'],
-        :message => @dry_run ? generate_message(alert, []) : message,
-        :options => alert_options,
+        name: alert['name'],
+        message: @dry_run ? generate_message(alert, []) : message,
+        options: alert_options
       )
     end
 
     def update_datadog_alert(alert, datadog_query, message, alert_options, existing_alert)
-        @stats[:alerts_to_be_updated] += 1
-        id = existing_alert['id'][0]
+      @stats[:alerts_to_be_updated] += 1
+      id = existing_alert['id'][0]
 
-        new_alert_text = <<-EOM.strip
+      new_alert_text = <<-EOM.strip
 Query:
 #{datadog_query.strip}
 Message:
@@ -216,7 +218,7 @@ Message:
 Options:
 #{alert_options}
 EOM
-        existing_alert_text = <<-EOM.strip
+      existing_alert_text = <<-EOM.strip
 Query:
 #{existing_alert['query'].strip}
 Message:
@@ -224,63 +226,60 @@ Message:
 Options:
 #{alert_options}
 EOM
-        diff = Diffy::Diff.new(existing_alert_text, new_alert_text, :context=>1)
-        log.info("updating existing alert #{id} (#{alert['name']}):\n#{diff}")
-
-        if @dry_run
+      diff = Diffy::Diff.new(existing_alert_text, new_alert_text, context: 1)
+      log.info("updating existing alert #{id} (#{alert['name']}):\n#{diff}")
+
+      if @dry_run
+        resp = @dog.monitor(
+          alert['monitor_type'],
+          datadog_query,
+          name: alert['name'],
+          message: generate_message(alert, []),
+          options: alert_options
+        )
+      elsif alert['monitor_type'] == existing_alert['type']
+        resp = @dog.update_monitor(
+          id,
+          datadog_query,
+          name: alert['name'],
+          message: message,
+          options: alert_options
+        )
+
+        # Unmute existing alerts that have been unsilenced.
+        # Datadog does not allow updates to silencing via the update_alert API call.
+        if !existing_alert['options']['silenced'].empty? && alert_options[:silenced].empty?
+          @dog.unmute_monitor(id)
+        end
+      else
+        # Need to recreate alert with new monitor type
+        resp = @dog.delete_monitor(id)
+        code = resp[0].to_i
+        unless code >= 300 || code == -1
           resp = @dog.monitor(
             alert['monitor_type'],
             datadog_query,
-            :name => alert['name'],
-            :message => generate_message(alert, []),
-            :options => alert_options,
+            name: alert['name'],
+            message: message,
+            options: alert_options
           )
-        else
-          if alert['monitor_type'] == existing_alert['type']
-            resp = @dog.update_monitor(
-              id,
-              datadog_query,
-              :name => alert['name'],
-              :message => message,
-              :options => alert_options,
-            )
-
-            # Unmute existing alerts that have been unsilenced.
-            # Datadog does not allow updates to silencing via the update_alert API call.
-            if !existing_alert['options']['silenced'].empty? && alert_options[:silenced].empty?
-              @dog.unmute_monitor(id)
-            end
-          else
-            # Need to recreate alert with new monitor type
-            resp = @dog.delete_monitor(id)
-            code = resp[0].to_i
-            if !(code >= 300 || code == -1)
-              resp = @dog.monitor(
-                alert['monitor_type'],
-                datadog_query,
-                :name => alert['name'],
-                :message => message,
-                :options => alert_options,
-              )
-            end
-          end
         end
-    resp
+      end
+      resp
     end
 
-
     def remove_alert(alert)
       if alert['message'].include?(ALERT_KEY)
         @stats[:alerts_to_be_deleted] += 1
         log.info("deleting alert: #{alert['name']}")
 
-        if !@dry_run
+        unless @dry_run
           alert['id'].each do |alert_id|
             resp = @dog.delete_monitor(alert_id)
             code = resp[0].to_i
             log_datadog_response_code(resp, code, :deleting)
 
-            if !(code >= 300 || code == -1)
+            unless code >= 300 || code == -1
               # assume this was a success
               @stats[:alerts_deleted] += 1
             end
@@ -292,18 +291,20 @@ EOM
     end
 
     def report_stats
-      @stats.each do |k,v|
+      @stats.each do |k, v|
         statsd.gauge("datadog.#{k}", v)
       end
 
-      log.info "datadog: successfully created (%d/%d), updated (%d/%d), and deleted (%d/%d) alerts" % [
-        @stats[:alerts_created],
-        @stats[:alerts_to_be_created],
-        @stats[:alerts_updated],
-        @stats[:alerts_to_be_updated],
-        @stats[:alerts_deleted],
-        @stats[:alerts_to_be_deleted],
-      ]
+      log.info(
+        'datadog: successfully created (%d/%d), updated (%d/%d), and deleted (%d/%d) alerts' % [
+          @stats[:alerts_created],
+          @stats[:alerts_to_be_created],
+          @stats[:alerts_updated],
+          @stats[:alerts_to_be_updated],
+          @stats[:alerts_deleted],
+          @stats[:alerts_to_be_deleted],
+        ]
+      )
     end
 
     def remove_alert_by_id(alert_id)
@@ -314,7 +315,7 @@ EOM
       log_datadog_response_code(resp, code, :deleting)
     end
 
-    def log_datadog_response_code(resp, code, action, alert=nil)
+    def log_datadog_response_code(resp, code, action, alert = nil)
       # log whenever we've encountered errors
       if code != 200 && !alert.nil?
         api_errors << "#{code} on alert #{alert['name']}"
@@ -323,10 +324,10 @@ EOM
       # client error
       if code == 400
         @stats[:api_client_errors] += 1
-        if !alert.nil?
-          statsd.gauge('datadog.api.unknown_error', 0, :tags => ["alert:#{alert}"])
-          statsd.gauge('datadog.api.client_error', 1, :tags => ["alert:#{alert}"])
-          statsd.gauge('datadog.api.success', 0, :tags => ["alert:#{alert}"])
+        unless alert.nil?
+          statsd.gauge('datadog.api.unknown_error', 0, tags: ["alert:#{alert}"])
+          statsd.gauge('datadog.api.client_error', 1, tags: ["alert:#{alert}"])
+          statsd.gauge('datadog.api.success', 0, tags: ["alert:#{alert}"])
           log.error("client error while #{action} alert '#{alert['name']}';" \
                     " query was '#{alert['metric']['datadog_query']}'" \
                     " response was #{resp[0]}:'#{resp[1].inspect}'")
@@ -335,23 +336,22 @@ EOM
         # unknown (prob. datadog) error:
       elsif code > 400 || code == -1
         @stats[:api_unknown_errors] += 1
-        if !alert.nil?
-          statsd.gauge('datadog.api.unknown_error', 1, :tags => ["alert:#{alert}"])
-          statsd.gauge('datadog.api.client_error', 0, :tags => ["alert:#{alert}"])
-          statsd.gauge('datadog.api.success', 0, :tags => ["alert:#{alert}"])
+        unless alert.nil?
+          statsd.gauge('datadog.api.unknown_error', 1, tags: ["alert:#{alert}"])
+          statsd.gauge('datadog.api.client_error', 0, tags: ["alert:#{alert}"])
+          statsd.gauge('datadog.api.success', 0, tags: ["alert:#{alert}"])
           log.error("unknown error while #{action} alert '#{alert['name']}':" \
                     " query was '#{alert['metric']['datadog_query']}'" \
                     " response was #{resp[0]}:'#{resp[1].inspect}'")
         end
       else
         @stats[:api_successes] += 1
-        if !alert.nil?
-          statsd.gauge('datadog.api.unknown_error', 0, :tags => ["alert:#{alert}"])
-          statsd.gauge('datadog.api.client_error', 0, :tags => ["alert:#{alert}"])
-          statsd.gauge('datadog.api.success', 1, :tags => ["alert:#{alert}"])
+        unless alert.nil?
+          statsd.gauge('datadog.api.unknown_error', 0, tags: ["alert:#{alert}"])
+          statsd.gauge('datadog.api.client_error', 0, tags: ["alert:#{alert}"])
+          statsd.gauge('datadog.api.success', 1, tags: ["alert:#{alert}"])
         end
       end
     end
-
   end
 end