|
|
|
@ -1,25 +1,19 @@
|
|
|
|
|
# @pushrocks/smartlog
|
|
|
|
|
minimalistic distributed and extensible logging tool
|
|
|
|
|
|
|
|
|
|
winston based logger for large scale projects
|
|
|
|
|
|
|
|
|
|
## Availabililty
|
|
|
|
|
|
|
|
|
|
[](https://www.npmjs.com/package/smartlog)
|
|
|
|
|
[](https://GitLab.com/pushrocks/smartlog)
|
|
|
|
|
[](https://github.com/pushrocks/smartlog)
|
|
|
|
|
[](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
|
|
|
|
|
|
|
|
|
|
[](https://GitLab.com/pushrocks/smartlog/commits/master)
|
|
|
|
|
[](https://GitLab.com/pushrocks/smartlog/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/smartlog)
|
|
|
|
|
[](https://david-dm.org/pushrocks/smartlog)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartlog/master/dependencies/npm)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartlog)
|
|
|
|
|
[](https://snyk.io/test/npm/smartlog)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartlog/commits/master)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartlog/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/@pushrocks/smartlog)
|
|
|
|
|
[](https://snyk.io/test/npm/@pushrocks/smartlog)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](http://standardjs.com/)
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
@ -32,10 +26,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',
|
|
|
|
|
company: 'My awesome company',
|
|
|
|
|
companyunit: 'my awesome cloud team',
|
|
|
|
|
containerName?: 'awesome-container',
|
|
|
|
|
environment: TEnvironment: 'kubernetes-production',
|
|
|
|
|
environment: 'kubernetes-production',
|
|
|
|
|
runtime: 'node',
|
|
|
|
|
zone: 'zone x'
|
|
|
|
|
}
|
|
|
|
@ -58,19 +52,26 @@ 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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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.html)
|
|
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
|
|
|
|