node-opcua-vendor-diagnostic 2.51.0

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2021 Etienne Rossignon
+
+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/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./vendor_diagnostic_nodes";

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./vendor_diagnostic_nodes"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4DAA0C"}

package/dist/vendor_diagnostic_nodes.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ * optionally install a CPU Usage and Memory Usage node
+ * ( condition : running on linux and require("usage")
+ * @method install_optional_cpu_and_memory_usage_node
+ * @param server {OPCUAServer}
+ *
+ */
+export declare function install_optional_cpu_and_memory_usage_node(server: any): void;

package/dist/vendor_diagnostic_nodes.js

@@ -0,0 +1,250 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.install_optional_cpu_and_memory_usage_node = void 0;
+/* istanbul ignore file */
+// tslint:disable:no-console
+const os = require("os");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_constants_1 = require("node-opcua-constants");
+const node_opcua_server_1 = require("node-opcua-server");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+// tslint:disable:no-var-requires
+const humanize = require("humanize");
+/**
+ * @method addVariableWithHumanizeText
+ * @param namespace
+ * @param options
+ * @param options.browseName
+ * @private
+ */
+function addVariableWithHumanizeText(namespace, options) {
+    (0, node_opcua_assert_1.assert)(options.componentOf || options.organizedBy);
+    (0, node_opcua_assert_1.assert)(typeof options.description === "string");
+    const variable = namespace.addVariable(options);
+    // add the xxxAsText property
+    namespace.addVariable({
+        propertyOf: variable,
+        browseName: options.browseName.name.toString() + "AsText",
+        dataType: "String",
+        description: options.description + " as text",
+        minimumSamplingInterval: options.minimumSamplingInterval,
+        value: {
+            get() {
+                const v = options.value.get();
+                if (v instanceof node_opcua_variant_1.Variant) {
+                    return v;
+                }
+                else {
+                    return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.String, value: humanize.filesize(v.value) });
+                }
+            }
+        }
+    });
+}
+/**
+ *
+ * optionally install a CPU Usage and Memory Usage node
+ * ( condition : running on linux and require("usage")
+ * @method install_optional_cpu_and_memory_usage_node
+ * @param server {OPCUAServer}
+ *
+ */
+function install_optional_cpu_and_memory_usage_node(server) {
+    const engine = server.engine;
+    (0, node_opcua_assert_1.assert)(engine instanceof node_opcua_server_1.ServerEngine);
+    let usage;
+    try {
+        const usage_module = "usage"; // we use a variable here to prevent error in webpack
+        usage = require(usage_module); // a warning will be generated here with webpack as the module name is not a litteral
+    }
+    catch (err) {
+        if (err instanceof Error) {
+            console.log("err", err.message);
+        }
+        usage = null;
+        // xx return;
+    }
+    const addressSpace = engine.addressSpace;
+    const namespace = addressSpace.getOwnNamespace();
+    const vendorServerInfo = addressSpace.findNode(node_opcua_constants_1.ObjectIds.Server_VendorServerInfo);
+    let usage_result = { memory: 0, cpu: 100 };
+    const pid = process.pid;
+    if (usage) {
+        const options = { keepHistory: true };
+        setInterval(() => {
+            usage.lookup(pid, options, (err, result) => {
+                usage_result = result;
+                console.log("result Used Memory: ", humanize.filesize(result.memory), " CPU ", Math.round(result.cpu), " %");
+                if (err) {
+                    console.log("err ", err);
+                }
+            });
+        }, 1000);
+        namespace.addVariable({
+            componentOf: vendorServerInfo,
+            browseName: "CPUUsage",
+            dataType: "Double",
+            description: "Current CPU usage of the server process",
+            minimumSamplingInterval: 1000,
+            nodeId: "s=CPUUsage",
+            value: {
+                get: () => {
+                    if (!usage_result) {
+                        return node_opcua_status_code_1.StatusCodes.BadResourceUnavailable;
+                    }
+                    return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.Double, value: Math.round(usage_result.cpu) });
+                }
+            }
+        });
+        addVariableWithHumanizeText(namespace, {
+            componentOf: vendorServerInfo,
+            browseName: "MemoryUsage",
+            dataType: "Number",
+            description: "Current memory usage of the server process",
+            minimumSamplingInterval: 1000,
+            nodeId: "s=MemoryUsage",
+            value: {
+                get: () => {
+                    if (!usage_result) {
+                        return node_opcua_status_code_1.StatusCodes.BadResourceUnavailable;
+                    }
+                    return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.UInt32, value: usage_result.memory });
+                }
+            }
+        });
+    }
+    else {
+        console.log("skipping installation of cpu_usage and memory_usage nodes");
+    }
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+        browseName: "PercentageMemoryUsed",
+        dataType: "Number",
+        description: "% of  memory used by the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=PercentageMemoryUsed",
+        value: {
+            get() {
+                const percent_used = Math.round(((os.totalmem() - os.freemem()) / os.totalmem()) * 100);
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.Double, value: percent_used });
+            }
+        }
+    });
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "SystemMemoryTotal",
+        dataType: "Number",
+        description: "Total Memory usage of the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=SystemMemoryTotal",
+        value: {
+            get() {
+                const memory = os.totalmem();
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.UInt64, value: memory });
+            }
+        }
+    });
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "SystemMemoryFree",
+        dataType: "Number",
+        description: "Free Memory usage of the server in MB",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=SystemMemoryFree",
+        value: {
+            get() {
+                const memory = os.freemem();
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.UInt64, value: memory });
+            }
+        }
+    });
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "NumberOfCPUs",
+        dataType: "Number",
+        description: "Number of cpus on the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=NumberOfCPUs",
+        value: {
+            get() {
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.UInt32, value: os.cpus().length });
+            }
+        }
+    });
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "Arch",
+        dataType: "String",
+        description: "ServerArchitecture",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=ServerArchitecture",
+        value: {
+            get() {
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.String, value: os.type() });
+            }
+        }
+    });
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "BytesWritten",
+        dataType: "Number",
+        description: "number of bytes written by the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=BytesWritten",
+        value: {
+            get() {
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.UInt64, value: server.bytesWritten });
+            }
+        }
+    });
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "BytesRead",
+        dataType: "Number",
+        description: "number of bytes read by the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=BytesRead",
+        value: {
+            get() {
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.UInt64, value: server.bytesRead });
+            }
+        }
+    });
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "TransactionsCount",
+        dataType: "Number",
+        description: "total number of transactions performed the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=TransactionsCount",
+        value: {
+            get() {
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.UInt32, value: server.transactionsCount });
+            }
+        }
+    });
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+        accessLevel: "CurrentRead",
+        browseName: "ConnectionsCount",
+        dataType: "String",
+        description: "number of active Connections",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=ConnectionCount",
+        value: {
+            get() {
+                return new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.String, value: humanize.filesize(server.currentChannelCount) });
+            }
+        }
+    });
+}
+exports.install_optional_cpu_and_memory_usage_node = install_optional_cpu_and_memory_usage_node;
+//# sourceMappingURL=vendor_diagnostic_nodes.js.map

