Have ideas to improve npm?Join in the discussion! »

    json-logger-service
    TypeScript icon, indicating that this package has built-in type declarations

    7.6.5 • Public • Published

    json-logger-service

    Provides a Json Nest LoggerService.

    Installation

    $ npm i json-logger-service --save

    Usage

    Nest Json LoggerService implementation use

    Configuring Nest to use a custom Json LoggerService.

    import {NestFactory} from '@nestjs/core';
    import {AppModule} from './app.module';
    import {JsonLoggerService} from 'json-logger-service';
    
    const bootstrap = async () => {
        const app = await NestFactory.create(AppModule);
        app.useLogger(new JsonLoggerService('NestServer'));
        await app.listen(3000);
    };
    bootstrap();

    Using a new Json logger in your classes

    import {JsonLogger, LoggerFactory} from 'json-logger-service';
    
    export class HelloWorldService {
        private readonly logger: JsonLogger = LoggerFactory.createLogger(HelloWorldService.name);
    
        public getHello(): string {
            this.logger.info('Hello World!');
            this.logger.info({myContextProperty: 'My property\'s value', anotherProperty: 'Another value'}, 'Hello World with some context!');
            return 'Hello World!';
        }
    }

    Use Express request logger

    Configuring Nest to use a simple Express request logger.

    import {NestFactory} from '@nestjs/core';
    import {AppModule} from './app.module';
    import {RequestLogger} from 'json-logger-service';
    
    const bootstrap = async () => {
        const app = await NestFactory.create(AppModule);
        ...
        app.use(RequestLogger.buildExpressRequestLogger());
        ...
        await app.listen(3000);
    };
    bootstrap();

    Considering a request to /mypath, the logger output should be something like:

    {"name":"RequestLogger","hostname":"HOSTNAME","pid":PID,"level":30,"msg":"Before request GET '/mypath'","time":"2019-12-09T12:10:23.020Z","v":0}
    {"name":"RequestLogger","hostname":"HOSTNAME","pid":PID,"level":30,"msg":"After request GET '/mypath'","time":"2019-12-09T12:10:23.021Z","v":0}
    

    doNotLogPaths

    An array of base paths you do NOT want to log at all can be passed too.

    app.use(RequestLogger.buildExpressRequestLogger({ doNotLogPaths: ['/health-server-status'] } as RequestLoggerOptions));

    Then considering a request to /health-server-status, the logger will not log anything.

    logOnlyBasePaths

    An array of base paths you want to log without the full path (for security or GDPR reasons maybe) can be passed in the RequestLogger constructor.

    app.use(RequestLogger.buildExpressRequestLogger({ logOnlyBasePaths: ['/my-path'] } as RequestLoggerOptions));

    Then, considering a request to /my-path/customerEmail@gmail.com, the logger output should be something like:

    {"name":"RequestLogger","hostname":"HOSTNAME","pid":PID,"level":30,"msg":"Before request GET '/my-path'","time":"2019-12-09T12:10:23.020Z","v":0}
    {"name":"RequestLogger","hostname":"HOSTNAME","pid":PID,"level":30,"msg":"After request GET '/my-path'","time":"2019-12-09T12:10:23.021Z","v":0}
    

    Install

    npm i json-logger-service

    DownloadsWeekly Downloads

    851

    Version

    7.6.5

    License

    ISC

    Unpacked Size

    41.3 kB

    Total Files

    30

    Last publish

    Collaborators

    • avatar
    • avatar