cfn-guardian 0.7.6 → 0.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3345312b95427da816d7868b27d9788149e3472a871f858f3b8171152284e3c
-  data.tar.gz: c412fb2251b7f46a62f9b21cff4e03740c0fba4c4205d57db5bc191aad0e484d
+  metadata.gz: 033f2fc6acd9cb43ea7d5ed3e86380ad7ca5466f933a74a9ce82d596dcd60357
+  data.tar.gz: beae571c60d4b70cfb822ecce7987ef7c4f24e95b26b998982baee926bfd9779
 SHA512:
-  metadata.gz: e23576678690da79c9df22f8c67631f86dbfe724349d4b54ca796fcd313803946890fc15ea73d17bf30e0d1946504c9bc0627f2f18151417650376ef49ef6750
-  data.tar.gz: 163b472a1cc2f59690e7819acbc5546a7043e6333a85346c4e4ccbac49d328c66aadaf61a63a89df04b487eec94cd4154c96f638e89bf25936694a7c2b2873ee
+  metadata.gz: 155df68c0cf8696ca55547df817e45e60e967c817b2b00eae8fb416113a776792edc9cd6ba508ef6350fca3f09da202eb384e5bfb63047b5f598b5be2098dfb7
+  data.tar.gz: b1e423475b999de9444b1a90fcf22215a65284c2694c9c68cd7d32985a0690f018fee7343e9360809be00d3ec8615bef4800540b8f01a84d59020172b48640aa

data/Dockerfile

@@ -1,6 +1,6 @@
 FROM ruby:2.7-alpine
 
-ARG GUARDIAN_VERSION="0.7.1"
+ARG GUARDIAN_VERSION="0.7.7"
 
 COPY . /src
 

data/README.md

@@ -29,6 +29,7 @@ CfnGuardian is a AWS monitoring tool with a few capabilities:
 - Network TargetGroups
 - AutoScalingGroups
 - CloudFront Distributions
+- DocumentDB Clusters
 - DynamoDB Tables
 - EC2 Instances
 - ECS Clusters

data/docs/event_subscriptions.md

@@ -10,14 +10,14 @@ As with the default alarms in Guardian, there are default events for some resour
 
 ## Overriding Defaults
 
-Default properites of the events can be overridden through the config YAML using the `EventsSubscription` top level key.
+Default properties of the events can be overridden through the config YAML using the `EventsSubscriptions` top level key.
 For example here we are changing the topic the event is being send to.
 
 ```yaml
 Topics:
     CustomEvents: arn:aws:sns....
 
-EventSubscription:
+EventSubscriptions:
   Ec2Instance:
     InstanceTerminated:
       Topic: CustomEvents
@@ -28,12 +28,24 @@ EventSubscription:
 Default events can be disabled, the same way default alarms can be disabled through the config YAML.
 
 ```yaml
-EventSubscription:
+EventSubscriptions:
   Ec2Instance:
     # set the instance terminated event to false to disable the event
     InstanceTerminated: false
 ```
 
+## Enabling Default Events
+
+Some templates may have events that are disabled by default, they can be enabled using a slightly different syntax to disabling.
+
+```yaml
+EventSubscriptions:
+  RDSInstance:
+    # set the replication failure event to true to enable the event
+    ReplicationFailure: 
+      Enabled: true
+```
+
 ## Creating Custom Events
 
 Custom events can be created if there are not defaults for that event. They can be inherited from a default event or from the base event model.
@@ -44,7 +56,7 @@ This is useful if you want to create a new event and a default event already has
 The following example inherits the `MasterPasswordReset` RDS event and creates a new event that captures the security group add to an rds instance event.
 
 ```yaml
-EventSubscription:
+EventSubscriptions:
   RDSInstance:
     # Create a new event name
     DBNewSecurityGroup:
