@nest-toolbox/bunyan-logger 1.4.1 → 1.4.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +16 -2
  2. package/dist/bunyan-logger.service.d.ts +17 -11
  3. package/dist/bunyan-logger.service.js +10 -16
  4. package/dist/bunyan-logger.service.js.map +1 -1
  5. package/dist/tsconfig.build.tsbuildinfo +1 -8099
  6. package/package.json +57 -57
package/README.md CHANGED
@@ -16,13 +16,14 @@ You can pass any custom stream supported by Bunyan
16
16
  import { NestFactory } from '@nestjs/core';
17
17
  import { BunyanLoggerService } from "@nest-toolbox/bunyan-logger";
18
18
  import { AppModule } from './app.module';
19
+ const Elasticsearch = require('bunyan-elasticsearch');
19
20
 
20
21
  async function bootstrap() {
21
22
  const app = await NestFactory.create<NestExpressApplication>(
22
23
  ApplicationModule,
23
24
  {
24
25
  logger: new BunyanLoggerService({
25
- projectName: 'project',
26
+ projectId: 'project',
26
27
  formatterOptions: {
27
28
  outputMode: 'long',
28
29
  },
@@ -30,15 +31,25 @@ async function bootstrap() {
30
31
  },
31
32
  );
32
33
 
34
+ const esStream = new Elasticsearch({
35
+ type: 'logs',
36
+ host: 'localhost:9300',
37
+ });
38
+
33
39
  const app = await NestFactory.create<NestExpressApplication>(
34
40
  ApplicationModule,
35
41
  {
36
42
  logger: new BunyanLoggerService({
37
- projectName: 'project',
43
+ projectId: 'project',
38
44
  formatterOptions: {
39
45
  outputMode: 'long',
40
46
  },
47
+ extraFields?: {
48
+ environment:'production',
49
+ microservice: 'users',
50
+ };
41
51
  customStreams: [
52
+ { stream: esStream },
42
53
  {
43
54
  path: 'foo.log',
44
55
  },
@@ -66,5 +77,8 @@ options: {
66
77
  colorFromLevel?: any;
67
78
  };
68
79
  customStreams?: any[];
80
+ extraFields?: {
81
+ [key: string]: string;
82
+ };
69
83
  }
70
84
  ```
package/dist/bunyan-logger.service.d.ts CHANGED
@@ -1,28 +1,34 @@
1
1
  import { LoggerService } from '@nestjs/common';
2
2
  import * as Bunyan from 'bunyan';
3
+ export interface FormatterOptions {
4
+ outputMode: string;
5
+ color?: boolean;
6
+ levelInString?: boolean;
7
+ colorFromLevel?: any;
8
+ src?: boolean;
9
+ }
3
10
  export declare class BunyanLoggerService implements LoggerService {
4
11
  private readonly bunyanLogger;
5
12
  private isEmpty;
6
13
  /**
7
14
  * Creates an instance of BunyanLoggerService.
8
- * @param {({
15
+ * @param {{
9
16
  * projectId: string;
10
- * formatterOptions: {
11
- * outputMode: string; // short|long|simple|json|bunyan
12
- * color?: boolean;
13
- * levelInString?: boolean;
14
- * colorFromLevel?: any;
17
+ * formatterOptions: FormatterOptions;
18
+ * customStreams?: Bunyan.Stream[];
19
+ * extraFields?: {
20
+ * [key: string]: string;
15
21
  * };
16
- * customStreams?: any[];
17
- * })} options
22
+ * }} options
18
23
  * @memberof BunyanLoggerService
19
24
  */
20
25
  constructor(options: {
21
26
  projectId: string;
22
- formatterOptions: {
23
- [key: string]: any;
24
- };
27
+ formatterOptions: FormatterOptions;
25
28
  customStreams?: Bunyan.Stream[];
29
+ extraFields?: {
30
+ [key: string]: string;
31
+ };
26
32
  });
27
33
  log(message: any | any[], context?: string | undefined): void;
28
34
  error(message: any | any[], trace?: string | undefined, context?: string | undefined): void;
package/dist/bunyan-logger.service.js CHANGED
@@ -7,31 +7,25 @@ const colors = require("colors");
7
7
  class BunyanLoggerService {
8
8
  /**
9
9
  * Creates an instance of BunyanLoggerService.
10
- * @param {({
10
+ * @param {{
11
11
  * projectId: string;
12
- * formatterOptions: {
13
- * outputMode: string; // short|long|simple|json|bunyan
14
- * color?: boolean;
15
- * levelInString?: boolean;
16
- * colorFromLevel?: any;
12
+ * formatterOptions: FormatterOptions;
13
+ * customStreams?: Bunyan.Stream[];
14
+ * extraFields?: {
15
+ * [key: string]: string;
17
16
  * };
18
- * customStreams?: any[];
19
- * })} options
17
+ * }} options
20
18
  * @memberof BunyanLoggerService
21
19
  */
22
20
  constructor(options) {
23
21
  this.isEmpty = (obj) => [Object, Array].includes((obj || {}).constructor) && !Object.entries(obj || {}).length;
24
- const { projectId, formatterOptions, customStreams } = options;
22
+ const { projectId, formatterOptions, customStreams, extraFields } = options;
25
23
  if (projectId == null || this.isEmpty(projectId)) {
26
24
  throw new Error(`projectId is required`);
27
25
  }
28
26
  const defaultStream = { level: 'info', type: 'stream', stream: bunyanFormat(formatterOptions) };
29
27
  const streams = [defaultStream, ...(customStreams || [])];
30
- this.bunyanLogger = Bunyan.createLogger({
31
- level: Bunyan.INFO,
32
- name: projectId,
33
- streams: [...streams],
34
- });
28
+ this.bunyanLogger = Bunyan.createLogger(Object.assign({ level: Bunyan.INFO, name: projectId, streams: [...streams] }, extraFields));
35
29
  }
36
30
  log(message, context) {
37
31
  message = Array.isArray(message) ? message : [message];
@@ -39,11 +33,11 @@ class BunyanLoggerService {
39
33
  }
40
34
  error(message, trace, context) {
41
35
  message = Array.isArray(message) ? message : [message];
42
- this.bunyanLogger.error({ context, trace }, ...message.map(msg => colors.red(msg)));
36
+ this.bunyanLogger.error({ context, trace }, ...message.map((msg) => colors.red(msg)));
43
37
  }
44
38
  warn(message, context) {
45
39
  message = Array.isArray(message) ? message : [message];
46
- this.bunyanLogger.warn({ context }, ...message.map(msg => colors.yellow(msg)));
40
+ this.bunyanLogger.warn({ context }, ...message.map((msg) => colors.yellow(msg)));
47
41
  }
48
42
  }
49
43
  exports.BunyanLoggerService = BunyanLoggerService;
package/dist/bunyan-logger.service.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"bunyan-logger.service.js","sourceRoot":"","sources":["../src/bunyan-logger.service.ts"],"names":[],"mappings":";;;AACA,iCAAiC;AACjC,8CAA8C;AAC9C,iCAAiC;AAEjC,MAAa,mBAAmB;IAI5B;;;;;;;;;;;;;OAaG;IACH,YAAY,OAMX;QAtBO,YAAO,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QAuB9G,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;QAC/D,IAAI,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC9C,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC5C;QACD,MAAM,aAAa,GAAkB,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC/G,MAAM,OAAO,GAAoB,CAAC,aAAa,EAAE,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;QAE3E,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;YACpC,KAAK,EAAE,MAAM,CAAC,IAAI;YAClB,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC;SACxB,CAAC,CAAC;IACP,CAAC;IAEM,GAAG,CAAC,OAAoB,EAAE,OAA4B;QACzD,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,OAAoB,EAAE,KAA0B,EAAE,OAA4B;QACvF,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC;IAEM,IAAI,CAAC,OAAoB,EAAE,OAA4B;QAC1D,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;CACJ;AArDD,kDAqDC"}
1
+ {"version":3,"file":"bunyan-logger.service.js","sourceRoot":"","sources":["../src/bunyan-logger.service.ts"],"names":[],"mappings":";;;AACA,iCAAiC;AACjC,8CAA8C;AAC9C,iCAAiC;AAUjC,MAAa,mBAAmB;IAI9B;;;;;;;;;;;OAWG;IACH,YAAY,OAOX;QArBO,YAAO,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QAsBhH,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;QAC5E,IAAI,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC1C;QACD,MAAM,aAAa,GAAkB,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC/G,MAAM,OAAO,GAAoB,CAAC,aAAa,EAAE,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;QAE3E,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,iBACrC,KAAK,EAAE,MAAM,CAAC,IAAI,EAClB,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,IAClB,WAAW,EACd,CAAC;IACL,CAAC;IAEM,GAAG,CAAC,OAAoB,EAAE,OAA4B;QAC3D,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,OAAoB,EAAE,KAA0B,EAAE,OAA4B;QACzF,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACxF,CAAC;IAEM,IAAI,CAAC,OAAoB,EAAE,OAA4B;QAC5D,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACnF,CAAC;CACF;AArDD,kDAqDC"}