@5minds/node-red-contrib-processcube-elasticsearch 0.2.0 → 0.3.0-add-update-cycle-4db609-m3r9rkdh

package/elastic-search-logger.html

@@ -8,39 +8,92 @@
         },
         defaults: {
             name: { value: "" },
-            url: {value:"http://localhost:9200"},
+            url: { value: "http://localhost:9200" },
+            urlType: { value: "str" },
+            usernameType: { value: "str" },
+            passwordType: { value: "str" },
+            indexType: { value: "str" },
             filename: { value: "log-elastic.log", required: true },
             maxsize: { value: 1, required: true, validate: function(v) { return v >= 1 } },
             maxfiles: { value: 2, required: true, validate: function(v) { return v >= 1 } },
         },
-        label: function() { return this.name; },
+        label: function () { return this.name; },
+        oneditprepare: function () {
+            // URL
+            $("#node-config-input-url").typedInput({
+                type: this.urlType,
+                types: [
+                    "str",
+                    "global"
+                ],
+                typeField: "#node-config-input-urlType",
+                value: this.url
+            })
+
+            // Username
+            $("#node-config-input-username").typedInput({
+                type: this.usernameType,
+                types:[
+                    "str",
+                    "global"
+                ],
+                typeField: "#node-config-input-usernameType",
+                value: this.credentials.username
+            })
+
+            // Password
+            $("#node-config-input-password").typedInput({
+                type: this.passwordType,
+                types:[
+                    "str",
+                    "global"
+                ],
+                typeField: "#node-config-input-passwordType",
+                value: this.credentials.password
+            })
+
+            // Index
+            $("#node-config-input-index").typedInput({
+                type: this.indexType,
+                types:[
+                    "str",
+                    "global"
+                ],
+                typeField: "#node-config-input-indexType",
+                value: this.credentials.index
+            })
+        }
       });
-    </script>
-    
-    <script type="text/html" data-template-name="elastic-search-logger">
-        <div class="form-row">
-            <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
-            <input type="text" id="node-config-input-name" placeholder="Name">
-        </div>
-      <div id="elkfields">
+</script>
+
+<script type="text/html" data-template-name="elastic-search-logger">
+    <div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="Name">
+    </div>
+    <div id="elkfields">
         <div class="form-row">
-          <label style="width:100%;"><span>ElasticSearch options</span></label>
+            <label style="width:100%;"><span>ElasticSearch options</span></label>
         </div>
         <div class="form-row" style="padding-left:20px;">
-          <label for="node-config-input-url"><i class="fa fa-plug"></i> Elastic URL</label>
-          <input type="text" id="node-config-input-url">
+            <label for="node-config-input-url"><i class="fa fa-plug"></i> Elastic URL</label>
+            <input type="text" id="node-config-input-url">
+            <input type="hidden" id="node-config-input-urlType">
         </div>
         <div class="form-row" style="padding-left:20px;">
-          <label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
-          <input type="text" id="node-config-input-username">
+            <label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
+            <input type="text" id="node-config-input-username">
+            <input type="hidden" id="node-config-input-usernameType">
         </div>
         <div class="form-row" style="padding-left:20px;">
-          <label for="node-config-input-password"><i class="fa fa-key"></i> Password</label>
-          <input type="password" id="node-config-input-password">
+            <label for="node-config-input-password"><i class="fa fa-key"></i> Password</label>
+            <input type="password" id="node-config-input-password">
+            <input type="hidden" id="node-config-input-passwordType">
         </div>
         <div class="form-row" style="padding-left:20px;">
-          <label for="node-config-input-index"><i class="fa fa-tag"></i> Index</label>
-          <input type="text" id="node-config-input-index">
+            <label for="node-config-input-index"><i class="fa fa-tag"></i> Index</label>
+            <input type="text" id="node-config-input-index">
+            <input type="hidden" id="node-config-input-indexType">
         </div>
       </div>  
     </script>

package/elastic-search-logger.js