@@ -59,7 +71,7 @@ EventSubscription:
 If there are no default events that match the format you require you can create an event of the base event subscription model.
 
 ```yaml
-EventSubscription:
+EventSubscriptions:
   ECSCluster:
     ContainerInstanceStateChange:
       Source: aws.ecs

data/docs/resources.md

@@ -39,6 +39,7 @@ Resources:
 | ApiGateway                  | Id               |
 | AmazonMQBroker              | Id               |
 | AutoScalingGroup            | Id               |
+| DocumentDBCluster           | Id               |
 | DynamoDBTable               | Id               |
 | ElastiCacheReplicationGroup | Id               |
 | ElasticFileSystem           | Id               |

data/lib/cfnguardian/compile.rb

@@ -12,6 +12,7 @@ require 'cfnguardian/resources/autoscaling_group'
 require 'cfnguardian/resources/cloudfront_distribution'
 require 'cfnguardian/resources/autoscaling_group'
 require 'cfnguardian/resources/domain_expiry'
+require 'cfnguardian/resources/documentdb_cluster'
 require 'cfnguardian/resources/dynamodb_table'
 require 'cfnguardian/resources/ec2_instance'
 require 'cfnguardian/resources/ecs_cluster'
@@ -27,6 +28,7 @@ require 'cfnguardian/resources/internal_port'
 require 'cfnguardian/resources/nrpe'
 require 'cfnguardian/resources/lambda'
 require 'cfnguardian/resources/network_targetgroup'
+require 'cfnguardian/resources/rds_cluster'
 require 'cfnguardian/resources/rds_cluster_instance'
 require 'cfnguardian/resources/rds_instance'
 require 'cfnguardian/resources/redshift_cluster'

data/lib/cfnguardian/config/defaults.yaml

@@ -19,6 +19,8 @@ Resources:
   - Id: Default
   CloudFrontDistribution:
   - Id: Default
+  DocumentDBCluster:
+  - Id: Default
   DomainExpiry:
   - Id: Default
   DynamoDBTable:

data/lib/cfnguardian/models/alarm.rb

@@ -71,6 +71,7 @@ module CfnGuardian
         @group = 'ApiGateway'
         @namespace = 'AWS/ApiGateway'
         @dimensions = { ApiName: resource['Id'] }
+        @treat_missing_data = 'notBreaching'
       end
     end
     
@@ -140,6 +141,7 @@ module CfnGuardian
         }
         @statistic = 'Average'
         @evaluation_periods = 5
+        @treat_missing_data = 'notBreaching'
       end
     end
     
@@ -151,6 +153,15 @@ module CfnGuardian
         @dimensions = { AutoScalingGroupName: resource['Id'] }
       end
     end
+
+    class DocumentDBClusterAlarm < BaseAlarm
+      def initialize(resource)
+        super(resource)
+        @group = 'DocumentDBCluster'
+        @namespace = 'AWS/DocDB'
+        @dimensions = { DBClusterIdentifier: resource['Id'] }
+      end
+    end
     
     class DomainExpiryAlarm < BaseAlarm
       def initialize(resource)
@@ -189,6 +200,7 @@ module CfnGuardian
         @threshold = 75
         @alarm_action = 'Warning'
         @evaluation_periods = 10
+        @treat_missing_data = 'notBreaching'
       end
     end
     
@@ -201,6 +213,7 @@ module CfnGuardian
           ServiceName: resource['Id'],
           ClusterName: resource['Cluster'] 
         }
+        @treat_missing_data = 'breaching'
       end
     end
 
@@ -341,6 +354,7 @@ module CfnGuardian
         @dimensions = { FunctionName: resource['Id'] }
         @statistic = 'Average'
         @evaluation_periods = 5
+        @treat_missing_data = 'notBreaching'
       end
     end
     
@@ -426,6 +440,7 @@ module CfnGuardian
         @dimensions = { QueueName: resource['Id'] }
         @statistic = 'Average'
         @period = 300
+        @treat_missing_data = 'notBreaching'
       end
     end
     
@@ -438,6 +453,7 @@ module CfnGuardian
         @threshold = 1
         @period = 300
         @alarm_action = 'Informational'
+        @treat_missing_data = 'notBreaching'
       end
     end
     

data/lib/cfnguardian/resources/amazonmq_broker.rb

@@ -8,7 +8,9 @@ module CfnGuardian::Resource
       alarm.comparison_operator = 'LessThanThreshold'
       alarm.statistic = 'Minimum'
       alarm.threshold = 15
-      alarm.evaluation_periods = 1
+      alarm.period = 300
+      alarm.datapoints_to_alarm = 2
+      alarm.evaluation_periods = 2
       alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
@@ -18,7 +20,9 @@ module CfnGuardian::Resource
       alarm.comparison_operator = 'LessThanThreshold'
       alarm.statistic = 'Minimum'
       alarm.threshold = 30
-      alarm.evaluation_periods = 1
+      alarm.period = 300
+      alarm.datapoints_to_alarm = 2
+      alarm.evaluation_periods = 2
       alarm.treat_missing_data = 'notBreaching'
       alarm.alarm_action = 'Warning'
       @alarms.push(alarm)

data/lib/cfnguardian/resources/apigateway.rb

@@ -8,7 +8,6 @@ module CfnGuardian::Resource
       alarm.statistic = 'Sum'
       alarm.threshold = 5
       alarm.evaluation_periods = 2
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
       alarm = CfnGuardian::Models::ApiGatewayAlarm.new(@resource)
@@ -17,7 +16,6 @@ module CfnGuardian::Resource
       alarm.statistic = 'Sum'
       alarm.threshold = 5
       alarm.evaluation_periods = 2
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
       alarm = CfnGuardian::Models::ApiGatewayAlarm.new(@resource)
@@ -26,7 +24,6 @@ module CfnGuardian::Resource
       alarm.statistic = 'Average'
       alarm.threshold = 1000
       alarm.evaluation_periods = 2
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
     end
     

data/lib/cfnguardian/resources/documentdb_cluster.rb

@@ -0,0 +1,39 @@
+module CfnGuardian::Resource
+    class DocumentDBCluster < Base
+      
+      def default_alarms    
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'CPUUtilizationHighBase'
+        alarm.metric_name = 'CPUUtilization'
+        alarm.threshold = 75
+        alarm.evaluation_periods = 60
+        alarm.alarm_action = 'Warning'
+        @alarms.push(alarm)
+
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'CPUUtilizationHighSpike'
+        alarm.metric_name = 'CPUUtilization'
+        alarm.threshold = 95
+        alarm.evaluation_periods = 10
+        @alarms.push(alarm)
+
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'DatabaseConnections'
+        alarm.metric_name = 'DatabaseConnections'
+        alarm.statistic = 'Minimum'
+        alarm.threshold = 50
+        alarm.evaluation_periods = 10
+        @alarms.push(alarm)
+
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'FreeableMemory'
+        alarm.metric_name = 'FreeableMemory'
+        alarm.threshold = 1000000000
+        alarm.evaluation_periods = 3
+        @alarms.push(alarm)
+      end
+      
+    end
+  end
+  
+  

data/lib/cfnguardian/resources/ecs_service.rb

@@ -10,7 +10,6 @@ module CfnGuardian
         alarm.statistic = 'SampleCount'
         alarm.threshold = 0
         alarm.evaluation_periods = 10
-        alarm.treat_missing_data = 'breaching'
         alarm.datapoints_to_alarm = 8
         @alarms.push(alarm)
         
@@ -21,12 +20,66 @@ module CfnGuardian
         alarm.statistic = 'SampleCount'
         alarm.threshold = 1
         alarm.evaluation_periods = 10
-        alarm.treat_missing_data = 'breaching'
         alarm.datapoints_to_alarm = 8
         alarm.alarm_action = 'Warning'
         @alarms.push(alarm)
+
+        alarm = CfnGuardian::Models::ECSServiceAlarm.new(@resource)
+        alarm.name = 'MemoryUtilizationCritical'
+        alarm.metric_name = 'MemoryUtilization'
+        alarm.comparison_operator = 'GreaterThanOrEqualToThreshold'
+        alarm.statistic = 'Average'
+        alarm.threshold = 90
+        alarm.evaluation_periods = 5
+        alarm.treat_missing_data = 'breaching'
+        alarm.alarm_action = 'Critical'
+        alarm.datapoints_to_alarm = 4
+        alarm.treat_missing_data = 'notBreaching'
+        alarm.enabled = false
+        @alarms.push(alarm)
+        
+        alarm = CfnGuardian::Models::ECSServiceAlarm.new(@resource)
+        alarm.name = 'MemoryUtilizationWarning'
+        alarm.metric_name = 'MemoryUtilization'
+        alarm.comparison_operator = 'GreaterThanOrEqualToThreshold'
+        alarm.statistic = 'Average'
+        alarm.threshold = 80
+        alarm.evaluation_periods = 5
+        alarm.treat_missing_data = 'breaching'
+        alarm.datapoints_to_alarm = 4
+        alarm.treat_missing_data = 'notBreaching'
+        alarm.alarm_action = 'Warning'
+        alarm.enabled = false
+        @alarms.push(alarm)   
+
+        alarm = CfnGuardian::Models::ECSServiceAlarm.new(@resource)
+        alarm.name = 'CPUUtilizationCritical'
+        alarm.metric_name = 'CPUUtilization'
+        alarm.comparison_operator = 'GreaterThanOrEqualToThreshold'
+        alarm.statistic = 'Average'
+        alarm.threshold = 90
+        alarm.evaluation_periods = 5
+        alarm.treat_missing_data = 'breaching'
+        alarm.alarm_action = 'Critical'
+        alarm.datapoints_to_alarm = 4
+        alarm.treat_missing_data = 'notBreaching'
+        alarm.enabled = false
+        @alarms.push(alarm)
+        
+        alarm = CfnGuardian::Models::ECSServiceAlarm.new(@resource)
+        alarm.name = 'CPUUtilizationWarning'
+        alarm.metric_name = 'CPUUtilization'
+        alarm.comparison_operator = 'GreaterThanOrEqualToThreshold'
+        alarm.statistic = 'Average'
+        alarm.threshold = 80
+        alarm.evaluation_periods = 5
+        alarm.treat_missing_data = 'breaching'
+        alarm.datapoints_to_alarm = 4
+        alarm.treat_missing_data = 'notBreaching'
+        alarm.alarm_action = 'Warning'
+        alarm.enabled = false
+        @alarms.push(alarm)      
       end
-      
     end
   end
 end

data/lib/cfnguardian/resources/http.rb

@@ -36,6 +36,7 @@ module CfnGuardian::Resource
         alarm.name = 'ExpiresInDaysCritical'
         alarm.metric_name = 'ExpiresInDays'
         alarm.threshold = 5
+        alarm.treat_missing_data = 'notBreaching'
         @alarms.push(alarm)
         
         alarm = CfnGuardian::Models::SslAlarm.new(@resource)
@@ -43,6 +44,7 @@ module CfnGuardian::Resource
         alarm.metric_name = 'ExpiresInDays'
         alarm.alarm_action = 'Task'
         alarm.threshold = 30
+        alarm.treat_missing_data = 'notBreaching'
         @alarms.push(alarm)
       end
     end

data/lib/cfnguardian/resources/lambda.rb

@@ -6,28 +6,24 @@ module CfnGuardian::Resource
       alarm.name = 'LambdaErrors'
       alarm.metric_name = 'Errors'
       alarm.threshold = 0.5
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
       alarm = CfnGuardian::Models::LambdaAlarm.new(@resource)
       alarm.name = 'Throttles'
       alarm.metric_name = 'Throttles'
       alarm.threshold = 0.5
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
       alarm = CfnGuardian::Models::LambdaAlarm.new(@resource)
       alarm.name = 'DeadLetterErrors'
       alarm.metric_name = 'DeadLetterErrors'
       alarm.threshold = 0.5
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
       alarm = CfnGuardian::Models::LambdaAlarm.new(@resource)
       alarm.name = 'IteratorAge'
       alarm.metric_name = 'IteratorAge'
       alarm.threshold = 600000
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
       alarm = CfnGuardian::Models::LambdaAlarm.new(@resource)
@@ -35,7 +31,6 @@ module CfnGuardian::Resource
       alarm.metric_name = 'Duration'
       alarm.statistic = 'Average'
       alarm.threshold = 30
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
     end
     

data/lib/cfnguardian/resources/log_group.rb

@@ -11,7 +11,6 @@ module CfnGuardian::Resource
         alarm = CfnGuardian::Models::LogGroupAlarm.new(@resource)
         alarm.name = filter['MetricName']
         alarm.metric_name = filter['MetricName']
-        alarm.treat_missing_data = 'notBreaching'
         @alarms.push(alarm)
       end
     end

data/lib/cfnguardian/resources/sqs_queue.rb

@@ -7,7 +7,6 @@ module CfnGuardian::Resource
       alarm.metric_name = 'ApproximateAgeOfOldestMessage'
       alarm.threshold = 0.5
       alarm.evaluation_periods = 5
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
       alarm = CfnGuardian::Models::SQSQueueAlarm.new(@resource)
@@ -15,7 +14,6 @@ module CfnGuardian::Resource
       alarm.metric_name = 'ApproximateNumberOfMessagesVisible'
       alarm.threshold = 0.5
       alarm.evaluation_periods = 5
-      alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
     end
     

data/lib/cfnguardian/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-guardian
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.10
 platform: ruby
 authors:
 - Guslington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -280,6 +280,7 @@ files:
 - lib/cfnguardian/resources/base.rb
 - lib/cfnguardian/resources/batch.rb
 - lib/cfnguardian/resources/cloudfront_distribution.rb
+- lib/cfnguardian/resources/documentdb_cluster.rb
 - lib/cfnguardian/resources/domain_expiry.rb
 - lib/cfnguardian/resources/dynamodb_table.rb
 - lib/cfnguardian/resources/ec2_instance.rb