multiple alerts with one file

Author: m.lindenberg

README.md

@@ -32,18 +32,29 @@ npm install serverless-plugin-alerting
 ```
 
  - place the alerting.json file next to your s-function.json in the directory of the function for which you want to configure alerting
+ - *AND/OR* place a global-alerting.json file next to your s-project.json file in the projects root folder
  - feel free to modify it as required
 
 ### Run the Plugin
 
  - the plugin uses a hook that is called after each deployment of a function 
  - you only have to deploy your function as usual `sls function deploy`
- - it searches in the function folder for the alerting.json file and adds the configured alerts
 
-### alerting.json
+#### Singe configuration for all functions
+    
+ - copy the file global-alerting.json into your projects root folder
+ - the provided alerts will be created for every deployed function automatically
+ - same structure as alerting.json
+ - these alerts were appended to the alerts defined in alerting.json 
 
-#### Structure
- - array of alerting definition objects (previous version: single alerting definition object still works)
+#### Special configuration for every function 
+
+ - copy the file alerting.json into your functions folder
+ - these alerts were appended to the alerts defined in global-alerting.json
+
+### Structure
+
+ - array of alerting definition objects
  - you can add multiple alerts as an array of alerting-objects
  - you can add multiple mertic filters as in array of metricfilter-objects
  - you can add multiple subscription filters as in array of subscritionfilter-objects
@@ -83,11 +94,13 @@ npm install serverless-plugin-alerting
     - @see https://github.com/martinlindenberg/serverless-plugin-sns :)
 
 #### Metric Filters
+
  - key: name of the metric filter that needs to be created
  - the values were used to fill up a aws-cli command
  - http://docs.aws.amazon.com/cli/latest/reference/logs/put-metric-filter.html
 
 #### Subscription Filters
+
  - key: name of the subscription filter that needs to be created
  - the values were used to fill up a aws-cli command
  - http://docs.aws.amazon.com/cli/latest/reference/logs/put-subscription-filter.html

alerting.json

@@ -30,7 +30,7 @@ sed_memory_label1,used_memory_label2,used_memory_label3,used_memory,used_memory_
             "Duration": {
                 "enabled": true,
                 "alarmNamespace": "AWS/Lambda",
-                "description": "Alarm if duration of the importer is above 500ms",
+                "description": "Alarm if duration of the function is above 500ms",
                 "alarmStatisticType": "Maximum",
                 "alarmPeriod": "60",
                 "alarmThreshold": "500",

global-alerting.json

@@ -0,0 +1,22 @@
+[
+    {
+        "notificationTopicStageMapping": {
+            "dev": "your-dev-sns-topic",
+            "testing": "your-testing-sns-topic",
+            "staging": "your-staging-sns-topic",
+            "live": "your-live-sns-topic"
+        },
+        "alerts": {
+            "Throttles": {
+                "enabled": true,
+                "alarmNamespace": "AWS/Lambda",
+                "description": "(Global) Alarm if function has more than 50 throttled requests",
+                "alarmStatisticType": "Sum",
+                "alarmPeriod": "60",
+                "alarmThreshold": "50",
+                "comparisonOperator": "GreaterThanOrEqualToThreshold",
+                "evaluationPeriod": "1"
+            }
+        }
+    }
+]

index.js

@@ -61,48 +61,58 @@ module.exports = function(S) {
         _manageAlerts (evt, region) {
             let _this = this;
 
-
             _this.stage = evt.options.stage;
             _this._initAws(region);
 
             if (S.cli.action != 'deploy' || (S.cli.context != 'function' && S.cli.context != 'dash'))
                 return;
 
-            var functionAlertSettings = _this._getFunctionsAlertSettings(evt, region);
+            // merges global and local alertsettings
+            var alertSettings = _this._mergeAlertSettings([
+                _this._getFunctionsAlertSettings(evt, region),
+                _this._getProjectAlertSettings(evt, region),
+            ]);
 
-            // no alert.json found
-            if (functionAlertSettings.length == 0) {
+            // no settings found
+            if (alertSettings.length == 0) {
                 return;
             }
 
-            var requiredTopics = _this._getRequiredTopics(functionAlertSettings);
+            var requiredTopics = _this._getRequiredTopics(alertSettings);
 
             return _this._createTopics(requiredTopics)
             .then(function(){
                 // topics exist now
                 let _this = this;
 
-                var metricFilterPromises = _this._createMetricFilters(functionAlertSettings, _this)
-                var subscriptionFilterPromises = _this._createSubscriptionFilters(functionAlertSettings, _this);
-                var alertPromises = _this._createAlerts(functionAlertSettings, _this);
-
-                BbPromise.all(metricFilterPromises)
-                .then(function(){
-                    console.log('metric filters created');
-                });
-
-                BbPromise.all(subscriptionFilterPromises)
-                .then(function(){
-                    console.log('subscription filters created');
-                });
+                var metricFilterPromises = _this._createMetricFilters(alertSettings, _this)
+                var subscriptionFilterPromises = _this._createSubscriptionFilters(alertSettings, _this);
+                var alertPromises = _this._createAlerts(alertSettings, _this);
 
-                BbPromise.all(alertPromises)
-                .then(function(){
-                    console.log('alerts created');
-                });
+                if (metricFilterPromises.length > 0) {
+                    BbPromise.all(metricFilterPromises)
+                    .then(function(){
+                        console.log('metric filters created');
+                    });
+                }
+    
+                if (subscriptionFilterPromises.length > 0) {
+                    BbPromise.all(subscriptionFilterPromises)
+                    .then(function(){
+                        console.log('subscription filters created');
+                    });
+                }
+                
+                if(alertPromises.length > 0) {
+                    BbPromise.all(alertPromises)
+                    .then(function(){
+                        console.log('alerts created');
+                    });
+                }
 
             }.bind(_this))
             .catch(function(e){
+                console.log('e', e)
                 SCli.log('error in creating alerts', e)
             });
         }
@@ -336,6 +346,25 @@ module.exports = function(S) {
             return topics;
         }
 
+        /** 
+         * receives a list of settings and merges them (AND-Connected)
+         *
+         * @param array settingsList
+         *
+         * @return array
+         */
+        _mergeAlertSettings(settingsList){
+            var result = [];
+
+            for (var i in settingsList) {
+                for (var j in settingsList[i]) {
+                    result.push(settingsList[i][j]);
+                }
+            }
+
+            return result;
+        }
+
         /**
          * parses the alert json file and returns the data
          *
@@ -347,8 +376,9 @@ module.exports = function(S) {
         _getFunctionsAlertSettings(evt, region){
             let _this = this;
             var settings = [];
+
             for (var deployedIndex in evt.data.deployed[region]) {
-                let deployed = evt.data.deployed[region][deployedIndex],
+                var deployed = evt.data.deployed[region][deployedIndex],
                     functionName = deployed['functionName'],
                     alertPathFile = S.getProject().getFunction(functionName).getFilePath().replace('s-function.json', 'alerting.json');
 
@@ -377,6 +407,46 @@ module.exports = function(S) {
             return settings;
         }
 
+        /**
+         * parses the global alert josn file and returns data
+         *
+         * @param object evt
+         * @param string region
+         *
+         * @return array
+         */
+        _getProjectAlertSettings(evt, region){
+            let _this = this;
+            var settings = [];
+
+            var globalAlertFile = S.getProject().getRootPath('global-alerting.json');
+
+            if (!fs.existsSync(globalAlertFile)) {
+                return settings;
+            }
+            try {
+                // each deployed function receives its alert settings
+                for (var deployedIndex in evt.data.deployed[region]) {
+                    var deployed = evt.data.deployed[region][deployedIndex];
+                    var alertContents = JSON.parse(fs.readFileSync(globalAlertFile));
+
+                    if (!alertContents.length > 0) {
+                        alertContents = [alertContents];
+                    }
+
+                    for (var i in alertContents) {
+                        alertContents[i].Arn = deployed.Arn;
+                    }
+
+                    settings.push(alertContents);
+                }
+            } catch (e) {
+                console.log('global-alerting.json not readable');
+            }
+
+            return settings;
+        }
+
 
         /**
          * @deprecated
@@ -415,7 +485,7 @@ module.exports = function(S) {
         _getAlarmConfig(functionName, metric, alertConfig, stage, topicName, notificationAction) {
             let resourceName = functionName + ":" + stage;
 
-            return {
+            var config = {
                 AlarmName: resourceName + ' ' + metric + ' -> ' + topicName,
                 ComparisonOperator: alertConfig.comparisonOperator,
                 EvaluationPeriods: alertConfig.evaluationPeriod,
@@ -433,6 +503,8 @@ module.exports = function(S) {
                 OKActions: [notificationAction],
                 AlarmActions: [notificationAction]
             };
+
+            return config;
         }
     }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-alerting",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "engines": {
     "node": ">=4.0"
   },