Tidy up the branch

- Integration test passed
- EventBridge section added to the README
- Alarms disabled at eventsRule level

README.md

@@ -158,6 +158,18 @@ SNS Topic dashboard widgets show:
 |--|--|
 |![Invalid Attributes](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/snsInvalidAttributes.png)|![Notifications Failed](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/snsNotificationsFailed.png) |
 
+### EventBridge
+
+EventBridge alarms are created for:
+1. Failed Invocations
+2. ThrottledRules
+
+EventBridge Rule dashboard widgets show:
+
+|FailedInvocations|Invocations|ThrottledRules|
+|--|--|
+|![FailedInvocations](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/eventBridgeFailedInvocations.png)|![Invocations](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/eventBridgeInvocations.png)|
+
 ## Configuration
 
 Configuration is entirely optional - SLIC Watch provides defaults that work out of the box.
@@ -286,6 +298,14 @@ custom:
           NumberOfNotificationsFailed:
             Statistic: Sum 
             Threshold: 1
+        Events:
+          #EventBridge
+          FailedInvocations:
+            Statistic: Sum 
+            Threshold: 1
+          ThrottledRules:
+            Statistic: Sum 
+            Threshold: 1
 
     dashboard:
       enabled: true
@@ -371,6 +391,14 @@ custom:
             Statistic: ["Sum"]
           NumberOfNotificationsFailed:
             Statistic: ["Sum"]
