2.0.5

.gitlab-ci.yml

@@ -12,20 +12,12 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
@@ -36,6 +28,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
@@ -96,10 +89,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -119,11 +111,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartmetrics",
-      "shortDescription": "easy system metrics",
+      "description": "easy system metrics",
       "npmPackagename": "@pushrocks/smartmetrics",
       "license": "MIT",
       "projectDomain": "push.rocks"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartmetrics",
-  "version": "1.0.10",
+  "version": "2.0.5",
   "private": false,
   "description": "easy system metrics",
   "main": "dist_ts/index.js",
@@ -9,16 +9,16 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsbundle": "^1.0.78",
-    "@gitzone/tstest": "^1.0.44",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^16.6.1",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsbundle": "^2.0.8",
+    "@gitzone/tsrun": "^1.2.42",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/tapbundle": "^5.0.8",
+    "@types/node": "^20.3.3"
   },
   "browserslist": [
     "last 1 chrome versions"
@@ -36,11 +36,12 @@
     "readme.md"
   ],
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.13",
-    "@pushrocks/smartlog": "^2.0.44",
-    "@types/pidusage": "^2.0.1",
-    "pidtree": "^0.5.0",
-    "pidusage": "^2.0.21",
-    "prom-client": "^13.2.0"
-  }
+    "@pushrocks/smartdelay": "^3.0.1",
+    "@pushrocks/smartlog": "^3.0.2",
+    "@types/pidusage": "^2.0.2",
+    "pidtree": "^0.6.0",
+    "pidusage": "^3.0.2",
+    "prom-client": "^14.2.0"
+  },
+  "type": "module"
 }

test/plugins.ts

@@ -1,5 +1,3 @@
 import * as smartlog from '@pushrocks/smartlog';
 
-export {
-  smartlog
-}
+export { smartlog };

test/test.ts

@@ -1,18 +1,18 @@
-import * as plugins from './plugins';
+import * as plugins from './plugins.js';
 
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartmetrics from '../ts/index';
+import * as smartmetrics from '../ts/index.js';
 
 let testSmartMetrics: smartmetrics.SmartMetrics;
 
 tap.test('should create a smartmetrics instance', async () => {
   const logger = new plugins.smartlog.Smartlog({
     logContext: null,
-    minimumLogLevel: 'silly'
+    minimumLogLevel: 'silly',
   });
   logger.enableConsole();
   testSmartMetrics = new smartmetrics.SmartMetrics(logger, 'testContainer');
-  expect(testSmartMetrics).to.be.instanceOf(smartmetrics.SmartMetrics);
+  expect(testSmartMetrics).toBeInstanceOf(smartmetrics.SmartMetrics);
 });
 
 tap.test('should start smartmetrics', async () => {
@@ -20,8 +20,8 @@ tap.test('should start smartmetrics', async () => {
 });
 
 tap.test('should produce valid metrics', async (tools) => {
-  console.log('calling .getMetrics from Testfile:')
+  console.log('calling .getMetrics from Testfile:');
   console.log(await testSmartMetrics.getMetrics());
-})
+});
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartmetrics',
+  version: '2.0.5',
+  description: 'easy system metrics'
+}

ts/index.ts

@@ -1,2 +1,2 @@
-export * from './smartmetrics.interfaces';
-export * from './smartmetrics.classes.smartmetrics';
+export * from './smartmetrics.interfaces.js';
+export * from './smartmetrics.classes.smartmetrics.js';

ts/smartmetrics.classes.smartmetrics.ts

