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

@homeofthings/nestjs-logger

v2.0.3

Published

HomeOfThings - NestJs Logger: a logger for NestJs based on Winston

Downloads

96

Readme

npm version Build Workflow Coverage Status DeepScan grade Known Vulnerabilities

PRs Welcome License

HomeOfThings - Logger for NestJs

a logging module for NestJS based on winston which provides a reasonable configured logger for the application-wide use by all the NestJs loggers.

installation

npm install @homeofthings/nestjs-logger

quick start

import module in AppModule by providing options synchronously

@Module({
  imports: [
    LoggerModule.forRoot(LoggerModule, {
      // provide your options
    }),
  ],
})
export class AppModule {}

and set the injected LoggerService as the application logger:

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useLogger(app.get(LoggerService));
}
bootstrap();

import module in AppModule by providing options asynchronously

@Module({
  imports: [
    LoggerModule.forRootAsync(LoggerModule, {
      imports: [], // optional
      useFactory: (): Promise<LoggerModuleOptions> =>
        Promise.resolve({
          // provide your options
        }),
      inject: [], // optional inject params for useFactory method
    }),
  ],
})
export class AppModule {}

and set the injected LoggerService as the application logger:

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useLogger(app.get(LoggerService));
}
bootstrap();

using as Nest Logger and for bootstrapping

const logger = LoggerModule.createLoggerService({
  // provide your options
});
async function bootstrap() {
  const app = await NestFactory.create(AppModule, { loggger });
}
bootstrap();

NOTE: using this method, there is probably no need for additional imports of the LoggerModule in AppModule or any child module, but anyway if you decide to do so, only the options given to the first method will be taken into account

application logging

as recommended by nestjs:

import { Injectable, Logger } from '@nestjs/common';

@Injectable()
class MyService {
  private readonly logger = new Logger(MyService.name);

  doSomething() {
    this.logger.log('Doing something...');
  }
}

That way, the calls to this.logger.log() from MyService would result in calls to the method log from our logger instance.

environment variables

  • FORCE_COLORS ... force color output
  • NO_COLORS ... disable color output

default formatters

console

file

2021-04-11T19:58:57.602Z debug:   [Logger] Logger initialized
2021-04-11T19:58:57.812Z info:    [NestFactory] Starting Nest application...
2021-04-11T19:58:57.835Z debug:   [AppModule] AppModule created
2021-04-11T19:58:57.837Z info:    [InstanceLoader] AppModule dependencies initialized
2021-04-11T19:58:57.839Z debug:   [Application] Application created
2021-04-11T19:58:57.840Z debug:   [Application] Configuration:
2021-04-11T19:58:57.841Z debug:   [Application]   environment: development
2021-04-11T19:58:57.841Z debug:   [Application]   directory: /home/gms/work/HOT/HomeOfThings/workspace/config
2021-04-11T19:58:57.847Z info:    [RoutesResolver] AppController {/api}:
2021-04-11T19:58:57.852Z info:    [RouterExplorer] Mapped {/api, GET} route
2021-04-11T19:58:57.855Z info:    [NestApplication] Nest application successfully started
2021-04-11T19:58:57.862Z info:    [Application] Listening on http://localhost:8080/api

RELEASE NOTES

CHANGELOG