+        Events:
+          #EventBridge
+          FailedInvocations:
+            Statistic: ["Sum"]
+          ThrottledRules:
+            Statistic: ["Sum"]
+          Invocations: 
+            Statistic: ["Sum"] 
 ```
 
 An example project is provided for reference: [serverless-test-project](./serverless-test-project)

serverless-plugin/alarms-eventbridge.js

@@ -5,16 +5,16 @@
  */
 module.exports = function eventsAlarms (eventsAlarmsConfig, context) {
   return {
-    createEventsAlarms
+    createRuleAlarms
   }
 
   /**
    * Add all required Events alarms to the provided CloudFormation template
-   * based on the Events resources found within
+   * based on the EventBridge Rule found within
    *
    * @param {CloudFormationTemplate} cfTemplate A CloudFormation template object
    */
-  function createEventsAlarms (cfTemplate) {
+  function createRuleAlarms (cfTemplate) {
     const ruleResources = cfTemplate.getResourcesByType(
       'AWS::Events::Rule'
     )
@@ -40,7 +40,7 @@ module.exports = function eventsAlarms (eventsAlarmsConfig, context) {
     }
   }
 
-  function createEventsAlarm (
+  function createRuleAlarm (
     alarmName,
     alarmDescription,
     ruleName,
@@ -82,7 +82,7 @@ module.exports = function eventsAlarms (eventsAlarmsConfig, context) {
 
     return {
       resourceName: `slicWatchEventsFailedInvocationsAlarm${ruleResourceName}`,
-      resource: createEventsAlarm(
+      resource: createRuleAlarm(
         `EventsFailedInvocationsAlarm_${ruleName}`, // alarmName
         `Failed Invocations for ${ruleName} breaches ${threshold}`, // alarmDescription
         ruleName,
@@ -102,7 +102,7 @@ module.exports = function eventsAlarms (eventsAlarmsConfig, context) {
     const threshold = config.Threshold
     return {
       resourceName: `slicWatchEventsThrottledRulesAlarm${ruleResourceName}`,
-      resource: createEventsAlarm(
+      resource: createRuleAlarm(
         `EventsThrottledRulesAlarm_${ruleName}`, // alarmName
         `Throttled RulesAlarm for ${ruleName} breaches ${threshold}`, // alarmDescription
         ruleName,

serverless-plugin/alarms.js

@@ -11,7 +11,7 @@ const kinesisAlarms = require('./alarms-kinesis')
 const sqsAlarms = require('./alarms-sqs')
 const ecsAlarms = require('./alarms-ecs')
 const snsAlarms = require('./alarms-sns')
-const eventsAlarms = require('./alarms-eventbridge')
+const ruleAlarms = require('./alarms-eventbridge')
 
 module.exports = function alarms (serverless, alarmConfig, functionAlarmConfigs, context) {
   const {
@@ -23,7 +23,7 @@ module.exports = function alarms (serverless, alarmConfig, functionAlarmConfigs,
     Lambda: lambdaConfig,
     ECS: ecsConfig,
     SNS: snsConfig,
-    Events: eventsConfig
+    Events: ruleConfig
   } = cascade(alarmConfig)
 
   const cascadedFunctionAlarmConfigs = applyAlarmConfig(lambdaConfig, functionAlarmConfigs)
@@ -35,7 +35,7 @@ module.exports = function alarms (serverless, alarmConfig, functionAlarmConfigs,
   const { createSQSAlarms } = sqsAlarms(sqsConfig, context, serverless)
   const { createECSAlarms } = ecsAlarms(ecsConfig, context, serverless)
   const { createSNSAlarms } = snsAlarms(snsConfig, context, serverless)
-  const { createEventsAlarms } = eventsAlarms(eventsConfig, context, serverless)
+  const { createRuleAlarms } = ruleAlarms(ruleConfig, context, serverless)
 
   return {
     addAlarms
@@ -57,7 +57,7 @@ module.exports = function alarms (serverless, alarmConfig, functionAlarmConfigs,
       sqsConfig.enabled && createSQSAlarms(cfTemplate)
       ecsConfig.enabled && createECSAlarms(cfTemplate)
       snsConfig.enabled && createSNSAlarms(cfTemplate)
-      eventsConfig.enabled && createEventsAlarms(cfTemplate)
+      ruleConfig.enabled && createRuleAlarms(cfTemplate)
     }
   }
 }

serverless-plugin/dashboard.js

@@ -23,7 +23,7 @@ module.exports = function dashboard (serverless, dashboardConfig, functionDashbo
       SQS: sqsDashConfig,
       ECS: ecsDashConfig,
       SNS: snsDashConfig,
-      Events: eventsDashConfig
+      Events: ruleDashConfig
     }
   } = cascade(dashboardConfig)
 
@@ -518,7 +518,7 @@ module.exports = function dashboard (serverless, dashboardConfig, functionDashbo
       const ruleName = res.Properties.Name
 
       const widgetMetrics = []
-      for (const [metric, metricConfig] of Object.entries(getConfiguredMetrics(eventsDashConfig))) {
+      for (const [metric, metricConfig] of Object.entries(getConfiguredMetrics(ruleDashConfig))) {
         if (metricConfig.enabled) {
           for (const stat of metricConfig.Statistic) {
             widgetMetrics.push({
@@ -536,7 +536,7 @@ module.exports = function dashboard (serverless, dashboardConfig, functionDashbo
         const metricStatWidget = createMetricWidget(
           `Events rule ${ruleName}`,
           widgetMetrics,
-          eventsDashConfig
+          ruleDashConfig
         )
         ruleWidgets.push(metricStatWidget)
       }

serverless-plugin/default-config.yaml

@@ -194,7 +194,7 @@ dashboard:
       NumberOfNotificationsFailed:
         Statistic: ["Sum"]
     Events:
-    #EventBridge
+      #EventBridge
       FailedInvocations:
         Statistic: ["Sum"]
       ThrottledRules:

serverless-plugin/tests/alarms-eventbridge.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const eventsAlarms = require('../alarms-eventbridge')
+const ruleAlarms = require('../alarms-eventbridge')
 const { test } = require('tap')
 const defaultConfig = require('../default-config')
 const {
@@ -30,11 +30,11 @@ test('Events alarms are created', (t) => {
     }
   )
 
-  const eventsAlarmConfig = alarmConfig.Events
+  const ruleAlarmConfig = alarmConfig.Events
 
-  const { createEventsAlarms } = eventsAlarms(eventsAlarmConfig, testContext)
+  const { createRuleAlarms } = ruleAlarms(ruleAlarmConfig, testContext)
   const cfTemplate = createTestCloudFormationTemplate()
-  createEventsAlarms(cfTemplate)
+  createRuleAlarms(cfTemplate)
 
   const alarmResources = cfTemplate.getResourcesByType('AWS::CloudWatch::Alarm')
 
@@ -51,7 +51,7 @@ test('Events alarms are created', (t) => {
     const expectedMetric = expectedTypes[alarmType]
     t.equal(al.MetricName, expectedMetric)
     t.ok(al.Statistic)
-    t.equal(al.Threshold, eventsAlarmConfig[expectedMetric].Threshold)
+    t.equal(al.Threshold, ruleAlarmConfig[expectedMetric].Threshold)
     t.equal(al.EvaluationPeriods, 2)
     t.equal(al.TreatMissingData, 'breaching')
     t.equal(al.ComparisonOperator, 'GreaterThanOrEqualToThreshold')
@@ -85,12 +85,12 @@ test('Events alarms are not created when disabled globally', (t) => {
     }
   )
 
-  const eventsAlarmConfig = alarmConfig.Events
+  const ruleAlarmConfig = alarmConfig.Events
 
-  const { createEventsAlarms } = eventsAlarms(eventsAlarmConfig, testContext)
+  const { createRuleAlarms } = ruleAlarms(ruleAlarmConfig, testContext)
 
   const cfTemplate = createTestCloudFormationTemplate()
-  createEventsAlarms(cfTemplate)
+  createRuleAlarms(cfTemplate)
 
   const alarmResources = cfTemplate.getResourcesByType('AWS::CloudWatch::Alarm')
 

serverless-test-project/rule-handler.js

@@ -1,15 +1,11 @@
 'use strict'
 
-module.exports.handleRule = (event, context, callback) => {
+module.exports.handleRule = async (event) => {
   console.log(event)
-  if (event.sleepSeconds) {
-    return new Promise((resolve) => {
-      setTimeout(resolve, event.sleepSeconds * 1000)
-    })
-  }
-  if (event.triggerError) {
+  const e = Boolean(event.detail.triggerError)
+  if (e) {
     throw new Error('Error triggered')
+  } else {
+    console.log('Successful event delivery')
   }
-  console.log('Error occured')
-  return Error
 }

serverless-test-project/serverless.yml

@@ -12,17 +12,9 @@ custom:
     alarms:
       Lambda:
         Invocations:
-          enabled: false
-          Threshold: 10
-        DurationPc:
-          enabled: false
-          Threshold: 10
-        ThrottlesPc:
-          enabled: false
-          Threshold: 10
-        Errors:
-          enabled: false
+          enabled: true
           Threshold: 10
+
       SQS:
         AgeOfOldestMessage:
           Statistic: Maximum
@@ -97,11 +89,18 @@ functions:
 
   eventsRule:
     handler: rule-handler.handleRule
+    slicWatch:
+      alarms:
+          Lambda:
+            enabled: false
     events:
       - eventBridge:
           pattern:
             detail-type: 
             - Invoke Lambda Function
+          retryPolicy:
+            maximumEventAge: 60
+            maximumRetryAttempts: 2
 
 resources: ${file(./sls-resources.yml)}