Compare commits
10 Commits
Author | SHA1 | Date | |
---|---|---|---|
5d9fb7c25a | |||
6ee63d1e96 | |||
e648a787e5 | |||
96bc87ecbd | |||
de81a174f8 | |||
027216914d | |||
34cc6cbed5 | |||
0bcca99349 | |||
dc72beaf61 | |||
3b706a3b54 |
19
license
Normal file
19
license
Normal 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.
|
@ -1,4 +1,15 @@
|
|||||||
{
|
{
|
||||||
|
"gitzone": {
|
||||||
|
"module": {
|
||||||
|
"githost": "gitlab.com",
|
||||||
|
"gitscope": "pushrocks",
|
||||||
|
"gitrepo": "smartlog",
|
||||||
|
"shortDescription": "minimalistic distributed and extensible logging tool",
|
||||||
|
"npmPackagename": "@pushrocks/smartlog",
|
||||||
|
"license": "MIT",
|
||||||
|
"projectDomain": "push.rocks"
|
||||||
|
}
|
||||||
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartlog",
|
"name": "@pushrocks/smartlog",
|
||||||
"version": "2.0.14",
|
"version": "2.0.19",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 1,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
14
package.json
14
package.json
@ -1,12 +1,20 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartlog",
|
"name": "@pushrocks/smartlog",
|
||||||
"version": "2.0.14",
|
"version": "2.0.19",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "winston based logger for large scale projects",
|
"description": "minimalistic distributed and extensible logging tool",
|
||||||
|
"keywords": [
|
||||||
|
"logging",
|
||||||
|
"centralized logging",
|
||||||
|
"json logging",
|
||||||
|
"scalyr",
|
||||||
|
"elasticsearch",
|
||||||
|
"logdna"
|
||||||
|
],
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "UNLICENSED",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild)",
|
"build": "(tsbuild)",
|
||||||
|
56
readme.md
56
readme.md
@ -1,25 +1,19 @@
|
|||||||
# @pushrocks/smartlog
|
# @pushrocks/smartlog
|
||||||
|
minimalistic distributed and extensible logging tool
|
||||||
|
|
||||||
winston based logger for large scale projects
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartlog)
|
||||||
## Availabililty
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartlog)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartlog)
|
||||||
[](https://www.npmjs.com/package/smartlog)
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartlog/)
|
||||||
[](https://GitLab.com/pushrocks/smartlog)
|
|
||||||
[](https://github.com/pushrocks/smartlog)
|
|
||||||
[](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)
|
[](https://gitlab.com/pushrocks/smartlog/commits/master)
|
||||||
[](https://GitLab.com/pushrocks/smartlog/commits/master)
|
[](https://www.npmjs.com/package/@pushrocks/smartlog)
|
||||||
[](https://www.npmjs.com/package/smartlog)
|
[](https://snyk.io/test/npm/@pushrocks/smartlog)
|
||||||
[](https://david-dm.org/pushrocks/smartlog)
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
[](https://www.bithound.io/github/pushrocks/smartlog/master/dependencies/npm)
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
[](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/)
|
|
||||||
[](http://standardjs.com/)
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@ -32,10 +26,10 @@ smartlog id s minimal logging package that provides a consistent experience acro
|
|||||||
import { Smartlog } from '@pushrocks/smartlog';
|
import { Smartlog } from '@pushrocks/smartlog';
|
||||||
const logger = new Smartlog({
|
const logger = new Smartlog({
|
||||||
{
|
{
|
||||||
company?: 'My awesome company',
|
company: 'My awesome company',
|
||||||
companyunit?: 'my awesome cloud team',
|
companyunit: 'my awesome cloud team',
|
||||||
containerName?: 'awesome-container',
|
containerName: 'awesome-container',
|
||||||
environment: TEnvironment: 'kubernetes-production',
|
environment: 'kubernetes-production',
|
||||||
runtime: 'node',
|
runtime: 'node',
|
||||||
zone: 'zone x'
|
zone: 'zone x'
|
||||||
}
|
}
|
||||||
@ -47,7 +41,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:
|
There is also a default logger available that you can use:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import {Smartlog, defaultLogger } from '@pushrocks/smartlog';
|
import { Smartlog, defaultLogger } from '@pushrocks/smartlog';
|
||||||
|
|
||||||
export class MyAwesomeClass {
|
export class MyAwesomeClass {
|
||||||
constructor(public logger: Smartlog = defaultLogger) {
|
constructor(public logger: Smartlog = defaultLogger) {
|
||||||
@ -58,24 +52,26 @@ export class MyAwesomeClass {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Destinations
|
### Destinations
|
||||||
|
|
||||||
smartlog supports different kinds of destinations.
|
smartlog supports different kinds of destinations.
|
||||||
|
|
||||||
The following destinations are available:
|
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-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-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)
|
- [@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/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
|
- [@mojoio/elasticsearch](https://www.npmjs.com/package/@mojoio/elasticsearch) - an elasticsearch API package that comes with a smartlog destination included
|
||||||
|
|
||||||
### Adding a log destination
|
### Adding a log destination
|
||||||
|
|
||||||
```
|
```
|
||||||
// TBD
|
// TBD
|
||||||
```
|
```
|
||||||
|
|
||||||
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.html)
|
||||||
|
|
||||||
[](https://push.rocks)
|
[](https://push.rocks)
|
||||||
|
@ -57,7 +57,9 @@ export class Smartlog {
|
|||||||
*/
|
*/
|
||||||
public log(logLevelArg: TLogLevel, logMessageArg: string, logDataArg?: any) {
|
public log(logLevelArg: TLogLevel, logMessageArg: string, logDataArg?: any) {
|
||||||
if (this.consoleEnabled) {
|
if (this.consoleEnabled) {
|
||||||
console.log(`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`);
|
console.log(
|
||||||
|
`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`
|
||||||
|
);
|
||||||
}
|
}
|
||||||
const logPackage: ILogPackage = {
|
const logPackage: ILogPackage = {
|
||||||
timestamp: Date.now(),
|
timestamp: Date.now(),
|
||||||
|
Reference in New Issue
Block a user