Compare commits

..

52 Commits

Author SHA1 Message Date
b53c49ca28 3.0.1 2022-07-26 21:03:40 +02:00
47bde8b4f8 fix(core): update 2022-07-26 21:03:39 +02:00
d71de485d6 3.0.0 2022-06-26 10:35:35 +02:00
964666902f BREAKING CHANGE(core): switch to esm 2022-06-26 10:35:35 +02:00
d5d6d7bf79 2.0.44 2021-07-21 02:25:22 +02:00
02d10dd08c fix(core): update 2021-07-21 02:25:22 +02:00
4062157544 2.0.43 2021-07-21 01:48:20 +02:00
a673844fb3 fix(core): update 2021-07-21 01:48:20 +02:00
53248a3a3d 2.0.42 2021-07-20 21:30:59 +02:00
0043a553a7 fix(core): update 2021-07-20 21:30:59 +02:00
13981404f3 2.0.41 2021-07-20 21:23:05 +02:00
db951d1877 fix(core): update 2021-07-20 21:23:05 +02:00
26c84b3a04 2.0.40 2021-07-06 19:26:36 +02:00
b3d8cf68f1 fix(core): update 2021-07-06 19:26:35 +02:00
60ae0fed4e 2.0.39 2020-09-08 12:57:25 +00:00
a03e821c02 fix(core): update 2020-09-08 12:57:24 +00:00
592178f066 2.0.38 2020-09-07 23:51:41 +00:00
260af690ff fix(core): update 2020-09-07 23:51:40 +00:00
7bd12e7a01 2.0.37 2020-09-07 21:30:02 +00:00
f8a49e033d fix(core): update 2020-09-07 21:30:02 +00:00
3066503a70 2.0.36 2020-08-02 23:47:20 +00:00
cf899609be fix(core): update 2020-08-02 23:47:19 +00:00
7be0e70754 2.0.35 2020-06-11 14:41:12 +00:00
8b0ceb759d fix(core): update 2020-06-11 14:41:11 +00:00
7b5cfb2c95 2.0.34 2020-06-11 14:28:04 +00:00
a4a5b18849 fix(core): update 2020-06-11 14:28:03 +00:00
47583bd955 2.0.33 2020-06-11 13:50:36 +00:00
018bc7054a fix(core): update 2020-06-11 13:50:35 +00:00
5ca4cb9964 2.0.32 2020-06-11 13:23:08 +00:00
27bb9a789c fix(core): update 2020-06-11 13:23:07 +00:00
5f7e68d5b7 2.0.31 2020-06-11 13:20:50 +00:00
da0edc478c fix(core): update 2020-06-11 13:20:49 +00:00
d2be068597 2.0.30 2020-06-11 10:47:06 +00:00
4113a9a211 fix(core): update 2020-06-11 10:47:05 +00:00
3575262001 2.0.29 2020-06-11 10:11:38 +00:00
1cc75afc32 fix(core): update 2020-06-11 10:11:37 +00:00
7d72b24770 2.0.28 2020-06-08 20:45:02 +00:00
ffff60772c fix(core): update 2020-06-08 20:45:02 +00:00
a604b8e375 2.0.27 2020-06-08 20:39:43 +00:00
2cc3e6c906 fix(core): update 2020-06-08 20:39:40 +00:00
5a475260dd 2.0.26 2020-06-08 18:51:12 +00:00
9c79a26d04 fix(core): update 2020-06-08 18:51:11 +00:00
3fbd87cab1 2.0.25 2020-06-08 16:16:55 +00:00
5fe5c1d315 fix(core): update 2020-06-08 16:16:54 +00:00
1b4d9b33ef 2.0.24 2020-06-07 13:23:56 +00:00
7598e9148b fix(core): update 2020-06-07 13:23:56 +00:00
89429ac679 2.0.23 2020-06-05 09:25:29 +00:00
9f81cdfb8a fix(core): update 2020-06-05 09:25:28 +00:00
ab9a7891a7 2.0.22 2020-06-05 01:53:10 +00:00
58358dd479 fix(core): update 2020-06-05 01:53:09 +00:00
fc13271878 2.0.21 2019-10-22 15:11:40 +02:00
7cd739ff23 fix(core): update 2019-10-22 15:11:40 +02:00
18 changed files with 14349 additions and 992 deletions

