interferon 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e832b3eccfa9cec75b1e26dba0384209817c3e7e
-  data.tar.gz: 7d3673b1f98c3109f5a2b389c20cf91f6d5ddfe5
+  metadata.gz: f9e160c8273135fe18dabff0c3a557b265713e87
+  data.tar.gz: 611eac2ede9278bce9e20ad4e906841cd540dcdf
 SHA512:
-  metadata.gz: 84ad9260f477f30a7711a7807f3f09df804a43c77493d931febbc9eb98d888441370046f3a7093c78b863b22ec625bd4eeec1c8241376710828fb7c85df591ea
-  data.tar.gz: 3fd09fa405794191e7398297511ae86e7f5d63255adf9828088351955aa339a058780801cdb3108672fed97dbb8ebf936b5db7e7866b9d3e636404cb88841330
+  metadata.gz: 49fc267f05766355000f96775b599b9af7428ce528aaa9becb965e469eb395736ba3af4e9a012265f704399c8c841f877278a6d7d7539c3b7ecd2fa9ff120436
+  data.tar.gz: abfa38af220cb68928ca0ee3f279986ce9161ee17cf9f63ba3c74f27a5bb83e21adbe5d48281053efd3bdfc61195de99cba83cb96249c8bc78fb3a1e9f2866e3

data/config.example.yaml

@@ -37,3 +37,5 @@ destinations:
       api_key: "alsomissing"
       api_timeout: 15
       max_mute_minutes: 20160 # 14 days
+      # Optional. If not specified the alert_key will default to this value.
+      alert_key: "This alert was created via the alerts framework"

data/lib/interferon/alert_dsl.rb

@@ -95,6 +95,10 @@ module Interferon
       get_or_set(:@evaluation_delay, v, block, nil)
     end
 
+    def new_host_delay(v = nil, &block)
+      get_or_set(:@new_host_delay, v, block, 300)
+    end
+
     def require_full_window(v = nil, &block)
       get_or_set(:@require_full_window, v, block, nil)
     end

data/lib/interferon/destinations/datadog.rb

@@ -11,6 +11,7 @@ module Interferon::Destinations
     include ::Interferon::Logging
 
     attr_accessor :concurrency
+    attr_reader :alert_key
     ALERT_KEY = 'This alert was created via the alerts framework'.freeze
 
     def initialize(options)
@@ -39,6 +40,7 @@ module Interferon::Destinations
       @existing_alerts = nil
       @max_mute_minutes = options['max_mute_minutes']
       @dry_run = options['dry_run']
+      @alert_key = options['alert_key'] || ALERT_KEY
 
       # Datadog communication threads
       @concurrency = options['concurrency'] || 10
@@ -67,7 +69,7 @@ module Interferon::Destinations
       @api_errors ||= []
     end
 
-    def self.generate_message(message, people, options = {})
+    def generate_message(message, people, options = {})
       mentions = people.sort.map { |p| "@#{p}" }
 
       unless options[:notify_recovery]
@@ -75,7 +77,7 @@ module Interferon::Destinations
         mentions = "{{^is_recovery}}#{mentions}{{/is_recovery}}"
       end
 
-      [message, ALERT_KEY, mentions].flatten.join("\n")
+      [message, alert_key, mentions].flatten.join("\n")
     end
 
     def fetch_existing_alerts
@@ -125,7 +127,7 @@ 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 #{@existing_alerts.length} existing alerts; " \
@@ -140,7 +142,7 @@ module Interferon::Destinations
       # create a message which includes the notifications
       # Datadog may have a race condition where alerts created in a bad state may be triggered
       # during the dry-run creation process. Delete people from dry-run alerts to avoid this