@@ -1,12 +1,12 @@
-import * as plugins from './smartmetrics.plugins';
-import * as interfaces from './smartmetrics.interfaces';
-import { Cipher } from 'crypto';
+import * as plugins from './smartmetrics.plugins.js';
+import * as interfaces from './smartmetrics.interfaces.js';
 
 export class SmartMetrics {
   public started = false;
   public sourceNameArg: string;
   public logger: plugins.smartlog.Smartlog;
   public registry: plugins.promClient.Registry;
+  public maxMemoryMB: number;
 
   public async setup() {
     const collectDefaultMetrics = plugins.promClient.collectDefaultMetrics;
@@ -18,6 +18,29 @@ export class SmartMetrics {
     this.logger = loggerArg;
     this.sourceNameArg = sourceNameArg;
     this.setup();
+    this.checkMemoryLimits();
+  }
+
+  private checkMemoryLimits() {
+    let heapStats = plugins.v8.getHeapStatistics();
+    let maxHeapSizeMB = heapStats.heap_size_limit / 1024 / 1024;
+    let totalSystemMemoryMB = plugins.os.totalmem() / 1024 / 1024;
+
+    let dockerMemoryLimitMB = totalSystemMemoryMB; 
+    try {
+      let dockerMemoryLimitBytes = plugins.fs.readFileSync('/sys/fs/cgroup/memory/memory.limit_in_bytes', 'utf8');
+      dockerMemoryLimitMB = parseInt(dockerMemoryLimitBytes, 10) / 1024 / 1024;
+    } catch (error) {
+      // Ignore - this will fail if not running in a Docker container
+    }
+
+    // Set the maximum memory to the lower value between the Docker limit and the total system memory
+    this.maxMemoryMB = Math.min(totalSystemMemoryMB, dockerMemoryLimitMB, maxHeapSizeMB);
+
+    // If the maximum old space size limit is greater than the maximum available memory, throw an error
+    if (maxHeapSizeMB > this.maxMemoryMB) {
+      throw new Error('Node.js process can use more memory than is available');
+    }
   }
 
   public start() {
@@ -31,7 +54,7 @@ export class SmartMetrics {
           eventType: 'heartbeat',
           metrics: await this.getMetrics(),
         });
-        await plugins.smartdelay.delayFor(10000, null, true);
+        await plugins.smartdelay.delayFor(20000, null, true);
       }
     };
     unattendedStart();
@@ -54,27 +77,25 @@ export class SmartMetrics {
     const pids = await plugins.pidtree(process.pid);
     const stats = await plugins.pidusage([process.pid, ...pids]);
 
-    // lets compute cpu usage
     let cpuPercentage = 0;
     for (const stat of Object.keys(stats)) {
       if (!stats[stat]) continue;
-      cpuPercentage += stats[stat].cpu / 100;
+      cpuPercentage += stats[stat].cpu;
     }
-    let cpuUsageText = `${Math.round(cpuPercentage * 10000) / 100} %`;
+    let cpuUsageText = `${Math.round(cpuPercentage * 100) / 100} %`;
 
-    // lets compute memory usage
     let memoryUsageBytes = 0;
     for (const stat of Object.keys(stats)) {
       if (!stats[stat]) continue;
       memoryUsageBytes += stats[stat].memory;
     }
-    let memoryUsageText = `${this.formatBytes(memoryUsageBytes)} / ${this.formatBytes(plugins.os.totalmem())}`;
-    let memoryPercentage = Math.round((memoryUsageBytes / plugins.os.totalmem()) * 100) / 100;
 
-    // console.log(`${cpuUsageText} ||| ${memoryUsageText} `);
+    let memoryPercentage = Math.round((memoryUsageBytes / (this.maxMemoryMB * 1024 * 1024)) * 100 * 100) / 100;
+    let memoryUsageText = `${memoryPercentage}% | ${this.formatBytes(memoryUsageBytes)} / ${this.formatBytes(this.maxMemoryMB * 1024 * 1024)}`;
+
+    console.log(`${cpuUsageText} ||| ${memoryUsageText} `);
 
     const returnMetrics: interfaces.IMetricsSnapshot = {
-      originalMetrics,
       process_cpu_seconds_total: (
         originalMetrics.find((metricSet) => metricSet.name === 'process_cpu_seconds_total') as any
       ).values[0].value,

ts/smartmetrics.interfaces.ts

@@ -1,6 +1,5 @@
 // this might be extracted into a package @pushrocks/smartmetrics-interfaces in the future
 export interface IMetricsSnapshot {
-  originalMetrics: any[];
   process_cpu_seconds_total: number;
   nodejs_active_handles_total: number;
   nodejs_active_requests_total: number;
@@ -10,4 +9,4 @@ export interface IMetricsSnapshot {
   memoryPercentage: number;
   memoryUsageBytes: number;
   memoryUsageText: string;
-}
+}

ts/smartmetrics.plugins.ts

@@ -1,26 +1,19 @@
 // node native
+import * as v8 from 'v8';
 import * as os from 'os';
+import * as fs from 'fs';
 
-export {
-  os
-}
+export { v8, os, fs };
 
 // pushrocks scope
 import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartlog from '@pushrocks/smartlog';
 
-export {
-  smartdelay,
-  smartlog
-}
+export { smartdelay, smartlog };
 
 // third party scope
 import pidusage from 'pidusage';
 import pidtree from 'pidtree';
 import * as promClient from 'prom-client';
 
-export {
-  pidusage,
-  pidtree,
-  promClient
-}
+export { pidusage, pidtree, promClient };

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}