17
.gitignore vendored
View File

@ -1,5 +1,20 @@
.nogit/ .nogit/
node_modules/
# artifacts
coverage/ coverage/
public/ public/
pages/ pages/
# installs
node_modules/
# caches
.yarn/
.cache/
.rpt2_cache
# builds
dist/
dist_*/
# custom

View File

@ -1,16 +1,19 @@
# gitzone standard # gitzone ci_default
image: hosttoday/ht-docker-node:npmci image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: "$CI_BUILD_STAGE" key: '$CI_BUILD_STAGE'
stages: stages:
- security - security
- test - test
- release - release
- metadata - metadata
before_script:
- npm install -g @shipzone/npmci
# ==================== # ====================
# security stage # security stage
@ -18,127 +21,113 @@ stages:
mirror: mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
snyk: auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install -g snyk - npmci command npm install --production --ignore-scripts
- npmci command npm install --ignore-scripts - npmci command npm config set registry https://registry.npmjs.org
- npmci command snyk test - npmci command npm audit --audit-level=high --only=prod --production
tags: tags:
- docker - docker
- notpriv
sast:
stage: security
image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
variables:
DOCKER_DRIVER: overlay2
allow_failure: true allow_failure: true
services:
- docker:stable-dind auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci command npm install --ignore-scripts
- npmci command npm run build - npmci command npm config set registry https://registry.npmjs.org
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/') - npmci command npm audit --audit-level=high --only=dev
- 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: tags:
- docker - docker
- priv allow_failure: true
# ==================== # ====================
# test stage # test stage
# ==================== # ====================
testLTS: testStable:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install lts - npmci node install stable
- npmci npm install - npmci npm install
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
testBuild:
testSTABLE:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci npm test - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
release: release:
stage: release stage: release
script: script:
- npmci node install stable - npmci node install stable
- npmci npm publish - npmci npm publish
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
# ==================== # ====================
# metadata stage # metadata stage
# ==================== # ====================
codequality: codequality:
stage: metadata stage: metadata
image: docker:stable
allow_failure: true allow_failure: true
services: only:
- docker:stable-dind - tags
script: script:
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/') - npmci command npm install -g typescript
- docker run - npmci npm prepare
--env SOURCE_CODE="$PWD" - npmci npm install
--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]
tags: tags:
- docker - lossless
- priv - docker
- priv
trigger: trigger:
stage: metadata stage: metadata
script: script:
- npmci trigger - npmci trigger
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
pages: pages:
image: hosttoday/ht-docker-node:npmci
stage: metadata stage: metadata
script: script:
- npmci command npm install -g typedoc typescript - npmci node install stable
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/ - npmci command npm run buildDocs
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:
@ -146,5 +135,5 @@ pages:
artifacts: artifacts:
expire_in: 1 week expire_in: 1 week
paths: paths:
- public - public
allow_failure: true allow_failure: true

11
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored Normal file
View File

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

View File

@ -1,10 +1,11 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "pushrocks",
"gitrepo": "smartlog", "gitrepo": "smartlog",
"shortDescription": "minimalistic distributed and extensible logging tool", "description": "minimalistic distributed and extensible logging tool",
"npmPackagename": "@pushrocks/smartlog", "npmPackagename": "@pushrocks/smartlog",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks"
@ -14,4 +15,4 @@
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "npmAccessLevel": "public"
} }
} }

