cfn-guardian 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d581e6ce59e93bd98f1b542df4c5a9fb40d701b6d9d63db76388ab31c173a6c5
-  data.tar.gz: ae4f1428fb07d69a9005c62dbebad1e426a73f5025f916d3374218e6f2bf84c4
+  metadata.gz: 97b6d983e52d77b70d2cea9e302ef3e02c377acc60bff4223fd2560a670293c5
+  data.tar.gz: 76cbf80c45d2af2213513b093516ed302dc527ec278d837c492a7c5736f58f91
 SHA512:
-  metadata.gz: f7bd308a2c4c7a8c8b44b88ceaad2c19a0f98911935eec52017987f0130e4299bf6dccf8b89d772d2797b7a610a696ed3bbf8ab7f79eb9a6782f8ee85f5d4dba
-  data.tar.gz: 0d69278f70848411b4e1baf8d495fa56bf858d67923f25888257bb12b9a806e13bcf5c2dc2cd23401c2df2435b4cee9b6416161e400c281c025c41c6efdf4d6c
+  metadata.gz: 7f248dc477c03b555afcee3bc74ac9d5f92be9c5937fccb6775aa9384ccaebde6dab76384106eebc8805180db1e773190636d50c3816b0e8ab6d8b872f708deb
+  data.tar.gz: a69c1358fc076d1c79a8f0ed1eaf85d8d6f0b0c334372fcff92785ad7ac4fbbb5f6828c72d7c6a05637cd6831e76ae03afb957a90521b0a502f132c1ecdf4568

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cfn-guardian (0.3.1)
+    cfn-guardian (0.3.4)
       aws-sdk-cloudformation (~> 1.31, < 2)
       aws-sdk-cloudwatch (~> 1.28, < 2)
       aws-sdk-codecommit (~> 1.28, < 2)
