Compare commits

...

56 Commits

Author SHA1 Message Date
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
7ec6579cc3 2.0.20 2019-10-22 15:04:16 +02:00
0c6240ae60 fix(core): update dependencies 2019-10-22 15:04:15 +02:00
5d9fb7c25a 2.0.19 2019-01-30 03:26:31 +01:00
6ee63d1e96 fix(license): update license files 2019-01-30 03:26:31 +01:00
e648a787e5 2.0.18 2019-01-30 03:24:47 +01:00
96bc87ecbd fix(readme): fix typo 2019-01-30 03:24:47 +01:00
de81a174f8 2.0.17 2019-01-30 03:23:57 +01:00
027216914d fix(readme): fix typo 2019-01-30 03:23:56 +01:00
34cc6cbed5 2.0.16 2019-01-28 23:30:56 +01:00
0bcca99349 fix(core): update 2019-01-28 23:30:55 +01:00
dc72beaf61 2.0.15 2019-01-28 02:03:12 +01:00
3b706a3b54 fix(core): update 2019-01-28 02:03:11 +01:00
acde7f2204 2.0.14 2019-01-22 12:49:09 +01:00
890d592072 fix(core): update 2019-01-22 12:49:09 +01:00
17 changed files with 27346 additions and 890 deletions

17
.gitignore vendored
View File

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

View File

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

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

@ -0,0 +1,29 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "current file",
"type": "node",
"request": "launch",
"args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
}
]
}

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

19
license Normal file
View File

@ -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.

View File

@ -1,6 +1,18 @@
{
"gitzone": {
"projectType": "npm",
"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": [],
"npmAccessLevel": "public"
}
}
}

27585
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,27 +1,52 @@
{
"name": "@pushrocks/smartlog",
"version": "2.0.13",
"version": "2.0.41",
"private": false,
"description": "winston based logger for large scale projects",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"description": "minimalistic distributed and extensible logging tool",
"keywords": [
"logging",
"centralized logging",
"json logging",
"scalyr",
"elasticsearch",
"logdna"
],
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH",
"license": "UNLICENSED",
"license": "MIT",
"scripts": {
"test": "(tstest test/)",
"build": "(tsbuild)",
"build": "(tsbuild --web && tsbundle npm)",
"format": "(gitzone format)"
},
"devDependencies": {
"@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"
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tsbundle": "^1.0.80",
"@gitzone/tsrun": "^1.2.17",
"@gitzone/tstest": "^1.0.54",
"@pushrocks/tapbundle": "^3.2.14",
"@types/node": "^16.0.0",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
},
"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"
]
}

View File

@ -1,26 +1,27 @@
# @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/)
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartlog/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartlog)](https://lossless.cloud)
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
@ -32,10 +33,10 @@ smartlog id s minimal logging package that provides a consistent experience acro
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',
company: 'My awesome company',
companyunit: 'my awesome cloud team',
containerName: 'awesome-container',
environment: 'kubernetes-production',
runtime: 'node',
zone: 'zone x'
}
@ -47,7 +48,7 @@ logger.log('silly', `a silly statement`); // log levels are shown to you by the
There is also a default logger available that you can use:
```ts
import {Smartlog, defaultLogger } from '@pushrocks/smartlog';
import { Smartlog, defaultLogger } from '@pushrocks/smartlog';
export class MyAwesomeClass {
constructor(public logger: Smartlog = defaultLogger) {
@ -58,19 +59,30 @@ export class MyAwesomeClass {
```
### 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
- [@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
For further information read the linked docs at the top of this README.
### Adding a log destination
```
// 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.
> 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';
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 * as smartlog from '../ts/index';
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 () => {
defaultLogger = smartlog.defaultLogger;
expect(defaultLogger).to.be.instanceOf(smartlog.Smartlog);
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 () => {
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 () => {
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();

View File

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

View File

@ -0,0 +1,15 @@
import * as plugins from './smartlog.plugins';
/**
* 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';
import { Smartlog } from './smartlog.classes.smartlog';
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

@ -15,9 +15,9 @@ export class LogRouter {
}
// routes the log according to added logDestinations
routeLog(logPackageArg: ILogPackage) {
public async routeLog(logPackageArg: ILogPackage) {
for (const logDestination of this.logDestinations) {
logDestination.handleLog(logPackageArg);
await logDestination.handleLog(logPackageArg);
}
}
}

View File

@ -1,32 +1,24 @@
import * as plugins from './smartlog.plugins';
// interfaces
import {
TLogType,
TEnvironment,
ILogContext,
TLogLevel,
TRuntime,
ILogDestination,
ILogPackage
} from '@pushrocks/smartlog-interfaces';
import { LogRouter } from './smartlog.classes.logrouter';
import { LogGroup } from '.';
export interface ISmartlogContructorOptions {
logContext: ILogContext;
minimumLogLevel?: TLogLevel;
logContext: plugins.smartlogInterfaces.ILogContext;
minimumLogLevel?: plugins.smartlogInterfaces.TLogLevel;
}
export class Smartlog {
private logContext: ILogContext;
private minimumLogLevel: TLogLevel;
export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
private logContext: plugins.smartlogInterfaces.ILogContext;
private minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
public uniInstanceId: string = plugins.isounique.uni();
private consoleEnabled: boolean;
private logRouter = new LogRouter();
public addLogDestination(logDestinationArg: ILogDestination) {
public addLogDestination(logDestinationArg: plugins.smartlogInterfaces.ILogDestination) {
this.logRouter.addLogDestination(logDestinationArg);
}
@ -42,7 +34,40 @@ export class Smartlog {
/**
* enables console logging
*/
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) {
return;
}
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;
}
// 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;
}
// fileStream.write(args[0]);
write.apply(process.stderr, args);
return true;
};
}
this.consoleEnabled = true;
}
@ -54,38 +79,74 @@ export class Smartlog {
* @param logLevelArg - the log level
* @param logMessageArg - the log message
* @param logDataArg - any additional log data
* @param correlationArg - info about corrleations
*/
public log(logLevelArg: 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) {
console.log(`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`);
this.safeConsoleLog(`${logLevelArg}: ${logMessageArg}`);
}
const logPackage: ILogPackage = {
const logPackage: plugins.smartlogInterfaces.ILogPackage = {
timestamp: Date.now(),
type: 'log',
context: this.logContext,
level: logLevelArg,
message: logMessageArg
correlation: correlationArg,
message: logMessageArg,
};
if (logDataArg) {
logPackage.data = logDataArg;
}
this.logRouter.routeLog(logPackage);
await this.logRouter.routeLog(logPackage);
}
public increment(logLevelArg: 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) {
console.log(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
this.safeConsoleLog(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
}
this.logRouter.routeLog({
timestamp: Date.now(),
type: 'increment',
context: this.logContext,
level: logLevelArg,
message: logMessageArg
message: logMessageArg,
correlation: correlationArg,
});
}
public handleLogPackage(logPackageArg: ILogPackage) {
this.logRouter.routeLog(logPackageArg);
public async handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
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 +1,4 @@
export {};
import * as isounique from '@pushrocks/isounique';
import * as smartlogInterfaces from '@pushrocks/smartlog-interfaces';
export { isounique, smartlogInterfaces };