2.0.22

.gitignore

@@ -1,5 +1,22 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -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
@@ -36,38 +37,29 @@ snyk:
 # ====================
 # 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 node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+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
   - notpriv
 
 release:
@@ -86,19 +78,12 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -114,11 +99,13 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv
@@ -129,13 +116,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

license

@@ -0,0 +1,19 @@
+Copyright (c) 2018 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.

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,22 +1,46 @@
 {
   "name": "@pushrocks/smartlog",
-  "version": "2.0.1",
+  "version": "2.0.22",
   "private": false,
-  "description": "winston based logger for large scale projects",
+  "description": "minimalistic distributed and extensible logging tool",
+  "keywords": [
+    "logging",
+    "centralized logging",
+    "json logging",
+    "scalyr",
+    "elasticsearch",
+    "logdna"
+  ],
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
-  "license": "UNLICENSED",
+  "license": "MIT",
   "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.24",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.11",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartlog-interfaces": "^1.0.9"
-  }
+    "@pushrocks/smartlog-interfaces": "^2.0.12"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -1,34 +1,77 @@
-# smartlog
+# @pushrocks/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)
-[![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/)
+[![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->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
 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: '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)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

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;
@@ -9,7 +9,12 @@ tap.test('should produce instance of Smartlog', async () => {
 });
 
 tap.test('should enable console logging', async () => {
-  defaultLogger.enableConsole();
+  defaultLogger.enableConsole({
+    captureAll: true
+  });
+  console.log('this is a normal log that should be captured');
+  console.log(new Error('hi there'));
+  defaultLogger.log('info', 'this should only be printed once');
 });
 
 tap.test('should be able to log things', async () => {

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,29 @@
 import * as plugins from './smartlog.plugins';
 
-// interfaces
-import { TEnvironment, ILogContext, TLogLevel, TRuntime } from '@pushrocks/smartlog-interfaces';
+import { LogRouter } from './smartlog.classes.logrouter';
+
+export interface ISmartlogContructorOptions {
+  logContext: plugins.smartlogInterfaces.ILogContext;
+  minimumLogLevel?: plugins.smartlogInterfaces.TLogLevel;
+}
+
+export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
+  private logContext: plugins.smartlogInterfaces.ILogContext;
+  private minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
 
-export class Smartlog {
-  private logContext: ILogContext;
   private consoleEnabled: boolean;
-  private minimumLevel: TLogLevel;
-  private runtime: TRuntime;
+
+  private logRouter = new LogRouter();
+
+  public addLogDestination(logDestinationArg: plugins.smartlogInterfaces.ILogDestination) {
+    this.logRouter.addLogDestination(logDestinationArg);
+  }
+
+  constructor(optionsArg: ISmartlogContructorOptions) {
+    this.logContext = optionsArg.logContext;
+    this.minimumLogLevel = optionsArg.minimumLogLevel;
+  }
+
   // ============
   // Logger Setup
   // ============
@@ -15,47 +31,86 @@ export class Smartlog {
   /**
    * enables console logging
    */
-  enableConsole() {
+  public enableConsole(optionsArg?: {
+    captureAll: boolean;
+  }) {
+    if (optionsArg && optionsArg.captureAll) {
+      const write = process.stdout.write;
+      /* import * as fs from 'fs';
+      const fileStream = fs.createWriteStream(plugins.path.join(paths.nogitDir, 'output.txt'), {
+        flags: 'a+'
+      }); */
+      process.stdout.write = (...args) => {
+        if (!args[0].startsWith('LOG')) {
+          this.log('info', args[0]);
+          return;
+        }
+        // fileStream.write(args[0]);
+        write.apply(process.stdout, args);
+        return true;
+      };
+    }
     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: plugins.smartlogInterfaces.TLogLevel,
+    logMessageArg: string,
+    logDataArg?: any,
+    logCorrelationIdArg: string = '123'
+  ) {
     if (this.consoleEnabled) {
-      console.log(`${logLevelArg}: ${logMessageArg}`)
+      this.safeConsoleLog(
+        `${logLevelArg}: ${logMessageArg}`
+      );
     }
+    const logPackage: plugins.smartlogInterfaces.ILogPackage = {
+      timestamp: Date.now(),
+      type: 'log',
+      context: this.logContext,
+      level: logLevelArg,
+      correlationId: logCorrelationIdArg,
+      message: logMessageArg
+    };
+    if (logDataArg) {
+      logPackage.data = logDataArg;
+    }
+    this.logRouter.routeLog(logPackage);
   }
 
-  silly(logMessageArg: string) {
-    this.log('silly', logMessageArg);
+  public increment(
+    logLevelArg: plugins.smartlogInterfaces.TLogLevel,
+    logMessageArg: string,
+    logDataArg?: any,
+    logCorrelationIdArg: string = '123'
+  ) {
+    if (this.consoleEnabled) {
+      this.safeConsoleLog(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
+    }
+    this.logRouter.routeLog({
+      timestamp: Date.now(),
+      type: 'increment',
+      context: this.logContext,
+      level: logLevelArg,
+      message: logMessageArg,
+      correlationId: logCorrelationIdArg
+    });
   }
 
-  debug(logMessageArg) {
-    this.log('debug', logMessageArg);
+  public handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
+    this.logRouter.routeLog(logPackageArg);
   }
 
-  info(logMessageArg: string) {
-    this.log('info', logMessageArg);
-  }
-
-  warn(logMessageArg) {
-    this.log('warn', logMessageArg);
-  }
-
-  error(logMessageArg) {
-    this.log('error', logMessageArg);
+  private safeConsoleLog(logLine: string) {
+    console.log(`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLine}`);
   }
 }

ts/smartlog.plugins.ts

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

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"
 }