package/dist/vendor_diagnostic_nodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vendor_diagnostic_nodes.js","sourceRoot":"","sources":["../source/vendor_diagnostic_nodes.ts"],"names":[],"mappings":";;;AAAA,0BAA0B;AAC1B,4BAA4B;AAC5B,yBAAyB;AAGzB,yDAA2C;AAC3C,+DAAiD;AACjD,yDAAiD;AACjD,mEAAqD;AACrD,2DAAuD;AACvD,iCAAiC;AACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAErC;;;;;;GAMG;AACH,SAAS,2BAA2B,CAAC,SAAoB,EAAE,OAAY;IACnE,IAAA,0BAAM,EAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,IAAA,0BAAM,EAAC,OAAO,OAAO,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC;IAEhD,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAChD,6BAA6B;IAC7B,SAAS,CAAC,WAAW,CAAC;QAClB,UAAU,EAAE,QAAQ;QAEpB,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,QAAQ;QACzD,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,OAAO,CAAC,WAAW,GAAG,UAAU;QAC7C,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;QACxD,KAAK,EAAE;YACH,GAAG;gBACC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBAC9B,IAAI,CAAC,YAAY,4BAAO,EAAE;oBACtB,OAAO,CAAC,CAAC;iBACZ;qBAAM;oBACH,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;iBACxF;YACL,CAAC;SACJ;KACJ,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,0CAA0C,CAAC,MAAW;IAClE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,IAAA,0BAAM,EAAC,MAAM,YAAY,gCAAY,CAAC,CAAC;IAEvC,IAAI,KAAU,CAAC;IACf,IAAI;QACA,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,qDAAqD;QACnF,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,qFAAqF;KACvH;IAAC,OAAO,GAAG,EAAE;QACV,IAAI,GAAG,YAAY,KAAK,EAAE;YACtB,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;SACnC;QACD,KAAK,GAAG,IAAI,CAAC;QACb,aAAa;KAChB;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;IAEzC,MAAM,SAAS,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAEjD,MAAM,gBAAgB,GAAG,YAAY,CAAC,QAAQ,CAAC,gCAAS,CAAC,uBAAuB,CAAC,CAAC;IAElF,IAAI,YAAY,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IAE3C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,IAAI,KAAK,EAAE;QACP,MAAM,OAAO,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QACtC,WAAW,CAAC,GAAG,EAAE;YACb,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,GAAiB,EAAE,MAAW,EAAE,EAAE;gBAC1D,YAAY,GAAG,MAAM,CAAC;gBACtB,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;gBAC7G,IAAI,GAAG,EAAE;oBACL,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;iBAC5B;YACL,CAAC,CAAC,CAAC;QACP,CAAC,EAAE,IAAI,CAAC,CAAC;QAET,SAAS,CAAC,WAAW,CAAC;YAClB,WAAW,EAAE,gBAAgB;YAE7B,UAAU,EAAE,UAAU;YACtB,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,yCAAyC;YAEtD,uBAAuB,EAAE,IAAI;YAC7B,MAAM,EAAE,YAAY;YACpB,KAAK,EAAE;gBACH,GAAG,EAAE,GAAG,EAAE;oBACN,IAAI,CAAC,YAAY,EAAE;wBACf,OAAO,oCAAW,CAAC,sBAAsB,CAAC;qBAC7C;oBACD,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC3F,CAAC;aACJ;SACJ,CAAC,CAAC;QAEH,2BAA2B,CAAC,SAAS,EAAE;YACnC,WAAW,EAAE,gBAAgB;YAE7B,UAAU,EAAE,aAAa;YACzB,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,4CAA4C;YACzD,uBAAuB,EAAE,IAAI;YAC7B,MAAM,EAAE,eAAe;YACvB,KAAK,EAAE;gBACH,GAAG,EAAE,GAAG,EAAE;oBACN,IAAI,CAAC,YAAY,EAAE;wBACf,OAAO,oCAAW,CAAC,sBAAsB,CAAC;qBAC7C;oBACD,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBAClF,CAAC;aACJ;SACJ,CAAC,CAAC;KACN;SAAM;QACH,OAAO,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAC;KAC5E;IAED,SAAS,CAAC,WAAW,CAAC;QAClB,WAAW,EAAE,gBAAgB;QAE7B,UAAU,EAAE,sBAAsB;QAClC,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,iCAAiC;QAC9C,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,wBAAwB;QAChC,KAAK,EAAE;YACH,GAAG;gBACC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC;gBACxF,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;YAC3E,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,2BAA2B,CAAC,SAAS,EAAE;QACnC,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,kCAAkC;QAC/C,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,qBAAqB;QAC7B,KAAK,EAAE;YACH,GAAG;gBACC,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAC7B,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YACrE,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,2BAA2B,CAAC,SAAS,EAAE;QACnC,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,kBAAkB;QAC9B,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,uCAAuC;QACpD,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,oBAAoB;QAC5B,KAAK,EAAE;YACH,GAAG;gBACC,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;gBAC5B,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YACrE,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,SAAS,CAAC,WAAW,CAAC;QAClB,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,8BAA8B;QAC3C,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,gBAAgB;QACxB,KAAK,EAAE;YACH,GAAG;gBACC,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;YAC/E,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,SAAS,CAAC,WAAW,CAAC;QAClB,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,oBAAoB;QACjC,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,sBAAsB;QAC9B,KAAK,EAAE;YACH,GAAG;gBACC,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACxE,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,2BAA2B,CAAC,SAAS,EAAE;QACnC,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,uCAAuC;QACpD,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,gBAAgB;QACxB,KAAK,EAAE;YACH,GAAG;gBACC,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YAClF,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,2BAA2B,CAAC,SAAS,EAAE;QACnC,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,WAAW;QACvB,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,oCAAoC;QACjD,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE;YACH,GAAG;gBACC,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YAC/E,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,SAAS,CAAC,WAAW,CAAC;QAClB,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,mDAAmD;QAChE,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,qBAAqB;QAC7B,KAAK,EAAE;YACH,GAAG;gBACC,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC;YACvF,CAAC;SACJ;KACJ,CAAC,CAAC;IAEH,SAAS,CAAC,WAAW,CAAC;QAClB,WAAW,EAAE,gBAAgB;QAE7B,WAAW,EAAE,aAAa;QAC1B,UAAU,EAAE,kBAAkB;QAC9B,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,8BAA8B;QAC3C,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,mBAAmB;QAC3B,KAAK,EAAE;YACH,GAAG;gBACC,OAAO,IAAI,4BAAO,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;YAC5G,CAAC;SACJ;KACJ,CAAC,CAAC;AACP,CAAC;AA/ND,gGA+NC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "node-opcua-vendor-diagnostic",
+    "version": "2.51.0",
+    "description": "pure nodejs OPCUA SDK - module -vendor-diagnostic",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "build": "tsc -b",
+        "clean": "node -e \"require('rimraf').sync('dist');\"",
+        "test": "echo no test"
+    },
+    "dependencies": {
+        "humanize": "0.0.9",
+        "node-opcua-address-space": "2.51.0",
+        "node-opcua-assert": "2.51.0",
+        "node-opcua-constants": "2.51.0",
+        "node-opcua-server": "2.51.0",
+        "node-opcua-status-code": "2.51.0",
+        "node-opcua-variant": "2.51.0"
+    },
+    "author": "Etienne Rossignon",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/node-opcua/node-opcua.git"
+    },
+    "keywords": [
+        "OPCUA",
+        "opcua",
+        "m2m",
+        "iot",
+        "opc ua",
+        "internet of things"
+    ],
+    "homepage": "http://node-opcua.github.io/",
+    "gitHead": "75feb111daf7ec65fa0111e4fa5beb8987fd4945"
+}

