@5minds/node-red-contrib-processcube-elasticsearch 0.1.0-develop-8b9e46-m19i7dxw

package/.github/workflows/build-and-publish.yml

@@ -0,0 +1,72 @@
+name: Build and Publish
+
+on:
+  push:
+    branches:
+      - '*'
+      - '*/*'
+
+env:
+  CI_TOOLS_VERSION: '^4.2.0'
+  # NOTE: Um den Releasezyklus von Alpha nach Beta zu ändern, einfach die nachfolgend deklarierten Env Variablen switchen.
+  CI_TOOLS_ALPHA_BRANCH: next
+  CI_TOOLS_ALPHA_NPM_TAG: next
+  CI_TOOLS_STABLE_BRANCH: main
+  # CI_TOOLS_BETA_BRANCH: next
+  # CI_TOOLS_BETA_NPM_TAG: next
+  #BOX_RELEASE_TAG: 2024-1
+
+jobs:
+  build_and_publish:
+    name: 'Build and publish sources'
+    runs-on: ubuntu-latest
+    if: "!(contains(github.actor, 'process-engine-ci') || contains(github.actor, 'admin'))"
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GH_TOKEN }}
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install CI Tools
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm i -g @5minds/product_ci_tools@${{ env.CI_TOOLS_VERSION }}
+
+      - name: 'Install Dependencies'
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm ci
+
+      - name: 'Prepare Version'
+        if: "!startsWith(github.ref_name, 'renovate')"
+        run: ci_tools prepare-version --allow-dirty-workdir
+
+      - name: 'Commit & Tag Version'
+        if: "!startsWith(github.ref_name, 'renovate')"
+        env:
+          GH_USER: ${{ secrets.GH_USER }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: |
+          ci_tools commit-and-tag-version --only-on-primary-branches
+          ci_tools update-github-release --only-on-primary-branches --use-title-and-text-from-git-tag
+
+      - name: 'Publish Version'
+        if: "!startsWith(github.ref_name, 'renovate')"
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: ci_tools publish-npm-package --create-tag-from-branch-name
+
+    #   - name: Add Box-Release Tag
+    #     if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/next'
+    #     env:
+    #       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    #     run: |
+    #       VERSION="$(ci_tools get-version)"
+    #       npm dist-tag add @5minds/processcube_app_sdk@$VERSION ${{ env.BOX_RELEASE_TAG }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 5Minds IT-Solutions GmbH & Co. KG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/elastic-search-logger.html

@@ -0,0 +1,52 @@
+<script type="text/javascript">
+    RED.nodes.registerType('elastic-search-logger',{
+        category: 'config',
+        credentials: {
+          username: {type:"text"},
+          password: {type:"password"},
+          index: {type:"text"}
+        },
+        defaults: {
+            name: { value: "" },
+            url: {value:"http://localhost:9200"},
+            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; },
+      });
+    </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>
+        </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">
+        </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">
+        </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">
+        </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">
+        </div>
+      </div>  
+    </script>
+    
+    <script type="text/x-red" data-help-name="elastic-search-logger">
+        <p>The configuration for the elastic-search-logger.</p>
+        <p>Configurations like the requested URL to Elastic, Username & Password and the Elastic Index.</p>
+    </script>
+  

package/elastic-search-logger.js

@@ -0,0 +1,201 @@
+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
+      })
+
+      transports.push(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");
+
+    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}`);
+    }
+
+    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;
+  }
+
+  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);
+  }
+};

package/elastic-search.html

@@ -0,0 +1,114 @@
+<script type="text/javascript">
+  RED.nodes.registerType('elastic-search', {
+    category: 'Custom Nodes',
+    color: '#E9967A',
+    defaults: {
+      name: {
+        value: ""
+      },
+      logger: { value: "", type: "elastic-search-logger" },
+      complete: {
+        value: "false",
+        required: true
+      },
+      loglevel: {
+        value: "Debug",
+        required: true
+      }
+    },
+    inputs: 1,
+    outputs: 0,
+    icon: "file.svg",
+    align: "right",
+    label: function () {
+      return this.name || "elastic-search";
+    },
+    oneditprepare: function () {
+      // message
+      $("#node-input-typed-complete").typedInput({
+        types: ['msg']
+      });
+
+      $("#node-input-typed-complete").typedInput('type', 'msg');
+      $("#node-input-typed-complete").typedInput('value', "payload");
+      $("#node-input-typed-complete").on('change', function () {
+        if ($("#node-input-typed-complete").typedInput('type') === 'msg' &&
+          $("#node-input-typed-complete").typedInput('value') === ''
+        ) {
+          $("#node-input-typed-complete").typedInput('value', 'payload');
+        }
+      });
+
+      // loglevel
+      $("#node-input-typed-loglevel").typedInput({
+        types: [
+          'msg',
+          {
+            value: "level",
+            label: "level",
+            options: ["Error", "Warning", "Information", "Debug"]
+          }
+        ]
+      });
+
+      if (this.loglevel === "Error" ||
+        this.loglevel === "Warning" ||
+        this.loglevel === "Information" ||
+        this.loglevel === "Debug") {
+        // fixed level
+        $("#node-input-typed-loglevel").typedInput('type', 'level');
+        $("#node-input-typed-loglevel").typedInput('value', this.loglevel);
+      } else {
+        $("#node-input-typed-loglevel").typedInput('type', 'msg');
+        $("#node-input-typed-loglevel").typedInput('value', this.loglevel);
+      }
+      $("#node-input-typed-loglevel").on('change', function () {
+        if ($("#node-input-typed-loglevel").typedInput('type') === 'msg') {
+          var value = $("#node-input-typed-loglevel").typedInput('value')
+          if (value === "Error" || value === "Warning" || value === "Information" || value === "Debug") {
+            $("#node-input-typed-loglevel").typedInput('value', 'loglevel');
+          }
+        }
+      });
+    },
+    oneditsave: function () {
+      $("#node-input-complete").val($("#node-input-typed-complete").typedInput('value'));
+
+      $("#node-input-loglevel").val($("#node-input-typed-loglevel").typedInput('value'));
+    }
+  });
+</script>
+
+<script type="text/x-red" data-template-name="elastic-search">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-logger"><i class="fa fa-random"></i> Logger</label>
+        <input type="text" id="node-input-logger" >
+    </div>
+    <div class="form-row">
+      <label for="node-input-typed-loglevel"><i class="fa fa-list"></i> Log Level</label>
+      <input id="node-input-typed-loglevel" type="text">
+      <input id="node-input-loglevel" type="hidden">
+    </div>
+    <div class="form-row">
+        <label for="node-input-typed-complete"><i class="fa fa-list"></i> Output</label>
+        <input id="node-input-typed-complete" type="text">
+        <input id="node-input-complete" type="hidden">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="elastic-search">
+    <p>A logging node for Elastic Search using the winston and winston-elastic logging libraries</p>
+    <h3>Details</h3>
+    <p>Output <code>msg.payload</code> (or <code>msg.&lt;custom path&gt;</code>) or complete <code>msg</code> is used as input of the logged message.</p>
+    <p>The Log Level (Error, Warning, Information, Debug) used can be configured in the node or can be set
+    by <code>msg.loglevel</code> (or <code>msg.&lt;custom path&gt;</code>). 
+    If the content is not one of ('Error', 'Warning', 'Information', 'Debug'), 'Debug' will be used as fallback</p>
+    <p>If <code>msg.meta</code> is set, the meta info Object will be added to the file and ElasticSearch output as a JSON string.</p>
+
+    <h3>References</h3>
+    <p>This node is based on parts of node-red-contrib-advance-logger</p>
+</script>

package/elastic-search.js

@@ -0,0 +1,44 @@
+module.exports = function (RED) {
+    "use strict";
+
+    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);
+
+        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) {
+                    // fixed level
+                    level = loglevel;
+                } else {
+                    // get loglevel from message
+                    try { level = RED.util.getMessageProperty(msg, loglevel); }
+                    catch (err) {
+                        level = Debug;
+                    }
+
+                    if (!(level === Error || level === Warning || level === Information || level === Debug)) {
+                        // invalid log level, default to debug
+                        level = Debug;
+                    }
+                }
+
+                node.logger.addToLog(level, msg);
+            }
+
+            if (done) done();
+        });
+    }
+
+    RED.nodes.registerType("elastic-search", LogElasticNode);
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+    "name": "@5minds/node-red-contrib-processcube-elasticsearch",
+    "version": "0.1.0-develop-8b9e46-m19i7dxw",
+    "license": "MIT",
+    "description": "Node-RED nodes for Elasticsearch",
+    "scripts": {
+        "lint": "prettier --write --config ./.prettierrc.json \"**/*.{html,js}\""
+    },
+    "authors": [
+        {
+            "name": "Robin Lenz",
+            "email": "Robin.Lenz@5Minds.de"
+        }
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/5minds/node-red-contrib-processcube-elasticsearch"
+    },
+    "bugs": {
+        "url": "https://github.com/5minds/node-red-contrib-processcube-elasticsearch/issues",
+        "email": "processcube@5minds.de"
+    },
+    "engines": {
+        "node": ">=14",
+        "npm": ">=8.0.0"
+    },
+    "node-red": {
+        "version": ">=3.1.9",
+        "nodes": {
+            "elastic-search": "elastic-search.js",
+            "elastic-search-logger": "elastic-search-logger.js"
+        },
+        "examples": "examples"
+    },
+    "dependencies": {
+        "winston": "^3.8.2",
+        "winston-elasticsearch": "^0.15.9"
+    },
+    "keywords": [
+        "node-red",
+        "processcube",
+        "low-code",
+        "elasticsearch"
+    ]
+}