Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nest-x/nestx-log4js
nestjs log4js-node module
https://github.com/nest-x/nestx-log4js
log4js nestjs typescript
Last synced: 18 days ago
JSON representation
nestjs log4js-node module
- Host: GitHub
- URL: https://github.com/nest-x/nestx-log4js
- Owner: nest-x
- License: mit
- Created: 2020-02-24T13:22:53.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-23T14:16:15.000Z (18 days ago)
- Last Synced: 2025-01-23T15:23:49.861Z (18 days ago)
- Topics: log4js, nestjs, typescript
- Language: TypeScript
- Homepage:
- Size: 14.7 MB
- Stars: 29
- Watchers: 2
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nestx-log4js
[](https://github.com/nest-x/nestx-log4js)
[](https://codecov.io/gh/nest-x/nestx-log4js)
[](https://github.com/semantic-release/semantic-release)
Provide log4js module as NestJS module
This is root of `@nestx-log4js` monorepo.
To Get Started, please read [`@nestx-log4js/core` Documentation](./packages/core/)
## Core Module Documentation
`log4js` as NestJS Module.
## Features
- Provide `log4js` wrapper as NestJS Global Module
- Provide `Log4jsLogger` instance for replacement logger usage
## Installation
```shell
yarn add @nestx-log4js/core
```
## Usage
### Just want to use `log4js`?
> Since logger is a special service in NestJS, we suppose
> import `Log4jsModule` and manual call `app.useLogger(app.get(Log4jsLogger))`
**app.module.ts**
```typescript
import { Module } from '@nestjs/common';
import { Log4jsModule } from '@nestx-log4js/core';
@Module({
imports: [
Log4jsModule.forRoot()
]
})
export class AppModule {}
```
**bootstrap.ts**
```typescript
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { Log4jsLogger } from '@nestx-log4js/core';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.useLogger(app.get(Log4jsLogger));
await app.listen(3000);
}
bootstrap();
```
> For more details, you can refer unit tests in source code
### Initial `Log4jsModule` with AsyncOptions (Production Usage)
> You might want to use different appender (e.g. file/dateFile appender)
> in real production usage and initial in your ConfigService/LoggerOnlyConfigService
**app.module.ts**
```typescript
import { Module } from '@nestjs/common';
import { Log4jsModule } from '@nestx-log4js/core';
// import your ConfigService/LoggerConfigService
@Module({
imports: [
Log4js.forRootAsync({
inject: [ConfigService],
useFactory: (config: ConfigService) => config.getLog4jsOptions() // config.getLog4jsOptions should return valid Log4jsOptions
})
]
})
export class AppModule {}
```
## Bundled Layout & Appenders
When using `Log4jsModule.forRoot()` and no spec any appenders and layouts,
It will use default below layouts:
```typescript
export const LOG4JS_DEFAULT_LAYOUT = {
type: 'pattern',
// log4js default pattern %d{yyyy-MM-dd HH:mm:ss:SSS} [%thread] %-5level %logger{36} - %msg%n
// we use process id instead thread id
pattern: '%[%d{yyyy-MM-dd hh:mm:ss:SSS} %p --- [%15.15x{name}]%] %40.40f{3} : %m',
tokens: {
name: (logEvent) => {
return (logEvent.context && logEvent.context['name']) || '-';
}
}
};
export const LOG4JS_NO_COLOUR_DEFAULT_LAYOUT = {
type: 'pattern',
// log4js default pattern %d{yyyy-MM-dd HH:mm:ss:SSS} [%thread] %-5level %logger{36} - %msg%n
// we use process id instead thread id
pattern: '%d{yyyy-MM-dd hh:mm:ss:SSS} %p --- [%15.15x{name}] %40.40f{3} : %m',
tokens: {
name: (logEvent) => {
return (logEvent.context && logEvent.context['name']) || '-';
}
}
};
export const LOG4JS_DEFAULT_CONFIG: Configuration = {
appenders: {
stdout: {
type: 'stdout',
layout: LOG4JS_DEFAULT_LAYOUT
},
file: {
type: 'file',
filename: './logs/application.log',
maxLogSize: 20 * 1024 * 1024, // maxLogSize use bytes ad unit
backups: 10, // default use 5 so 1KB file size total rotating
layout: LOG4JS_NO_COLOUR_DEFAULT_LAYOUT
}
},
categories: {
default: {
enableCallStack: true,
appenders: ['stdout', 'file'],
level: 'debug'
}
}
};
```
It will use default below layouts (from spring boot default log pattern without process id)
You can refer to [SpringBoot logging features](https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-logging.html)
```
2020-11-14 15:47:24:486 INFO --- [ NestJS] core/src/log4js.classes.ts : log using nestjs as category
2020-11-14 15:47:24:486 INFO --- [ -] core/src/log4js.classes.ts : log using none as category
2020-11-14 15:47:24:490 INFO --- [ NestJS] core/src/log4js.classes.ts : log using nestjs as category
2020-11-14 15:47:24:490 WARN --- [ -] src/__tests__/log4js.module.test.ts : log using none as category
```
> Tips: You are using grok pattern via filebeat/other sidecar log agent? You can use below grok pattern:
> %{TIMESTAMP_ISO8601:server_time}\s*%{LOGLEVEL:level}\s*---\s*\[\s*%{NOTSPACE:context}\]\s*%{NOTSPACE:file_path}\s*:\s*%{GREEDYDATA:content}
>
> It will split to friendly format (you can update alias yourself via grok document)
> - server_time
> - level
> - context
> - file_path
> - content