14769
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "@pushrocks/smartlog", "name": "@pushrocks/smartlog",
"version": "2.0.20", "version": "3.0.1",
"private": false, "private": false,
"description": "minimalistic distributed and extensible logging tool", "description": "minimalistic distributed and extensible logging tool",
"keywords": [ "keywords": [
@ -11,25 +11,44 @@
"elasticsearch", "elasticsearch",
"logdna" "logdna"
], ],
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild)", "build": "(tsbuild --web && tsbundle npm)",
"format": "(gitzone format)" "format": "(gitzone format)",
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@gitzone/tsbuild": "^2.1.25",
"@gitzone/tsrun": "^1.2.8", "@gitzone/tsbundle": "^2.0.6",
"@gitzone/tstest": "^1.0.28", "@gitzone/tsrun": "^1.2.17",
"@pushrocks/tapbundle": "^3.0.13", "@gitzone/tstest": "^1.0.72",
"@types/node": "^12.11.2", "@pushrocks/tapbundle": "^5.0.4",
"tslint": "^5.20.0", "@types/node": "^18.6.1",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0" "tslint-config-prettier": "^1.18.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartlog-interfaces": "^2.0.5" "@pushrocks/isounique": "^1.0.4",
} "@pushrocks/smartlog-interfaces": "^2.0.22"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
],
"type": "module"
} }

View File

@ -8,13 +8,20 @@ minimalistic distributed and extensible logging tool
* [docs (typedoc)](https://pushrocks.gitlab.io/smartlog/) * [docs (typedoc)](https://pushrocks.gitlab.io/smartlog/)
## Status for master ## 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) Status Category | Status Badge
[![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) GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartlog/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartlog)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartlog)](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/smartlog)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartlog)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartlog)](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 ## Usage
@ -69,9 +76,13 @@ The following destinations are available:
// TBD // TBD
``` ```
## 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. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > 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)

48
test/test.browser.ts Normal file
View File

@ -0,0 +1,48 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as smartlog from '../ts/index.js';
let testConsoleLog: smartlog.ConsoleLog;
let testSmartLog: smartlog.Smartlog;
tap.test('should produce a valid ConsoleLog instance', async () => {
testConsoleLog = new smartlog.ConsoleLog();
testConsoleLog.log('ok', 'this is ok');
});
tap.test('should produce instance of Smartlog', async () => {
testSmartLog = new smartlog.Smartlog({
logContext: {
environment: 'test',
runtime: 'node',
zone: 'gitzone',
company: 'Lossless GmbH',
companyunit: 'Lossless Cloud',
containerName: 'testing',
},
});
});
tap.test('should enable console logging', async () => {
testSmartLog.enableConsole({
captureAll: true,
});
console.log('this is a normal log that should be captured');
console.log(new Error('hi there'));
testSmartLog.log('info', 'this should only be printed once');
});
tap.test('should be able to log things', async () => {
testSmartLog.log('silly', 'hi');
});
tap.test('should create a log group', async () => {
const logGroup = testSmartLog.createLogGroup('some cool transaction');
logGroup.log('info', 'this is logged from a log group');
});
tap.test('should catch error', async () => {
console.error(new Error('hey'));
// throw new Error('hey');
});
tap.start();

View File

@ -1,19 +1,48 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as smartlog from '../ts/index'; import * as smartlog from '../ts/index.js';
let defaultLogger: smartlog.Smartlog; let testConsoleLog: smartlog.ConsoleLog;
let testSmartLog: smartlog.Smartlog;
tap.test('should produce a valid ConsoleLog instance', async () => {
testConsoleLog = new smartlog.ConsoleLog();
testConsoleLog.log('ok', 'this is ok');
});
tap.test('should produce instance of Smartlog', async () => { tap.test('should produce instance of Smartlog', async () => {
defaultLogger = smartlog.defaultLogger; testSmartLog = new smartlog.Smartlog({
expect(defaultLogger).to.be.instanceOf(smartlog.Smartlog); logContext: {
environment: 'test',
runtime: 'node',
zone: 'gitzone',
company: 'Lossless GmbH',
companyunit: 'Lossless Cloud',
containerName: 'testing',
},
});
}); });
tap.test('should enable console logging', async () => { tap.test('should enable console logging', async () => {
defaultLogger.enableConsole(); testSmartLog.enableConsole({
captureAll: true,
});
console.log('this is a normal log that should be captured');
console.log(new Error('hi there'));
testSmartLog.log('info', 'this should only be printed once');
}); });
tap.test('should be able to log things', async () => { tap.test('should be able to log things', async () => {
defaultLogger.log('silly', 'hi'); testSmartLog.log('silly', 'hi');
});
tap.test('should create a log group', async () => {
const logGroup = testSmartLog.createLogGroup('some cool transaction');
logGroup.log('info', 'this is logged from a log group');
});
tap.test('should catch error', async () => {
console.error(new Error('hey'));
// throw new Error('hey');
}); });
tap.start(); tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@pushrocks/smartlog',
version: '3.0.1',
description: 'minimalistic distributed and extensible logging tool'
}