@@ -1,201 +1,145 @@
 module.exports = function (RED) {
-  "use strict";
-
-  function LogElasticLoggerNode(config) {
-    let winston = require('winston');
-    let winstonElasticSearch = require('winston-elasticsearch');
-    let os = require("os");
-    this.hostname = os.hostname();
-
-    RED.nodes.createNode(this, config);
-    this.logger = null;
-    let transports = [];
-
-    // Elastic settings
-    let url = config.url;
-    let user = this.credentials.username || '';
-    let password = this.credentials.password || '';
-    let index = this.credentials.index || '';
-    if (index == '') {
-      this.error("Elastic search index is not set");
-    }
-    index = index.toLowerCase();
-    if (url) {
-      const elasticSearchTransport = new winstonElasticSearch.ElasticsearchTransport({
-        clientOpts: {
-          node: url,
-          auth: {
-            username: user,
-            password: password
-          },
-          ssl: {
-            // accept any
-            rejectUnauthorized: false
-          }
-        },
-        transformer: (logData) => setElasticFields(logData, this),
-        index: index
-      })
+    'use strict';
+
+    function LogElasticLoggerNode(config) {
+        let winston = require('winston');
+        let winstonElasticSearch = require('winston-elasticsearch');
+
+        RED.nodes.createNode(this, config);
+        this.logger = null;
+        let transports = [];
+
+        const stopRefreshing = periodicallyRefreshElasticSettings(10000);
+
+        function periodicallyRefreshElasticSettings(timeOut) {
+            let url, user, password, index;
+
+            function refresh() {
+                // Elastic settings
+                let newUrl = RED.util.evaluateNodeProperty(config.url, config.urlType, this);
+                if (newUrl == '') {
+                    this.error('Elastic search url is not set');
+                    return;
+                }
+
+                let newUser = RED.util.evaluateNodeProperty(this.credentials.username, config.usernameType, this);
+                if (newUser == '') {
+                    this.error('Elastic search username is not set');
+                    return;
+                }
+
+                let newPassword = RED.util.evaluateNodeProperty(this.credentials.password, config.passwordType, this);
+                if (newPassword == '') {
+                    this.error('Elastic search password is not set');
+                    return;
+                }
+
+                let newIndex = RED.util.evaluateNodeProperty(this.credentials.index, config.indexType, this);
+                if (newIndex == '') {
+                    this.error('Elastic search index is not set');
+                    return;
+                }
+
+                if (newUrl === url && newUser === user && newPassword === password && newIndex === index) {
+                    return;
+                }
+
+                if (this.logger) this.logger.close();
+
+                url = newUrl;
+                user = newUser;
+                password = newPassword;
+                index = newIndex;
+
+                index = index.toLowerCase();
+                if (url) {
+                    const elasticSearchTransport = new winstonElasticSearch.ElasticsearchTransport({
+                        clientOpts: {
+                            node: url,
+                            auth: {
+                                username: user,
+                                password: password,
+                            },
+                            ssl: {
+                                // accept any
+                                rejectUnauthorized: false,
+                            },
+                        },
+                        transformer: (logData) => setElasticFields(logData, this),
+                        index: index,
+                    });
+
+                    transports = [elasticSearchTransport];
+
+                    elasticSearchTransport.on('error', (error) => {
+                        this.error(`Error in elasticSearchTransport caught: ${error.message}`);
+                        console.error('Error in elasticSearchTransport caught', error);
+                    });
+                }
+
+                let logLevels = {
+                    levels: {
+                        Error: 0,
+                        Warning: 1,
+                        Information: 2,
+                        Debug: 3,
+                    },
+                };
+                this.logger = new winston.createLogger({
+                    exitOnError: false,
+                    level: 'Debug',
+                    levels: logLevels.levels,
+                    transports: transports,
+                });
+
+                this.debug('elastic-search logger created');
+            }
+
+            refresh();
+            const intervalId = setInterval(refresh, timeOut);
+
+            return () => clearInterval(intervalId);
+        }
 
-      transports.push(elasticSearchTransport);
+        this.on('close', function (removed, done) {
+            stopRefreshing();
+            // close logger
+            if (this.logger) {
+                this.logger.close();
+            }
 
-      elasticSearchTransport.on('error', (error) => {
-        this.error(`Error in elasticSearchTransport caught: ${error.message}`);
-        console.error('Error in elasticSearchTransport caught', error);
-      });
-    }
+            this.debug('elastic-search logger closed');
 
-    let logLevels = {
-      levels: {
-        Error: 0,
-        Warning: 1,
-        Information: 2,
-        Debug: 3
-      }
+            if (done) done();
+        });
     }
-    this.logger = new winston.createLogger({
-      exitOnError: false,
-      level: 'Debug',
-      levels: logLevels.levels,
-      transports: transports
-    });
-
-    this.debug("elastic-search logger created");
 
-    this.on('close', function (removed, done) {
-      // close logger
-      if (this.loggger) {
-        this.logger.close();
-      }
-
-      this.debug("elastic-search logger closed");
-
-      if (done) done();
-    });
-  }
-
-  function setElasticFields(logData, node) {
-    logData = mergeFieldsIntoMessage(logData, node);
-
-    let { ElasticsearchTransformer } = require('winston-elasticsearch');
-    const transformed = ElasticsearchTransformer(logData);
-    transformed['@timestamp'] = logData.timestamp ? logData.timestamp : new Date().toISOString();
-    transformed.message = logData.message;
-    transformed.messageTemplate = logData.messageTemplate;
-    transformed.severity = logData.level;
-    transformed.level = logData.level;
-    transformed.fields = logData.meta;
-
-    if (logData.meta['transaction.id']) transformed.transaction = { id: logData.meta['transaction.id'] };
-    if (logData.meta['trace.id']) transformed.trace = { id: logData.meta['trace.id'] };
-    if (logData.meta['span.id']) transformed.span = { id: logData.meta['span.id'] };
-
-    return transformed;
-  };
-
-  RED.nodes.registerType("elastic-search-logger", LogElasticLoggerNode,
-    {
-      credentials: {
-        username: { type: "text" },
-        password: { type: "password" },
-        index: { type: "text" }
-      }
-    });
-
-  LogElasticLoggerNode.prototype.addToLog = function addTolog(loglevel, msg) {
-    this.logger.log(loglevel, msg.payload.message, msg.payload.meta);
-  }
-
-  // Extract {fields} from message and add them to meta.
-  // Store original message in messageTemplate.
-  // Replace {fields} with values in message.
-  function mergeFieldsIntoMessage(logData, node) {
-    try {
-      if (logData.message == null) {
-        node.error("Message is null");
-        return logData;
-      }
-
-      var fieldNames = extractAllFieldNames(logData);
-      addAllFieldsToMeta(logData, fieldNames);
-      replaceFieldsInMessage(logData, fieldNames);
-      addFixedFieldsToLogData(logData, node);
-    } catch (error) {
-      const serializedLogData = serializeData(logData);
-      node.error(`Error merging fields into message: ${error.message}\nlogData: ${serializedLogData}\nStack trace: ${error.stack}`);
+    function setElasticFields(logData, node) {
+        let { ElasticsearchTransformer } = require('winston-elasticsearch');
+        const transformed = ElasticsearchTransformer(logData);
+        transformed['@timestamp'] = logData.timestamp ? logData.timestamp : new Date().toISOString();
+        transformed.message = logData.message;
+        transformed.messageTemplate = logData.messageTemplate;
+        transformed.severity = logData.level;
+        transformed.level = logData.level;
+        transformed.fields = logData.meta;
+
+        if (logData.meta['transaction.id']) transformed.transaction = { id: logData.meta['transaction.id'] };
+        if (logData.meta['trace.id']) transformed.trace = { id: logData.meta['trace.id'] };
+        if (logData.meta['span.id']) transformed.span = { id: logData.meta['span.id'] };
+
+        return transformed;
     }
 
-    return logData;
-  }
-
-  function extractAllFieldNames(logData) {
-    var fieldNames = [];
-    var message = logData.message;
-
-    var index = 0;
-    while (index != -1 && fieldNames.length < logData.meta?.fields?.length) {
-      index = message.indexOf("{", index);
-      if (index != -1) {
-        var endIndex = message.indexOf("}", index);
-        var fieldName = message.substring(index + 1, endIndex);
-        fieldNames.push(fieldName);
-        index = endIndex;
-      }
-    }
-
-    return fieldNames;
-  }
-
-  function addAllFieldsToMeta(logData, fieldNames) {
-    for (var i = 0; i < fieldNames.length; i++) {
-      var fieldName = fieldNames[i];
-      var fieldValue = logData.meta.fields[i];
-
-      if (typeof fieldValue === 'string') {
-        if (fieldValue.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i)) {
-          logData.meta[fieldName + "_Guid"] = fieldValue;
-        } else {
-          logData.meta[fieldName + "_String"] = fieldValue;
-        }
-      } else if (typeof fieldValue === 'number') {
-        logData.meta[fieldName + "_Number"] = fieldValue;
-      } else if (typeof fieldValue === 'boolean') {
-        logData.meta[fieldName + "_Boolean"] = fieldValue;
-      } else if (typeof fieldValue === 'object' && fieldValue instanceof Date) {
-        logData.meta[fieldName + "_DateTime"] = fieldValue;
-      } else {
-        logData.meta[fieldName] = fieldValue;
-      }
-    }
-  }
-
-  function replaceFieldsInMessage(logData, fieldNames) {
-    // Replace all field names in message with values from fields
-    logData.messageTemplate = logData.message.slice();
-    for (var i = 0; i < fieldNames.length; i++) {
-      var fieldName = fieldNames[i];
-      var fieldValue = logData.meta.fields[i];
-      var replacement = typeof fieldValue === 'string' ? "'" + fieldValue + "'" : fieldValue;
-      logData.message = logData.message.replace("{" + fieldName + "}", replacement);
-    }
-
-    // Remove fields from meta
-    delete logData.meta.fields;
-  }
-
-  function addFixedFieldsToLogData(logData, node) {
-    logData.meta['Origin_String'] = 'Node-RED';
-    logData.meta['MachineName_String'] = node.hostname;
-  }
+    RED.nodes.registerType('elastic-search-logger', LogElasticLoggerNode, {
+        credentials: {
+            username: { type: 'text' },
+            password: { type: 'password' },
+            index: { type: 'text' },
+        },
+    });
 
-  function serializeData(data) {
-    return JSON.stringify(data, (key, value) => {
-      if (typeof value === 'object' && value !== null && value !== undefined) {
-        if (value instanceof Date) {
-          return value.toISOString();
-        }
-      }
-      return value;
-    }, 2);
-  }
+    LogElasticLoggerNode.prototype.addToLog = function addTolog(loglevel, msg) {
+        this.logger.log(loglevel, msg.payload.message, msg.payload.meta);
+    };
 };

package/elastic-search.js

@@ -1,20 +1,20 @@
 module.exports = function (RED) {
-    "use strict";
+    'use strict';
 
-    const Error = "Error"
-    const Warning = "Warning"
-    const Information = "Information"
-    const Debug = "Debug"
+    const Error = 'Error';
+    const Warning = 'Warning';
+    const Information = 'Information';
+    const Debug = 'Debug';
 
     function LogElasticNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
 
-        this.logger = RED.nodes.getNode(config.logger);
+        this.on('input', function (msg, send, done) {
+            node.logger = RED.nodes.getNode(config.logger);
 
-        let loglevel = config.loglevel || "";
+            let loglevel = config.loglevel || '';
 
-        this.on('input', function (msg, send, done) {
             if (node.logger) {
                 let level;
                 if (loglevel === Error || loglevel === Warning || loglevel === Information || loglevel === Debug) {
@@ -22,8 +22,9 @@ module.exports = function (RED) {
                     level = loglevel;
                 } else {
                     // get loglevel from message
-                    try { level = RED.util.getMessageProperty(msg, loglevel); }
-                    catch (err) {
+                    try {
+                        level = RED.util.getMessageProperty(msg, loglevel);
+                    } catch (err) {
                         level = Debug;
                     }
 
@@ -40,5 +41,5 @@ module.exports = function (RED) {
         });
     }
 
-    RED.nodes.registerType("elastic-search", LogElasticNode);
-};
+    RED.nodes.registerType('elastic-search', LogElasticNode);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube-elasticsearch",
-    "version": "0.2.0",
+    "version": "0.3.0-add-update-cycle-4db609-m3r9rkdh",
     "license": "MIT",
     "description": "Node-RED nodes for Elasticsearch",
     "scripts": {
@@ -27,14 +27,14 @@
     "node-red": {
         "version": ">=3.1.9",
         "nodes": {
-            "elastic-search":  "elastic-search.js",
-            "elastic-search-logger":  "elastic-search-logger.js"
+            "elastic-search": "elastic-search.js",
+            "elastic-search-logger": "elastic-search-logger.js"
         },
         "examples": "examples"
     },
     "dependencies": {
-        "winston":  "^3.17.0",
-        "winston-elasticsearch":  "^0.19.0"
+        "winston": "^3.17.0",
+        "winston-elasticsearch": "^0.19.0"
     },
     "keywords": [
         "node-red",