2.0.15

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -33,24 +34,39 @@ snyk:
   - docker
   - notpriv
 
+sast:
+  stage: security
+  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command npm run build
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
+        --volume "$PWD:/code"
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
+  artifacts:
+    reports:
+      sast: gl-sast-report.json
+  tags:
+  - docker
+  - priv
+
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +78,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -117,8 +134,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
     - notpriv
@@ -129,13 +148,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

npmextra.json

@@ -1,8 +1,17 @@
 {
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartlog",
+      "shortDescription": "minimalistic distributed and extensible logging tool",
+      "npmPackagename": "@pushrocks/smartlog",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts"
-    ],
+    "npmGlobalTools": [],
     "npmAccessLevel": "public"
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartlog",
-  "version": "2.0.1",
+  "version": "2.0.15",
   "private": false,
   "description": "winston based logger for large scale projects",
   "main": "dist/index.js",
@@ -8,15 +8,20 @@
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
-    "test": "(tsrun test/test.ts)",
-    "build": "(npmts)",
+    "test": "(tstest test/)",
+    "build": "(tsbuild)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.1.1",
-    "tapbundle": "^2.0.2"
+    "@gitzone/tsbuild": "^2.1.4",
+    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^10.12.18",
+    "tslint": "^5.12.1",
+    "tslint-config-prettier": "^1.17.0"
   },
   "dependencies": {
-    "@pushrocks/smartlog-interfaces": "^1.0.9"
+    "@pushrocks/smartlog-interfaces": "^2.0.5"
   }
 }

readme.md

@@ -1,23 +1,17 @@
 # smartlog
+minimalistic distributed and extensible logging tool
 