View File

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

View File

@ -0,0 +1,15 @@
import * as plugins from './smartlog.plugins.js';
/**
* a console log optimized for smartlog
*/
export class ConsoleLog {
public log(
logLevelArg: plugins.smartlogInterfaces.TLogLevel,
logMessageArg: string,
dataArg?: any,
correlationArg?: plugins.smartlogInterfaces.ILogCorrelation
) {
console.log(`__# ${logLevelArg}: ${logMessageArg}`);
}
}

View File

@ -0,0 +1,27 @@
import * as plugins from './smartlog.plugins.js';
import { Smartlog } from './smartlog.classes.smartlog.js';
export class LogGroup {
public smartlogRef: Smartlog;
public transactionId: string;
public groupId = plugins.isounique.uni();
constructor(smartlogInstance: Smartlog, transactionIdArg: string) {
this.smartlogRef = smartlogInstance;
this.transactionId = transactionIdArg;
}
public log(
logLevelArg: plugins.smartlogInterfaces.TLogLevel,
logMessageArg: string,
logDataArg?: any
) {
this.smartlogRef.log(logLevelArg, logMessageArg, logDataArg, {
id: plugins.isounique.uni(),
type: 'none',
group: this.groupId,
instance: this.smartlogRef.uniInstanceId,
transaction: this.transactionId,
});
}
}

View File

@ -1,4 +1,4 @@
import * as plugins from './smartlog.plugins'; import * as plugins from './smartlog.plugins.js';
import { ILogDestination, ILogPackage } from '@pushrocks/smartlog-interfaces'; import { ILogDestination, ILogPackage } from '@pushrocks/smartlog-interfaces';
@ -15,9 +15,9 @@ export class LogRouter {
} }
// routes the log according to added logDestinations // routes the log according to added logDestinations
routeLog(logPackageArg: ILogPackage) { public async routeLog(logPackageArg: ILogPackage) {
for (const logDestination of this.logDestinations) { for (const logDestination of this.logDestinations) {
logDestination.handleLog(logPackageArg); await logDestination.handleLog(logPackageArg);
} }
} }
} }

View File

