Compare commits
54 Commits
Author | SHA1 | Date | |
---|---|---|---|
102e8faf92 | |||
87da0f1169 | |||
b53c49ca28 | |||
47bde8b4f8 | |||
d71de485d6 | |||
964666902f | |||
d5d6d7bf79 | |||
02d10dd08c | |||
4062157544 | |||
a673844fb3 | |||
53248a3a3d | |||
0043a553a7 | |||
13981404f3 | |||
db951d1877 | |||
26c84b3a04 | |||
b3d8cf68f1 | |||
60ae0fed4e | |||
a03e821c02 | |||
592178f066 | |||
260af690ff | |||
7bd12e7a01 | |||
f8a49e033d | |||
3066503a70 | |||
cf899609be | |||
7be0e70754 | |||
8b0ceb759d | |||
7b5cfb2c95 | |||
a4a5b18849 | |||
47583bd955 | |||
018bc7054a | |||
5ca4cb9964 | |||
27bb9a789c | |||
5f7e68d5b7 | |||
da0edc478c | |||
d2be068597 | |||
4113a9a211 | |||
3575262001 | |||
1cc75afc32 | |||
7d72b24770 | |||
ffff60772c | |||
a604b8e375 | |||
2cc3e6c906 | |||
5a475260dd | |||
9c79a26d04 | |||
3fbd87cab1 | |||
5fe5c1d315 | |||
1b4d9b33ef | |||
7598e9148b | |||
89429ac679 | |||
9f81cdfb8a | |||
ab9a7891a7 | |||
58358dd479 | |||
fc13271878 | |||
7cd739ff23 |
17
.gitignore
vendored
17
.gitignore
vendored
@ -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
|
101
.gitlab-ci.yml
101
.gitlab-ci.yml
@ -1,10 +1,10 @@
|
|||||||
# 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
|
||||||
@ -12,6 +12,9 @@ stages:
|
|||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- npm install -g @shipzone/npmci
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
# ====================
|
# ====================
|
||||||
@ -19,63 +22,42 @@ mirror:
|
|||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- 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
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci node install lts
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
@ -85,7 +67,17 @@ testSTABLE:
|
|||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
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:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
@ -95,6 +87,7 @@ release:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
@ -103,20 +96,15 @@ release:
|
|||||||
# ====================
|
# ====================
|
||||||
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:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- priv
|
- priv
|
||||||
|
|
||||||
@ -127,18 +115,19 @@ trigger:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- 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:
|
||||||
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal 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
26
.vscode/settings.json
vendored
Normal 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"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
@ -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"
|
||||||
|
1690
package-lock.json
generated
1690
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
45
package.json
45
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartlog",
|
"name": "@pushrocks/smartlog",
|
||||||
"version": "2.0.20",
|
"version": "3.0.2",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "minimalistic distributed and extensible logging tool",
|
"description": "minimalistic distributed and extensible logging tool",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
@ -11,25 +11,42 @@
|
|||||||
"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-config-prettier": "^1.18.0"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartlog-interfaces": "^2.0.5"
|
"@pushrocks/isounique": "^1.0.4",
|
||||||
}
|
"@pushrocks/smartlog-interfaces": "^3.0.0"
|
||||||
|
},
|
||||||
|
"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"
|
||||||
}
|
}
|
||||||
|
4356
pnpm-lock.yaml
generated
Normal file
4356
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
29
readme.md
29
readme.md
@ -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
|
||||||
[](https://gitlab.com/pushrocks/smartlog/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartlog/commits/master)
|
Status Category | Status Badge
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartlog)
|
-- | --
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartlog)
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
npm | [](https://lossless.cloud)
|
||||||
[](http://standardjs.com/)
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](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)
|
||||||
|
|
||||||
[](https://push.rocks)
|
[](https://maintainedby.lossless.com)
|
||||||
|
48
test/test.browser.ts
Normal file
48
test/test.browser.ts
Normal 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();
|
41
test/test.ts
41
test/test.ts
@ -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
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@pushrocks/smartlog',
|
||||||
|
version: '3.0.2',
|
||||||
|
description: 'minimalistic distributed and extensible logging tool'
|
||||||
|
}
|
20
ts/index.ts
20
ts/index.ts
@ -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 };
|
|
||||||
|
15
ts/smartlog.classes.consolelog.ts
Normal file
15
ts/smartlog.classes.consolelog.ts
Normal 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}`);
|
||||||
|
}
|
||||||
|
}
|
27
ts/smartlog.classes.loggroup.ts
Normal file
27
ts/smartlog.classes.loggroup.ts
Normal 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,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
@ -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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -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
|
|
||||||
};
|
|
||||||
|
17
tslint.json
17
tslint.json
@ -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"
|
|
||||||
}
|
|
Reference in New Issue
Block a user