package/source/index.ts

@@ -0,0 +1 @@
+export * from "./vendor_diagnostic_nodes";

package/source/vendor_diagnostic_nodes.ts

@@ -0,0 +1,278 @@
+/* istanbul ignore file */
+// tslint:disable:no-console
+import * as os from "os";
+
+import { Namespace } from "node-opcua-address-space";
+import { assert } from "node-opcua-assert";
+import { ObjectIds } from "node-opcua-constants";
+import { ServerEngine } from "node-opcua-server";
+import { StatusCodes } from "node-opcua-status-code";
+import { DataType, Variant } from "node-opcua-variant";
+// tslint:disable:no-var-requires
+const humanize = require("humanize");
+
+/**
+ * @method addVariableWithHumanizeText
+ * @param namespace
+ * @param options
+ * @param options.browseName
+ * @private
+ */
+function addVariableWithHumanizeText(namespace: Namespace, options: any) {
+    assert(options.componentOf || options.organizedBy);
+    assert(typeof options.description === "string");
+
+    const variable = namespace.addVariable(options);
+    // add the xxxAsText property
+    namespace.addVariable({
+        propertyOf: variable,
+
+        browseName: options.browseName.name.toString() + "AsText",
+        dataType: "String",
+        description: options.description + " as text",
+        minimumSamplingInterval: options.minimumSamplingInterval,
+        value: {
+            get() {
+                const v = options.value.get();
+                if (v instanceof Variant) {
+                    return v;
+                } else {
+                    return new Variant({ dataType: DataType.String, value: humanize.filesize(v.value) });
+                }
+            }
+        }
+    });
+}
+
+/**
+ *
+ * optionally install a CPU Usage and Memory Usage node
+ * ( condition : running on linux and require("usage")
+ * @method install_optional_cpu_and_memory_usage_node
+ * @param server {OPCUAServer}
+ *
+ */
+export function install_optional_cpu_and_memory_usage_node(server: any) {
+    const engine = server.engine;
+    assert(engine instanceof ServerEngine);
+
+    let usage: any;
+    try {
+        const usage_module = "usage"; // we use a variable here to prevent error in webpack
+        usage = require(usage_module); // a warning will be generated here with webpack as the module name is not a litteral
+    } catch (err) {
+        if (err instanceof Error) {
+            console.log("err", err.message);
+        }
+        usage = null;
+        // xx return;
+    }
+
+    const addressSpace = engine.addressSpace;
+
+    const namespace = addressSpace.getOwnNamespace();
+
+    const vendorServerInfo = addressSpace.findNode(ObjectIds.Server_VendorServerInfo);
+
+    let usage_result = { memory: 0, cpu: 100 };
+
+    const pid = process.pid;
+
+    if (usage) {
+        const options = { keepHistory: true };
+        setInterval(() => {
+            usage.lookup(pid, options, (err: Error | null, result: any) => {
+                usage_result = result;
+                console.log("result Used Memory: ", humanize.filesize(result.memory), " CPU ", Math.round(result.cpu), " %");
+                if (err) {
+                    console.log("err ", err);
+                }
+            });
+        }, 1000);
+
+        namespace.addVariable({
+            componentOf: vendorServerInfo,
+
+            browseName: "CPUUsage",
+            dataType: "Double",
+            description: "Current CPU usage of the server process",
+
+            minimumSamplingInterval: 1000,
+            nodeId: "s=CPUUsage",
+            value: {
+                get: () => {
+                    if (!usage_result) {
+                        return StatusCodes.BadResourceUnavailable;
+                    }
+                    return new Variant({ dataType: DataType.Double, value: Math.round(usage_result.cpu) });
+                }
+            }
+        });
+
+        addVariableWithHumanizeText(namespace, {
+            componentOf: vendorServerInfo,
+
+            browseName: "MemoryUsage",
+            dataType: "Number",
+            description: "Current memory usage of the server process",
+            minimumSamplingInterval: 1000,
+            nodeId: "s=MemoryUsage",
+            value: {
+                get: () => {
+                    if (!usage_result) {
+                        return StatusCodes.BadResourceUnavailable;
+                    }
+                    return new Variant({ dataType: DataType.UInt32, value: usage_result.memory });
+                }
+            }
+        });
+    } else {
+        console.log("skipping installation of cpu_usage and memory_usage nodes");
+    }
+
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+
+        browseName: "PercentageMemoryUsed",
+        dataType: "Number",
+        description: "% of  memory used by the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=PercentageMemoryUsed",
+        value: {
+            get() {
+                const percent_used = Math.round(((os.totalmem() - os.freemem()) / os.totalmem()) * 100);
+                return new Variant({ dataType: DataType.Double, value: percent_used });
+            }
+        }
+    });
+
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "SystemMemoryTotal",
+        dataType: "Number",
+        description: "Total Memory usage of the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=SystemMemoryTotal",
+        value: {
+            get() {
+                const memory = os.totalmem();
+                return new Variant({ dataType: DataType.UInt64, value: memory });
+            }
+        }
+    });
+
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "SystemMemoryFree",
+        dataType: "Number",
+        description: "Free Memory usage of the server in MB",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=SystemMemoryFree",
+        value: {
+            get() {
+                const memory = os.freemem();
+                return new Variant({ dataType: DataType.UInt64, value: memory });
+            }
+        }
+    });
+
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "NumberOfCPUs",
+        dataType: "Number",
+        description: "Number of cpus on the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=NumberOfCPUs",
+        value: {
+            get() {
+                return new Variant({ dataType: DataType.UInt32, value: os.cpus().length });
+            }
+        }
+    });
+
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "Arch",
+        dataType: "String",
+        description: "ServerArchitecture",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=ServerArchitecture",
+        value: {
+            get() {
+                return new Variant({ dataType: DataType.String, value: os.type() });
+            }
+        }
+    });
+
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "BytesWritten",
+        dataType: "Number",
+        description: "number of bytes written by the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=BytesWritten",
+        value: {
+            get() {
+                return new Variant({ dataType: DataType.UInt64, value: server.bytesWritten });
+            }
+        }
+    });
+
+    addVariableWithHumanizeText(namespace, {
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "BytesRead",
+        dataType: "Number",
+        description: "number of bytes read by the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=BytesRead",
+        value: {
+            get() {
+                return new Variant({ dataType: DataType.UInt64, value: server.bytesRead });
+            }
+        }
+    });
+
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "TransactionsCount",
+        dataType: "Number",
+        description: "total number of transactions performed the server",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=TransactionsCount",
+        value: {
+            get() {
+                return new Variant({ dataType: DataType.UInt32, value: server.transactionsCount });
+            }
+        }
+    });
+
+    namespace.addVariable({
+        componentOf: vendorServerInfo,
+
+        accessLevel: "CurrentRead",
+        browseName: "ConnectionsCount",
+        dataType: "String",
+        description: "number of active Connections",
+        minimumSamplingInterval: 1000,
+        nodeId: "s=ConnectionCount",
+        value: {
+            get() {
+                return new Variant({ dataType: DataType.String, value: humanize.filesize(server.currentChannelCount) });
+            }
+        }
+    });
+}