@ -1,15 +1,18 @@
import * as plugins from './smartlog.plugins'; import * as plugins from './smartlog.plugins.js';
import { LogRouter } from './smartlog.classes.logrouter'; import { LogRouter } from './smartlog.classes.logrouter.js';
import { LogGroup } from './smartlog.classes.loggroup.js';
export interface ISmartlogContructorOptions { export interface ISmartlogContructorOptions {
logContext: plugins.smartlogInterfaces.ILogContext; logContext: plugins.smartlogInterfaces.ILogContext;
minimumLogLevel?: plugins.smartlogInterfaces.TLogLevel; minimumLogLevel?: plugins.smartlogInterfaces.TLogLevel;
} }
export class Smartlog { export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
private logContext: plugins.smartlogInterfaces.ILogContext; public logContext: plugins.smartlogInterfaces.ILogContext;
private minimumLogLevel: plugins.smartlogInterfaces.TLogLevel; public minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
public uniInstanceId: string = plugins.isounique.uni();
private consoleEnabled: boolean; private consoleEnabled: boolean;
@ -21,7 +24,7 @@ export class Smartlog {
constructor(optionsArg: ISmartlogContructorOptions) { constructor(optionsArg: ISmartlogContructorOptions) {
this.logContext = optionsArg.logContext; this.logContext = optionsArg.logContext;
this.minimumLogLevel = optionsArg.minimumLogLevel; this.minimumLogLevel = optionsArg.minimumLogLevel || 'silly';
} }
// ============ // ============
@ -31,7 +34,39 @@ export class Smartlog {
/** /**
* enables console logging * enables console logging
*/ */
public enableConsole() { public enableConsole(optionsArg?: { captureAll: boolean }) {
if (globalThis.process && optionsArg && optionsArg.captureAll) {
const process = globalThis.process;
const write = process.stdout.write;
process.stdout.write = (...args: any) => {
const logString: string = args[0];
if (!logString || typeof logString.startsWith !== 'function') {
// lets continue as planned
} else if (!logString.startsWith('LOG') && typeof logString === 'string') {
switch (true) {
case logString.substr(0, 20).includes('Error:'):
this.log('error', logString);
break;
default:
this.log('info', logString);
}
return true;
}
// fileStream.write(args[0]);
write.apply(process.stdout, args);
return true;
};
process.stderr.write = (...args: any) => {
if (!args[0].startsWith('LOG')) {
this.log('error', args[0]);
return true;
}
// fileStream.write(args[0]);
write.apply(process.stderr, args);
return true;
};
}
this.consoleEnabled = true; this.consoleEnabled = true;
} }
@ -43,40 +78,74 @@ export class Smartlog {
* @param logLevelArg - the log level * @param logLevelArg - the log level
* @param logMessageArg - the log message * @param logMessageArg - the log message
* @param logDataArg - any additional log data * @param logDataArg - any additional log data
* @param correlationArg - info about corrleations
*/ */
public log(logLevelArg: plugins.smartlogInterfaces.TLogLevel, logMessageArg: string, logDataArg?: any) { public async log(
logLevelArg: plugins.smartlogInterfaces.TLogLevel,
logMessageArg: string,
logDataArg?: any,
correlationArg?: plugins.smartlogInterfaces.ILogCorrelation
) {
correlationArg = {
...{
id: plugins.isounique.uni(),
type: 'none',
instance: this.uniInstanceId,
},
...correlationArg,
};
if (this.consoleEnabled) { if (this.consoleEnabled) {
console.log( this.safeConsoleLog(`${logLevelArg}: ${logMessageArg}`);
`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`
);
} }
const logPackage: plugins.smartlogInterfaces.ILogPackage = { const logPackage: plugins.smartlogInterfaces.ILogPackage = {
timestamp: Date.now(), timestamp: Date.now(),
type: 'log', type: 'log',
context: this.logContext, context: this.logContext,
level: logLevelArg, level: logLevelArg,
message: logMessageArg correlation: correlationArg,
message: logMessageArg,
}; };
if (logDataArg) { if (logDataArg) {
logPackage.data = logDataArg; logPackage.data = logDataArg;
} }
this.logRouter.routeLog(logPackage); await this.logRouter.routeLog(logPackage);
} }
public increment(logLevelArg: plugins.smartlogInterfaces.TLogLevel, logMessageArg) { public increment(
logLevelArg: plugins.smartlogInterfaces.TLogLevel,
logMessageArg: string,
logDataArg?: any,
correlationArg: plugins.smartlogInterfaces.ILogCorrelation = {
id: plugins.isounique.uni(),
type: 'none',
}
) {
if (this.consoleEnabled) { if (this.consoleEnabled) {
console.log(`INCREMENT: ${logLevelArg}: ${logMessageArg}`); this.safeConsoleLog(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
} }
this.logRouter.routeLog({ this.logRouter.routeLog({
timestamp: Date.now(), timestamp: Date.now(),
type: 'increment', type: 'increment',
context: this.logContext, context: this.logContext,
level: logLevelArg, level: logLevelArg,
message: logMessageArg message: logMessageArg,
correlation: correlationArg,
}); });
} }
public handleLogPackage(logPackageArg: plugins.smartlogInterfaces.ILogPackage) { public async handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
this.logRouter.routeLog(logPackageArg); await this.logRouter.routeLog(logPackageArg);
}
private safeConsoleLog(logLine: string) {
console.log(
`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLine}`
);
}
public createLogGroup(transactionId: string = 'none') {
return new LogGroup(this, transactionId);
} }
} }

View File

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

View File

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