2.0.14

.gitlab-ci.yml

@@ -34,21 +34,34 @@ 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 npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
@@ -135,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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartlog",
-  "version": "2.0.7",
+  "version": "2.0.14",
   "private": false,
   "description": "winston based logger for large scale projects",
   "main": "dist/index.js",
@@ -13,15 +13,15 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.13",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tsbuild": "^2.1.4",
+    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tstest": "^1.0.18",
     "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.2",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@types/node": "^10.12.18",
+    "tslint": "^5.12.1",
+    "tslint-config-prettier": "^1.17.0"
   },
   "dependencies": {
-    "@pushrocks/smartlog-interfaces": "^2.0.1"
+    "@pushrocks/smartlog-interfaces": "^2.0.5"
   }
 }

readme.md

@@ -1,4 +1,4 @@
-# smartlog
+# @pushrocks/smartlog
 
 winston based logger for large scale projects
 
@@ -26,6 +26,53 @@ winston based logger for large scale projects
 
 Use TypeScript for best in class instellisense.
 
+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)

ts/index.ts

@@ -11,4 +11,6 @@ const defaultLogger: Smartlog = new Smartlog({
   }
 });
 
+defaultLogger.enableConsole();
+
 export { Smartlog, defaultLogger };

ts/smartlog.classes.smartlog.ts

@@ -1,7 +1,15 @@
 import * as plugins from './smartlog.plugins';
 
 // interfaces
-import { TLogType, TEnvironment, ILogContext, TLogLevel, TRuntime, ILogDestination } from '@pushrocks/smartlog-interfaces';
+import {
+  TLogType,
+  TEnvironment,
+  ILogContext,
+  TLogLevel,
+  TRuntime,
+  ILogDestination,
+  ILogPackage
+} from '@pushrocks/smartlog-interfaces';
 
 import { LogRouter } from './smartlog.classes.logrouter';
 
@@ -18,7 +26,7 @@ export class Smartlog {
 
   private logRouter = new LogRouter();
 
-  public addLogDestination (logDestinationArg: ILogDestination) {
+  public addLogDestination(logDestinationArg: ILogDestination) {
     this.logRouter.addLogDestination(logDestinationArg);
   }
 
@@ -27,7 +35,6 @@ export class Smartlog {
     this.minimumLogLevel = optionsArg.minimumLogLevel;
   }
 
-
   // ============
   // Logger Setup
   // ============
@@ -43,20 +50,26 @@ export class Smartlog {
   // 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
    */
-  public log(logLevelArg: TLogLevel, logMessageArg: string) {
+  public log(logLevelArg: TLogLevel, logMessageArg: string, logDataArg?: any) {
     if (this.consoleEnabled) {
-      console.log(`LOG: ${logLevelArg}: ${logMessageArg}`);
+      console.log(`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`);
     }
-    this.logRouter.routeLog({
+    const logPackage: ILogPackage = {
+      timestamp: Date.now(),
       type: 'log',
       context: this.logContext,
       level: logLevelArg,
       message: logMessageArg
-    });
+    };
+    if (logDataArg) {
+      logPackage.data = logDataArg;
+    }
+    this.logRouter.routeLog(logPackage);
   }
 
   public increment(logLevelArg: TLogLevel, logMessageArg) {
@@ -64,10 +77,15 @@ export class Smartlog {
       console.log(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
     }
     this.logRouter.routeLog({
+      timestamp: Date.now(),
       type: 'increment',
       context: this.logContext,
       level: logLevelArg,
       message: logMessageArg
     });
   }
+
+  public handleLogPackage(logPackageArg: ILogPackage) {
+    this.logRouter.routeLog(logPackageArg);
+  }
 }