-winston based logger for large scale projects
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartlog)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartlog)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartlog)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartlog/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartlog)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartlog)
+* [github.com (source mirror)](https://github.com/pushrocks/smartlog)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartlog/)
 
 ## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartlog/badges/master/build.svg)](https://GitLab.com/pushrocks/smartlog/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartlog/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartlog.svg)](https://www.npmjs.com/package/smartlog)
-[![Dependency Status](https://david-dm.org/pushrocks/smartlog.svg)](https://david-dm.org/pushrocks/smartlog)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartlog/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartlog/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartlog/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartlog)
-[![Known Vulnerabilities](https://snyk.io/test/npm/smartlog/badge.svg)](https://snyk.io/test/npm/smartlog)
+[![build status](https://gitlab.com/pushrocks/smartlog/badges/master/build.svg)](https://gitlab.com/pushrocks/smartlog/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartlog/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartlog.svg)](https://www.npmjs.com/package/@pushrocks/smartlog)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartlog/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartlog)
 [![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
 [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
@@ -26,9 +20,58 @@ winston based logger for large scale projects
 
 Use TypeScript for best in class instellisense.
 
-For further information read the linked docs at the top of this README.
+smartlog id s minimal logging package that provides a consistent experience across the complete logging stack. Smartlog allows you to create a logger instance like this:
+
+```ts
+import { Smartlog } from '@pushrocks/smartlog';
+const logger = new Smartlog({
+  {
+    company?: 'My awesome company',
+    companyunit?: 'my awesome cloud team',
+    containerName?: 'awesome-container',
+    environment: TEnvironment: 'kubernetes-production',
+    runtime: 'node',
+    zone: 'zone x'
+  }
+})
+
+logger.log('silly', `a silly statement`); // log levels are shown to you by the IDE
+```
+
+There is also a default logger available that you can use:
+
+```ts
+import { Smartlog, defaultLogger } from '@pushrocks/smartlog';
+
+export class MyAwesomeClass {
+  constructor(public logger: Smartlog = defaultLogger) {
+    // what happens here that a instance of this class will have instance.logger available
+    // if you set a custom logger, than that will be used, if not the default logger.
+  }
+}
+```
+
+### Destinations
+
+smartlog supports different kinds of destinations.
+
+The following destinations are available:
+
+- [@pushrocks/smartlog-destination-local](https://www.npmjs.com/package/@pushrocks/smartlog-destination-local) - outputs logs to the local console in a colorful, nice to read way.
+- [@pushrocks/smartlog-destination-devtools](https://www.npmjs.com/package/@pushrocks/smartlog-destination-devtools) - outputs logs into the browser console in a colorful, nice to read way.
+- [@pushrocks/smartlog-destination-receiver](https://www.npmjs.com/package/@pushrocks/smartlog-destination-receiver) - sends logs to a smartlog receiver (more about that below)
+- [@mojoio/scalyr](https://www.npmjs.com/package/@pushrocks/smartlog-destination-receiver) - an scalyr API package that comes with a smartlog log destination included
+- [@mojoio/elasticsearch](https://www.npmjs.com/package/@mojoio/elasticsearch) - an elasticsearch API package that comes with a smartlog destination included
+
+### Adding a log destination
+
+```
+// TBD
+```
+
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
 [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

test/test.ts

@@ -1,4 +1,4 @@
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartlog from '../ts/index';
 
 let defaultLogger: smartlog.Smartlog;

ts/index.ts

@@ -1,6 +1,16 @@
 import * as plugins from './smartlog.plugins';
 import { Smartlog } from './smartlog.classes.smartlog';
-const defaultLogger: Smartlog = new Smartlog();
+const defaultLogger: Smartlog = new Smartlog({
+  logContext: {
+    company: 'undefined',
+    companyunit: 'undefefined',
+    containerName: 'undefined',
+    environment: 'local',
+    runtime: 'node',
+    zone: 'undefined'
+  }
+});
+
+defaultLogger.enableConsole();
 
 export { Smartlog, defaultLogger };
-

ts/smartlog.classes.logrouter.ts

@@ -1,10 +1,23 @@
 import * as plugins from './smartlog.plugins';
 
-import { ILogDestination } from '@pushrocks/smartlog-interfaces';
+import { ILogDestination, ILogPackage } from '@pushrocks/smartlog-interfaces';
 
 export class LogRouter {
-  logDestinations: ILogDestination[] = [];
+  /**
+   * all log destinations
+   */
+  private logDestinations: ILogDestination[] = [];
+
   constructor() {}
 
-  addLogDestination;
+  public addLogDestination(logDestination: ILogDestination) {
+    this.logDestinations.push(logDestination);
+  }
+
+  // routes the log according to added logDestinations
+  routeLog(logPackageArg: ILogPackage) {
+    for (const logDestination of this.logDestinations) {
+      logDestination.handleLog(logPackageArg);
+    }
+  }
 }

ts/smartlog.classes.smartlog.ts

@@ -1,13 +1,40 @@
 import * as plugins from './smartlog.plugins';
 
 // interfaces
-import { TEnvironment, ILogContext, TLogLevel, TRuntime } from '@pushrocks/smartlog-interfaces';
+import {
+  TLogType,
+  TEnvironment,
+  ILogContext,
+  TLogLevel,
+  TRuntime,
+  ILogDestination,
+  ILogPackage
+} from '@pushrocks/smartlog-interfaces';
+
+import { LogRouter } from './smartlog.classes.logrouter';
+
+export interface ISmartlogContructorOptions {
+  logContext: ILogContext;
+  minimumLogLevel?: TLogLevel;
+}
 
 export class Smartlog {
   private logContext: ILogContext;
+  private minimumLogLevel: TLogLevel;
+
   private consoleEnabled: boolean;
-  private minimumLevel: TLogLevel;
-  private runtime: TRuntime;
+
+  private logRouter = new LogRouter();
+
+  public addLogDestination(logDestinationArg: ILogDestination) {
+    this.logRouter.addLogDestination(logDestinationArg);
+  }
+
+  constructor(optionsArg: ISmartlogContructorOptions) {
+    this.logContext = optionsArg.logContext;
+    this.minimumLogLevel = optionsArg.minimumLogLevel;
+  }
+
   // ============
   // Logger Setup
   // ============
@@ -19,43 +46,48 @@ export class Smartlog {
     this.consoleEnabled = true;
   }
 
-  /**
-   * set a minimum serverity level to log
-   * @param levelArg
-   */
-  level(levelArg: TLogLevel) {}
-
   // =============
   // log functions
   // =============
   /**
-   * log stuff
-   * @param logLevelArg
-   * @param logMessageArg
+   * main log method
+   * @param logLevelArg - the log level
+   * @param logMessageArg - the log message
+   * @param logDataArg - any additional log data
    */
-  log(logLevelArg: TLogLevel, logMessageArg: string) {
+  public log(logLevelArg: TLogLevel, logMessageArg: string, logDataArg?: any) {
     if (this.consoleEnabled) {
-      console.log(`${logLevelArg}: ${logMessageArg}`)
+      console.log(
+        `LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`
+      );
     }
+    const logPackage: ILogPackage = {
+      timestamp: Date.now(),
+      type: 'log',
+      context: this.logContext,
+      level: logLevelArg,
+      message: logMessageArg
+    };
+    if (logDataArg) {
+      logPackage.data = logDataArg;
+    }
+    this.logRouter.routeLog(logPackage);
   }
 
-  silly(logMessageArg: string) {
-    this.log('silly', logMessageArg);
+  public increment(logLevelArg: TLogLevel, logMessageArg) {
+    if (this.consoleEnabled) {
+      console.log(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
+    }
+    this.logRouter.routeLog({
+      timestamp: Date.now(),
+      type: 'increment',
+      context: this.logContext,
+      level: logLevelArg,
+      message: logMessageArg
+    });
   }
 
-  debug(logMessageArg) {
-    this.log('debug', logMessageArg);
-  }
-
-  info(logMessageArg: string) {
-    this.log('info', logMessageArg);
-  }
-
-  warn(logMessageArg) {
-    this.log('warn', logMessageArg);
-  }
-
-  error(logMessageArg) {
-    this.log('error', logMessageArg);
+  public handleLogPackage(logPackageArg: ILogPackage) {
+    this.logRouter.routeLog(logPackageArg);
   }
 }

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }