# nest-microservices-logger

> A NestJS logger for generator-nest-microservices template

Latest version **0.0.1** (published 2020-11-27) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install nest-microservices-logger
pnpm add nest-microservices-logger
yarn add nest-microservices-logger
bun add nest-microservices-logger
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2020-11-27 |
| First published | 2020-11-27 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Jason Magpantay |
| Maintainers | jsnmgpnty |

## Links

- npm: https://www.npmjs.com/package/nest-microservices-logger
- Repository: https://github.com/jsnmgpnty/nest-microservices-logger
- Homepage: https://github.com/jsnmgpnty/nest-microservices-logger#readme
- Issues: https://github.com/jsnmgpnty/nest-microservices-logger/issues
- npm.io page: https://npm.io/package/nest-microservices-logger

## Dependencies (14)

- [rxjs](https://npm.io/package/rxjs.md) ^6.5.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [moment](https://npm.io/package/moment.md) ^2.27.0
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [winston](https://npm.io/package/winston.md) ^3.3.3
- [@types/jest](https://npm.io/package/@types/jest.md) 25.2.3
- [@types/node](https://npm.io/package/@types/node.md) ^13.9.1
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^7.0.0
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^7.0.0
- [@types/express](https://npm.io/package/@types/express.md) ^4.17.3
- [@types/supertest](https://npm.io/package/@types/supertest.md) ^2.0.8
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [winston-elasticsearch](https://npm.io/package/winston-elasticsearch.md) ^0.10.0
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) ^7.9.0

## Recent versions

- 0.0.1 (latest) — 2020-11-27

## README

# nest-microservices-logger
- A NestJS module to handle customized logging for `generator-nest-microservices` yeoman template
### How to use
- install package with `npm i -S nest-microservices-logger`
- Register the `LoggerModule` to your feature modules:
```
@Module({})
export class AppModule {
  static register(config: ConfigOptions): DynamicModule {
    return {
      module: AppModule,
      imports: [
        LoggerModule.register({ appName: 'my-app-name' }),
        ...
      ],
    };
  }
}
```
- Once `LoggerModule` is registered, then you can inject the `LoggerService` to your providers and use available `log`, `warn` or `error` functions:
```
export class ExampleController {
  constructor (private logger: LoggerService) {}
  logSomething() {
    this.logger.log('it works!');
  }
}
```
### Logger options
|Property|Type|Required|Description|
|-|-|-|-|
|file|`FileTransportOptions`|false|Winston's file transport options object. More info can be found here https://github.com/winstonjs/winston/blob/master/docs/transports.md#file-transport%7C
|elasticSearch|`ESTransportOptions`|false| contains `{ url, index }` to be used for Elastic Search logging
|console|`ConsoleTransportOptions`|false|Winston's console transport options object. More info can be found here https://github.com/winstonjs/winston/blob/master/docs/transports.md#console-transport%7C
|appName|`String`|true|This is logger's context name|

---
_Source: https://npm.io/package/nest-microservices-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._