Merge pull request #147 from autoalan/reportWebex

Add support for Webex Teams Notificaitons

AUTHORS

@@ -12,6 +12,7 @@ If this list is not up to date, please contact NTT or one of the authors.
 - CONTRIBUTORS -
     Damian Zaremba, Fastly
     Mircea Ulinic, DigitalOcean
+    Alan Haynes, Harbin Clinic 
 
 
 A special THANK YOU goes to:

README.md

@@ -50,6 +50,7 @@ Please uncomment the related section and configure according to your needs.
             - [reportKafka](docs/configuration.md#reportkafka)
             - [reportSyslog](docs/configuration.md#reportsyslog)
             - [reportAlerta](docs/configuration.md#reportalerta)
+            - [reportWebex](docs/configuration.md#reportwebex)
     - [Process/Uptime monitoring](docs/process-monitors.md)
 - [More information for developers](docs/develop.md)
     - [All npm commands](docs/develop.md#all-npm-commands)

config.yml.example

@@ -153,6 +153,16 @@ reports:
 #      urls:
 #        default: _YOUR_ALERTA_API_URL_
 
+#  - file: reportWebex
+#    channels:
+#      - hijack
+#      - newprefix
+#      - visibility
+#      - path
+#      - misconfiguration
+#      hooks:
+#        default: _YOUR_WEBEX_WEBHOOK_URL_
+
 
 ############################
 # Notification settings:

docs/configuration.md

@@ -343,3 +343,14 @@ Parameters for this report module:
 |urls| A dictionary containing Alerta API URLs grouped by user group (key: group, value: API URL). |
 |urls.default| The Alerta API URL of the default user group. |
 
+#### reportWebex
+
+This report module sends alerts on [Webex Teams](https://teams.webex.com).
+
+Parameters for this report module:
+
+|Parameter| Description| 
+|---|---|
+|hooks| A dictionary containing Webex Teams WebHooks grouped by user group (key: group, value: WebHook).| 
+|hooks.default| The WebHook (URL) of the default user group.| 
+

src/reports/reportWebex.js

@@ -0,0 +1,92 @@
+/*
+ * 	BSD 3-Clause License
+ *
+ * Copyright (c) 2019, NTT Ltd.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *  Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ *  Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ *  Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import Report from "./report";
+import axios from "axios";
+
+export default class ReportWebex extends Report {
+
+    constructor(channels, params, env) {
+        super(channels, params, env);
+
+
+        this.enabled = true;
+        if (!this.params.hooks || !Object.keys(this.params.hooks).length){
+            this.logger.log({
+                level: 'error',
+                message: "Webex reporting is not enabled: no group is defined"
+            });
+            this.enabled = false;
+        } else {
+            if (!this.params.hooks["default"]) {
+                this.logger.log({
+                    level: 'error',
+                    message: "In hooks, for reportWebex, a group named 'default' is required for communications to the admin."
+                });
+            }
+        }
+
+    }
+
+    _sendWebexMessage = (url, message, content) => {
+
+        axios({
+            url: url,
+            method: "POST",
+            resposnseType: "json",
+            data: {
+                markdown: `**${message}**: ${content.message}` 
+            }
+        })
+            .catch((error) => {
+                this.logger.log({
+                    level: 'error',
+                    message: error
+                });
+            })
+    };
+
+    report = (message, content) => {
+        if (this.enabled){
+            let groups = content.data.map(i => i.matchedRule.group).filter(i => i != null);
+
+            groups = (groups.length) ? [...new Set(groups)] : Object.keys(this.params.hooks); // If there are no groups defined, send to all of them
+
+            for (let group of groups) {
+                if (this.params.hooks[group]) {
+                    this._sendWebexMessage(this.params.hooks[group], message, content);
+                }
+            }
+        }
+
+    }
+}