@@ -15,37 +15,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-eventstream (1.0.3)
-    aws-partitions (1.281.0)
-    aws-sdk-cloudformation (1.31.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.337.0)
+    aws-sdk-cloudformation (1.40.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudwatch (1.34.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-cloudwatch (1.40.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-codecommit (1.31.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-codecommit (1.36.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-codepipeline (1.28.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-codepipeline (1.33.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.91.0)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-sdk-core (3.103.0)
+      aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.30.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-kms (1.35.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.61.0)
-      aws-sdk-core (~> 3, >= 3.83.0)
+    aws-sdk-s3 (1.72.0)
+      aws-sdk-core (~> 3, >= 3.102.1)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.1.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
-    cfndsl (1.0.5)
+    aws-sigv4 (1.2.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+    cfndsl (1.1.1)
       hana (~> 1.3)
-    hana (1.3.5)
+    hana (1.3.6)
     jmespath (1.4.0)
     rake (10.5.0)
     sync (0.5.0)
@@ -54,7 +54,7 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.20.3)
-    tins (1.24.1)
+    tins (1.25.0)
       sync
     unicode-display_width (1.7.0)
 

data/README.md

@@ -167,6 +167,59 @@ Options:
       [--debug], [--no-debug]   # enable debug logging
 ```
 
+## Alarm Notifications
+
+There are 4 default notification levels used by Guardian Critical, Warning, Task, Informational. If you wish to recieve notifications for each of these you need to supply an sns topic arn in the alarms.yaml
+
+```yaml
+Topics:
+  Critical: arn:aws:sns:ap-southeast-2:123456789012:Critical
+  Warning: arn:aws:sns:ap-southeast-2:123456789012:Warning
+  Task: arn:aws:sns:ap-southeast-2:123456789012:Task
+  Informational: arn:aws:sns:ap-southeast-2:123456789012:Informational
+```
+
+Each alarm has a default notification level but can be overriden in the config using the `AlarmAction` property at either the alarm group or alarm level. See the [Overriding Defaults](#overriding-defaults) section on how to do that.
+
+You can add your own notification topics to the topics section and combine them with the existing topics. `AlarmAction` property will accept both a string and array of notication topics.
+
+```yaml
+Topics:
+  Critical: arn:aws:sns:ap-southeast-2:123456789012:Critical
+  Warning: arn:aws:sns:ap-southeast-2:123456789012:Warning
+  Task: arn:aws:sns:ap-southeast-2:123456789012:Task
+  Informational: arn:aws:sns:ap-southeast-2:123456789012:Informational
+  CustomTopic: arn:aws:sns:ap-southeast-2:123456789012:Custom
+
+Template:
+  Ec2Instance:
+    GroupOverrides:
+      AlarmActions:
+      - Critical
+      - Custom
+```
+
+### SNS Topics
+
+Create the topics before launching the guardian stack
+
+```bash
+aws sns create-topic --name Guardian-Critical
+aws sns create-topic --name Guardian-Warning
+aws sns create-topic --name Guardian-Task
+aws sns create-topic --name Guardian-Informational
+```
+
+SNS topics can be defined in the YAML config or during the `deploy` command using the sns switches. The full ARN must be used.
+
+```yaml
+Topics:
+  Critical: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Critical
+  Warning: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Warning
+  Task: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Task
+  Informational: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Informational
+``` 
+
 ## Configuration
 
 Config is stored in a standard YAML file which will default to `alarms.yaml`. This can be overridden by supplying the `--config` switch.
@@ -562,6 +615,26 @@ Custom alarm templates are defined within the same YAML config file un the `Temp
 
 ### Overriding Defaults
 
+Alarm properties such as `Threshold`, `AlarmAction`, etc can be overriden at the alarm level or at the alarm group level. 
+
+**Alarm Group Overrides**
+
+Alarm group level overrides apply to all alarms within the alarm group. 
+
+```yaml
+Templates:
+  # define the resource group
+  Ec2Instance:
+    # GroupOverrides key denotes the group level overrides
+    GroupOverrides:
+      # supply the key value of the alarm property you want to override
+      AlarmAction: Informational
+```
+
+**Alarm Overrides**
+
+Alarm overrides apply only to the alarm the property is applied to. This will override any alarm group level overrides.
+
 ```yaml
 Templates:
   # define the resource group
@@ -650,27 +723,6 @@ Templates:
     TargetResponseTime: false
 ```
 
-## SNS Topics
-
-Create the topics before launching the guardian stack
-
-```bash
-aws sns create-topic --name Guardian-Critical
-aws sns create-topic --name Guardian-Warning
-aws sns create-topic --name Guardian-Task
-aws sns create-topic --name Guardian-Informational
-```
-
-SNS topics can be defined in the YAML config or during the `deploy` command using the sns switches. The full ARN must be used.
-
-```yaml
-Topics:
-  Critical: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Critical
-  Warning: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Warning
-  Task: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Task
-  Informational: arn:aws:sns:ap-southeast-2:111111111111:Guardian-Informational
-``` 
-
 ## M Out Of N Metric Data Points
 
 This can be good to alert on groups of spikes with in a certain time frame without getting alerts for individual spikes.
@@ -798,10 +850,6 @@ cfn-guardian disable-alarms --group AppUpdate
 cfn-guardian enable-alarms --group AppUpdate
 ```
 
-## Severities
-
-Severties are defined in each alarm sing the `AlarmAction` key. There are 4 options `[ Critical, Warning, Task, Informational ]`
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/base2services/cfn-guardian.

data/lib/cfnguardian/compile.rb

@@ -51,6 +51,11 @@ module CfnGuardian
       @topics = config.fetch('Topics',{})
       @maintenance_groups = config.fetch('MaintenaceGroups', {})
       
+      # Make sure the default topics exist if they aren't supplied in the alarms.yaml
+      %w(Critical Warning Task Informational).each do |topic|
+        @topics[topic] = '' unless @topics.has_key?(topic)
+      end
+
       @maintenance_group_list = @maintenance_groups.keys.map {|group| "#{group}MaintenanceGroup"}
       @resources = []
       @stacks = []
@@ -82,7 +87,7 @@ module CfnGuardian
           end
           
           overides = @templates.has_key?(group) ? @templates[group] : {}
-          @resources.concat resource_class.get_alarms(overides,resource)
+          @resources.concat resource_class.get_alarms(resource,group,overides)
           @resources.concat resource_class.get_metric_filters()
           @resources.concat resource_class.get_events()
           @checks.concat resource_class.get_checks()

data/lib/cfnguardian/models/alarm.rb

@@ -28,7 +28,8 @@ module CfnGuardian
         :extended_statistic,
         :evaluate_low_sample_count_percentile,
         :unit,
-        :maintenance_groups
+        :maintenance_groups,
+        :additional_notifiers
       
       def initialize(resource)
         @type = 'Alarm'
@@ -54,6 +55,7 @@ module CfnGuardian
         @alarm_action = 'Critical'
         @treat_missing_data = nil
         @maintenance_groups = []
+        @additional_notifiers = []
       end
       
       def metric_name=(metric_name)

data/lib/cfnguardian/resources/base.rb

@@ -23,10 +23,19 @@ module CfnGuardian::Resource
       return @alarms
     end
     
-    def get_alarms(overides={},resource={})
+    def get_alarms(resource,group,overides={})
       # generate default alarms
       default_alarms()
-      
+
+      # override any group properties
+      group_overrides = overides.has_key?('GroupOverrides') ? overides['GroupOverrides'] : {}
+      overides.delete('GroupOverrides')
+      if group_overrides.any?
+        @alarms.each do |alarm|
+          group_overrides.each {|attr,value| update_alarm(alarm,attr,value)}
+        end
+      end
+
       # loop over each override template for the service
       overides.each do |name,properties|
         
@@ -40,7 +49,7 @@ module CfnGuardian::Resource
             next
           end
         end
-        
+
         # continue if the override is in the incorrect format
         unless properties.is_a?(Hash)
           if name != 'Inherit'
@@ -48,7 +57,9 @@ module CfnGuardian::Resource
           end
           next
         end
-        
+
+        properties.merge!(group_overrides)
+
         # Create a new alarm inheriting the defaults of an existing alarm
         if properties.has_key?('Inherit')
           alarm = find_alarm(properties['Inherit'])
@@ -64,10 +75,14 @@ module CfnGuardian::Resource
         end
         
         alarm = find_alarm(name)
-        
+
         if alarm.nil?
+          if @resource.has_key?('Hosts')
+            logger.warn("this resource doesn't support adding new alarms")
+            next
+          end
           # if alarm doesn't exist create a new one
-          alarm = Kernel.const_get("CfnGuardian::Models::#{self.class.to_s.split('::').last}Alarm").new(resource)
+          alarm = Kernel.const_get("CfnGuardian::Models::#{self.class.to_s.split('::').last}Alarm").new(@resource)
           properties.each {|attr,value| update_alarm(alarm,attr,value)}
           alarm.name = name
           @alarms.push(alarm)

data/lib/cfnguardian/stacks/main.rb

@@ -15,11 +15,11 @@ module CfnGuardian
       def build_template(stacks,checks,topics,maintenance_groups,ssm_parameters)     
         parameters = {}
            
-        %w(Critical Warning Task Informational).each do |name|
+        topics.each do |name, sns|
           parameter = @template.Parameter(name)
           parameter.Type 'String'
           parameter.Description "SNS topic ARN for #{name} notifications"
-          parameter.Default topics[name] if topics.has_key?(name)
+          parameter.Default sns
           parameters[name] = Ref(name)
         end
         

data/lib/cfnguardian/stacks/resources.rb

@@ -35,7 +35,7 @@ module CfnGuardian
       end
 
       def add_alarm(alarm)
-        actions = [Ref(alarm.alarm_action)]
+        actions = alarm.alarm_action.kind_of?(Array) ? alarm.alarm_action.map{|action| Ref(action)} : [Ref(alarm.alarm_action)]
         actions.concat alarm.maintenance_groups.map {|mg| Ref(mg)} if alarm.maintenance_groups.any?
 
         @template.declare do

data/lib/cfnguardian/version.rb

@@ -1,4 +1,4 @@
 module CfnGuardian
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
   CHANGE_SET_VERSION = VERSION.gsub('.', '-').freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfn-guardian
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Guslington