npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@lido-nestjs/logger

v1.3.2

Published

NestJS Logger for Lido Finance projects. Part of [Lido NestJS Modules](https://github.com/lidofinance/lido-nestjs-modules/#readme)

Downloads

575

Readme

Logger

NestJS Logger for Lido Finance projects. Part of Lido NestJS Modules

The logger is based on winston logger and nest-winston package.

Install

yarn add @lido-nestjs/logger

Usage

Basic usage

import { Module } from '@nestjs/common';
import { LoggerModule, jsonTransport } from '@lido-nestjs/logger';

@Module({
  imports: [
    LoggerModule.forRoot({
      level: 'debug',
      transports: [jsonTransport()],
    }),
  ],
})
export class AppModule {}

Async usage

import { Module } from '@nestjs/common';
import { LoggerModule, jsonTransport } from '@lido-nestjs/logger';
import { ConfigModule, ConfigService } from './example';

@Module({
  imports: [
    LoggerModule.forRootAsync({
      imports: [ConfigModule],
      inject: [ConfigService],
      useFactory: async (configService: ConfigService) => ({
        level: configService.get('LOG_LEVEL'),
        transports: [jsonTransport()],
      }),
    }),
  ],
})
export class AppModule {}

Transports

The logger provides preconfigured console transports in json and simple formats. The transports can be imported from @lido-nestjs/logger:

import { simpleTransport, jsonTransport } from '@lido-nestjs/logger';

Secrets cleaner

Preconfigured transports have formatter for clean secrets from logs. To use it, pass an array of secret strings to the transport options:

import { Module } from '@nestjs/common';
import { LoggerModule, simpleTransport } from '@lido-nestjs/logger';

const PRIVATE_KEY = '0x000000000000';
const secrets = [PRIVATE_KEY];

@Module({
  imports: [
    LoggerModule.forRoot({
      level: 'debug',
      transports: [simpleTransport({ secrets })],
    }),
  ],
})
export class AppModule {}

Secrets will be replaced with text <removed>.

If you want to use this formatter in your custom transport, import the cleanSecrets from @lido-nestjs/logger:

import { cleanSecrets } from '@lido-nestjs/logger';

const myFormatter = winston.format.combine(
  cleanSecrets({ secrets: ['some-secret'] }),
  winston.format.json(),
);

const myTransport = new winston.transports.Console({
  format: myFormatter,
});

Meta fields

Meta fields can be useful for adding additional fields to logs, such as blockNumber in Ethereum bots. To add meta fields, pass a defaultMeta to logger options:

import { Module } from '@nestjs/common';
import { LoggerModule, jsonTransport } from '@lido-nestjs/logger';

@Module({
  imports: [
    LoggerModule.forRoot({
      level: 'debug',
      defaultMeta: {
        foo: 'bar',
        get baz() {
          // you can use getter for dynamic data
          return 1 + 1;
        },
      },
      transports: [jsonTransport()],
    }),
  ],
})
export class AppModule {}

In this case you will see extra fields in the logs:

logger.log('some message'); // { foo: 'bar', baz: 2, message: 'some message', ... }

Colorize

For simple transport you can set colors for meta fields by passing fieldColors in the transport options:

import { Module } from '@nestjs/common';
import { LoggerModule, simpleTransport } from '@lido-nestjs/logger';

const fieldColors = { foo: 'blue' };

@Module({
  imports: [
    LoggerModule.forRoot({
      level: 'debug',
      defaultMeta: {
        get block() {
          return 1000;
        },
      },
      transports: [simpleTransport({ fieldColors })],
    }),
  ],
})
export class AppModule {}

In this case you will see blue value of block field in the logs:

logger.log('some message'); // yyyy-mm-dd hh:mm:ss [1000] info: some message

Possible color values can be found in the winston docs.