-      message = self.class.generate_message(
+      message = generate_message(
         alert['message'],
         people,
         notify_recovery: alert['notify']['recovery']
@@ -163,6 +165,10 @@ module Interferon::Destinations
         alert_options[:evaluation_delay] = alert['evaluation_delay']
       end
 
+      unless alert['new_host_delay'].nil?
+        alert_options[:new_host_delay] = alert['new_host_delay']
+      end
+
       unless alert['require_full_window'].nil?
         alert_options[:require_full_window] = alert['require_full_window']
       end
@@ -303,7 +309,7 @@ EOM
     end
 
     def remove_alert(alert)
-      if alert['message'].include?(ALERT_KEY)
+      if alert['message'].include?(alert_key)
         @stats[:alerts_to_be_deleted] += 1
         log.info("deleting alert: #{alert['name']}")
 
@@ -328,7 +334,7 @@ EOM
     def need_update(alert_people_pair, existing_alerts_from_api)
       alert, people = alert_people_pair
       existing = existing_alerts_from_api[alert['name']]
-      existing.nil? || !self.class.same_alerts(alert, people, existing)
+      existing.nil? || !same_alerts(alert, people, existing)
     end
 
     def self.normalize_monitor_type(monitor_type)
@@ -343,12 +349,13 @@ EOM
       normalize_monitor_type(monitor_type_a) == normalize_monitor_type(monitor_type_b)
     end
 
-    def self.same_alerts(alert, people, alert_api_json)
+    def same_alerts(alert, people, alert_api_json)
       prev_alert = {
-        monitor_type: normalize_monitor_type(alert_api_json['type']),
+        monitor_type: self.class.normalize_monitor_type(alert_api_json['type']),
         query: alert_api_json['query'].strip,
         message: alert_api_json['message'].strip,
         evaluation_delay: alert_api_json['options']['evaluation_delay'],
+        new_host_delay: alert_api_json['options']['new_host_delay'],
         include_tags: alert_api_json['options']['include_tags'],
         notify_no_data: alert_api_json['options']['notify_no_data'],
         notify_audit: alert_api_json['options']['notify_audit'],
@@ -359,7 +366,7 @@ EOM
       }
 
       new_alert = {
-        monitor_type: normalize_monitor_type(alert['monitor_type']),
+        monitor_type: self.class.normalize_monitor_type(alert['monitor_type']),
         query: alert['metric']['datadog_query'],
         message: generate_message(
           alert['message'],
@@ -367,6 +374,7 @@ EOM
           notify_recovery: alert['notify']['recovery']
         ).strip,
         evaluation_delay: alert['evaluation_delay'],
+        new_host_delay: alert['new_host_delay'],
         include_tags: alert['notify']['include_tags'],
         notify_no_data: alert['notify_no_data'],
         notify_audit: alert['notify']['audit'],

data/lib/interferon/version.rb

@@ -1,3 +1,3 @@
 module Interferon
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.2.5'.freeze
 end

data/spec/lib/interferon/destinations/datadog_spec.rb

@@ -26,6 +26,12 @@ describe Interferon::Destinations::Datadog do
       base_datadog_config.merge('max_mute_minutes' => max_mute_minutes)
     )
   end
+  let(:datadog_alert_key) do
+    Interferon::Destinations::Datadog.new(
+      base_datadog_config.merge('alert_key' => mock_custom_alert_key)
+    )
+  end
+  let(:mock_custom_alert_key) { 'My custom alert key' }
   let(:mock_alert_id) { 123 }
   let(:mock_alert) do
     {
@@ -148,20 +154,26 @@ describe Interferon::Destinations::Datadog do
     let(:people) { %w(userA userB) }
 
     it 'adds the ALERT_KEY to the message' do
-      expect(Interferon::Destinations::Datadog.generate_message(message, people)).to include(
+      expect(datadog.generate_message(message, people)).to include(
         Interferon::Destinations::Datadog::ALERT_KEY
       )
     end
 
+    it 'prefers a custom alert_key if provided' do
+      expect(datadog_alert_key.generate_message(message, people)).to include(
+        mock_custom_alert_key
+      )
+    end
+
     it 'adds a mention to people' do
-      expect(Interferon::Destinations::Datadog.generate_message(message, people)).to include(
+      expect(datadog.generate_message(message, people)).to include(
         *people.map { |person| "@#{person}" }
       )
     end
 
     it 'does not add ^is_recovery template variable when notify_recovery is true' do
       expect(
-        Interferon::Destinations::Datadog.generate_message(
+        datadog.generate_message(
           message, people, notify_recovery: true
         )
       ).not_to include('{{^is_recovery}}')
@@ -169,7 +181,7 @@ describe Interferon::Destinations::Datadog do
 
     it 'adds a ^is_recovery template variable when notify_recovery is false' do
       expect(
-        Interferon::Destinations::Datadog.generate_message(
+        datadog.generate_message(
           message, people, notify_recovery: false
         )
       ).to include('{{^is_recovery}}')

data/spec/lib/interferon_spec.rb

@@ -7,9 +7,14 @@ include Interferon
 describe Interferon::Destinations::Datadog do
   let(:the_existing_alerts) { mock_existing_alerts }
   let(:dest) { MockDest.new(the_existing_alerts) }
+  let(:datadog) do
+    Interferon::Destinations::Datadog.new(
+      'app_key' => 'TEST_APP_KEY', 'api_key' => 'TEST_API_KEY'
+    )
+  end
 
   shared_examples_for 'alert_option' do |alert_option, same_value, different_value, alert_dsl|
-    let(:json_message) { 'message' + "\n#{Interferon::Destinations::Datadog::ALERT_KEY}" }
+    let(:json_message) { 'message' + "\n#{datadog.alert_key}" }
     let(:alert) do
       alert_dsl_path = alert_dsl.nil? ? alert_option : alert_dsl
       create_test_alert('name1', 'testquery', 'message', alert_dsl_path => same_value)
@@ -27,46 +32,46 @@ describe Interferon::Destinations::Datadog do
 
     context 'when the options are the same' do
       it 'should return true' do
-        expect(Interferon::Destinations::Datadog.same_alerts(alert, [], alert_same)).to be true
+        expect(datadog.same_alerts(alert, [], alert_same)).to be true
       end
     end
 
     context 'when the options are the different' do
       it 'should return false' do
-        expect(Interferon::Destinations::Datadog.same_alerts(alert, [], alert_diff)).to be false
+        expect(datadog.same_alerts(alert, [], alert_diff)).to be false
       end
     end
   end
 
   describe '#same_alerts' do
-    let(:json_message) { 'message' + "\n#{Interferon::Destinations::Datadog::ALERT_KEY}" }
+    let(:json_message) { 'message' + "\n#{datadog.alert_key}" }
 
     it 'detects a no change if alert message is the same' do
       alert1 = create_test_alert('name1', 'testquery', 'message')
       alert2 = mock_alert_json('name2', 'testquery', json_message)
 
-      expect(Interferon::Destinations::Datadog.same_alerts(alert1, [], alert2)).to be true
+      expect(datadog.same_alerts(alert1, [], alert2)).to be true
     end
 
     it 'detects a change if alert message is different' do
       alert1 = create_test_alert('name1', 'testquery', 'message2')
       alert2 = mock_alert_json('name2', 'testquery', json_message)
 
-      expect(Interferon::Destinations::Datadog.same_alerts(alert1, [], alert2)).to be false
+      expect(datadog.same_alerts(alert1, [], alert2)).to be false
     end
 
     it 'detects no change if datadog query is the same' do
       alert1 = create_test_alert('name1', 'testquery', 'message')
       alert2 = mock_alert_json('name2', 'testquery', json_message)
 
-      expect(Interferon::Destinations::Datadog.same_alerts(alert1, [], alert2)).to be true
+      expect(datadog.same_alerts(alert1, [], alert2)).to be true
     end
 
     it 'detects a change if datadog query is different' do
       alert1 = create_test_alert('name1', 'testquery1', 'message')
       alert2 = mock_alert_json('name2', 'testquery2', json_message)
 
-      expect(Interferon::Destinations::Datadog.same_alerts(alert1, [], alert2)).to be false
+      expect(datadog.same_alerts(alert1, [], alert2)).to be false
     end
 
     context 'notify_no_data option' do
@@ -89,6 +94,10 @@ describe Interferon::Destinations::Datadog do
       it_behaves_like('alert_option', 'evaluation_delay', nil, 300)
     end
 
+    context 'new_host_delay option' do
+      it_behaves_like('alert_option', 'new_host_delay', 400, 400)
+    end
+
     context 'thresholds option' do
       it_behaves_like('alert_option', 'thresholds', nil, 'critical' => 1)
     end
@@ -111,7 +120,7 @@ describe Interferon::Destinations::Datadog do
         'name2', 'testquery', json_message, 'metric alert', [1], 'silenced' => { '*' => nil }
       )
 
-      expect(Interferon::Destinations::Datadog.same_alerts(alert1, [], alert2)).to be true
+      expect(datadog.same_alerts(alert1, [], alert2)).to be true
     end
   end
 
@@ -283,7 +292,7 @@ describe Interferon::Destinations::Datadog do
   end
 
   def mock_existing_alerts
-    mock_message = Interferon::Destinations::Datadog::ALERT_KEY
+    mock_message = datadog.alert_key
     alert1 = mock_alert_json('name1', 'testquery1', mock_message)
     alert2 = mock_alert_json('name2', 'testquery2', mock_message)
     { 'name1' => alert1, 'name2' => alert2 }
@@ -294,6 +303,7 @@ describe Interferon::Destinations::Datadog do
 
     def initialize(the_existing_alerts)
       @existing_alerts = the_existing_alerts
+      @alert_key = ALERT_KEY
     end
 
     def create_alert(alert, _people)
@@ -305,6 +315,7 @@ describe Interferon::Destinations::Datadog do
 
   DEFAULT_OPTIONS = {
     'evaluation_delay' => nil,
+    'new_host_delay' => 300,
     'notify_audit' => false,
     'notify_no_data' => false,
     'silenced' => {},
@@ -330,7 +341,7 @@ describe Interferon::Destinations::Datadog do
     create_test_alert(
       mock_alert_json['name'],
       mock_alert_json['query'],
-      mock_alert_json['message'].sub(/#{Interferon::Destinations::Datadog::ALERT_KEY}$/, ''),
+      mock_alert_json['message'].sub(/#{datadog.alert_key}$/, ''),
       mock_alert_json['options']
     )
   end
@@ -358,6 +369,7 @@ describe Interferon::Destinations::Datadog do
     alert_dsl.no_data_timeframe(options['no_data_timeframe'])
     alert_dsl.notify_no_data(options['notify_no_data'])
     alert_dsl.evaluation_delay(options['evaluation_delay'])
+    alert_dsl.new_host_delay(options['new_host_delay'])
     alert_dsl.require_full_window(options['require_full_window'])
     alert_dsl.thresholds(options['thresholds'])
     alert_dsl.timeout(options['timeout'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interferon
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Igor Serebryany
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi