fix(core): update

2021-08-12 23:19:39 +02:00
commit 932c2e5795
16 changed files with 26321 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1,20 @@
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -0,0 +1,137 @@
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
+
+stages:
+  - security
+  - test
+  - release
+  - metadata
+
+# ====================
+# 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
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
+
+# ====================
+# test stage
+# ====================
+
+testStable:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+
+release:
+  stage: release
+  script:
+    - npmci node install stable
+    - npmci npm publish
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  only:
+    - tags
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - public
+  allow_failure: true
--- a/.vscode/launch.json
+++ b/.vscode/launch.json
@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "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"
+    }
+  ]
+}
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}
--- a/19
+++ b/19
@@ -0,0 +1,19 @@
+Copyright (c) 2021 Lossless GmbH (hello@lossless.com)
+
+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.
--- a/npmextra.json
+++ b/npmextra.json
@@ -0,0 +1,18 @@
+{
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartmetrics",
+      "shortDescription": "easy system metrics",
+      "npmPackagename": "@pushrocks/smartmetrics",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -0,0 +1,43 @@
+{
+  "name": "@pushrocks/smartmetrics",
+  "version": "1.0.1",
+  "private": false,
+  "description": "easy system metrics",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "author": "Lossless GmbH",
+  "license": "MIT",
+  "scripts": {
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)"
+  },
+  "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.0",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.15.0"
+  },
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "dependencies": {
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartlog": "^2.0.44",
+    "prom-client": "^13.2.0"
+  }
+}
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,39 @@
+# @pushrocks/smartmetrics
+easy system metrics
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartmetrics)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartmetrics)
+* [github.com (source mirror)](https://github.com/pushrocks/smartmetrics)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartmetrics/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartmetrics/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartmetrics/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartmetrics)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartmetrics)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartmetrics)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartmetrics)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartmetrics)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class intellisense
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
--- a/test/plugins.ts
+++ b/test/plugins.ts
@@ -0,0 +1,5 @@
+import * as smartlog from '@pushrocks/smartlog';
+
+export {
+  smartlog
+}
--- a/test/test.ts
+++ b/test/test.ts
@@ -0,0 +1,26 @@
+import * as plugins from './plugins';
+
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartmetrics from '../ts/index';
+
+let testSmartMetrics: smartmetrics.SmartMetrics;
+
+tap.test('should create a smartmetrics instance', async () => {
+  const logger = new plugins.smartlog.Smartlog({
+    logContext: null,
+    minimumLogLevel: 'silly'
+  });
+  logger.enableConsole();
+  testSmartMetrics = new smartmetrics.SmartMetrics(logger, 'testContainer');
+  expect(testSmartMetrics).to.be.instanceOf(smartmetrics.SmartMetrics);
+});
+
+tap.test('should start smartmetrics', async () => {
+  testSmartMetrics.start();
+});
+
+tap.test('should produce valid metrics', async () => {
+  console.log(await testSmartMetrics.getMetrics());
+})
+
+tap.start();
--- a/ts/index.ts
+++ b/ts/index.ts
@@ -0,0 +1,2 @@
+export * from './smartmetrics.interfaces';
+export * from './smartmetrics.classes.smartmetrics';
--- a/ts/smartmetrics.classes.smartmetrics.ts
+++ b/ts/smartmetrics.classes.smartmetrics.ts
@@ -0,0 +1,116 @@
+import * as plugins from './smartmetrics.plugins';
+import * as interfaces from './smartmetrics.interfaces';
+import { Cipher } from 'crypto';
+
+export class SmartMetrics {
+  public started = false;
+  public sourceNameArg: string;
+  public logger: plugins.smartlog.Smartlog;
+  public registry: plugins.promClient.Registry;
+
+  public async setup() {
+    const collectDefaultMetrics = plugins.promClient.collectDefaultMetrics;
+    this.registry = new plugins.promClient.Registry();
+    collectDefaultMetrics({ register: this.registry });
+  }
+
+  constructor(loggerArg: plugins.smartlog.Smartlog, sourceNameArg: string) {
+    this.logger = loggerArg;
+    this.sourceNameArg = sourceNameArg;
+    this.setup();
+  }
+
+  public async start() {
+    if (this.started) {
+      return;
+    }
+    this.started = true;
+    while (this.started) {
+      this.logger.log('info', `sending heartbeat for ${this.sourceNameArg}`, {
+        metrics: await this.getMetrics(),
+      });
+      await plugins.smartdelay.delayFor(60000, null, true);
+    }
+  }
+
+  public getCpuUsagePercentage() {
+    // Take the first CPU, considering every CPUs have the same specs
+    // and every NodeJS process only uses one at a time.
+    const cpus = plugins.os.cpus();
+    let total: number = 0;
+
+    for (const cpu of cpus) {
+      total +=
+        cpu.times.user +
+        cpu.times.sys +
+        cpu.times.nice +
+        cpu.times.nice +
+        cpu.times.irq +
+        cpu.times.idle;
+    }
+
+    // Normalize the one returned by process.cpuUsage()
+    // (microseconds VS miliseconds)
+    const usage = process.cpuUsage();
+    const currentCPUUsage = (usage.user + usage.system) * 1000;
+
+    // Find out the percentage used for this specific CPU
+    const perc = (currentCPUUsage / total) * 100;
+
+    return perc;
+  }
+
+  public formatBytes(bytes: number, decimals = 2) {
+    if (bytes === 0) return '0 Bytes';
+
+    const k = 1024;
+    const dm = decimals < 0 ? 0 : decimals;
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+
+    return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];
+  }
+
+  public async getMetrics() {
+    const originalMetrics = await this.registry.getMetricsAsJSON();
+    const returnMetrics: interfaces.IMetricsSnapshot = {
+      originalMetrics,
+      process_cpu_seconds_total: (
+        originalMetrics.find((metricSet) => metricSet.name === 'process_cpu_seconds_total') as any
+      ).values[0].value,
+      nodejs_active_handles_total: (
+        originalMetrics.find((metricSet) => metricSet.name === 'nodejs_active_handles_total') as any
+      ).values[0].value,
+      nodejs_active_requests_total: (
+        originalMetrics.find(
+          (metricSet) => metricSet.name === 'nodejs_active_requests_total'
+        ) as any
+      ).values[0].value,
+      nodejs_heap_size_total_bytes: (
+        originalMetrics.find(
+          (metricSet) => metricSet.name === 'nodejs_heap_size_total_bytes'
+        ) as any
+      ).values[0].value,
+      cpuPercentage: Math.round(this.getCpuUsagePercentage() * 100) / 100,
+      memoryUsageText: this.formatBytes(
+        (
+          originalMetrics.find(
+            (metricSet) => metricSet.name === 'nodejs_heap_size_total_bytes'
+          ) as any
+        ).values[0].value
+      ),
+      memoryPercentage:
+        Math.round(((
+          originalMetrics.find(
+            (metricSet) => metricSet.name === 'nodejs_heap_size_total_bytes'
+          ) as any
+        ).values[0].value /
+          plugins.os.totalmem()) *
+        100 * 100) / 100,
+    };
+    return returnMetrics;
+  }
+
+  public async stop() {}
+}
--- a/ts/smartmetrics.interfaces.ts
+++ b/ts/smartmetrics.interfaces.ts
@@ -0,0 +1,11 @@
+// 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;
+  nodejs_heap_size_total_bytes: number;
+  cpuPercentage: number;
+  memoryPercentage: number;
+  memoryUsageText: string;
+}
--- a/ts/smartmetrics.plugins.ts
+++ b/ts/smartmetrics.plugins.ts
@@ -0,0 +1,22 @@
+// node native
+import * as os from 'os';
+
+export {
+  os
+}
+
+// pushrocks scope
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartlog from '@pushrocks/smartlog';
+
+export {
+  smartdelay,
+  smartlog
+}
+
+// third party scope
+import * as promClient from 'prom-client';
+
+export {
+  promClient
+}
--- a/tslint.json
+++ b/tslint.json
@@ -0,0 +1,17 @@
+{
+  "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"
+}