A minimalistic, distributed, and extensible logging tool supporting centralized log management.
Go to file
2023-07-10 02:56:58 +02:00
.vscode BREAKING CHANGE(core): switch to esm 2022-06-26 10:35:35 +02:00
test BREAKING CHANGE(core): switch to esm 2022-06-26 10:35:35 +02:00
ts fix(core): update 2022-10-26 15:22:54 +02:00
.gitignore fix(core): update 2020-06-07 13:23:56 +00:00
.gitlab-ci.yml BREAKING CHANGE(core): switch to esm 2022-06-26 10:35:35 +02:00
license fix(license): update license files 2019-01-30 03:26:31 +01:00
npmextra.json switch to new org scheme 2023-07-10 02:56:58 +02:00
package.json switch to new org scheme 2023-07-10 02:56:58 +02:00
pnpm-lock.yaml fix(core): update 2022-10-26 15:22:54 +02:00
readme.md fix(core): update 2020-06-08 20:45:02 +00:00

@pushrocks/smartlog

minimalistic distributed and extensible logging tool

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia
Platform support Supports Windows 10 Supports Mac OS X

Usage

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:

import { Smartlog } from '@pushrocks/smartlog';
const logger = new Smartlog({
  {
    company: 'My awesome company',
    companyunit: 'my awesome cloud team',
    containerName: 'awesome-container',
    environment: 'kubernetes-production',
    runtime: 'node',
    zone: 'zone x'
  }
})

logger.log('silly', `a silly statement`); // log levels are shown to you by the IDE

There is also a default logger available that you can use:

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:

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 or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer