Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aquariuslt/nest-rabbitmq-appender
nestjs rabbitmq appender
https://github.com/aquariuslt/nest-rabbitmq-appender
logger logger-middleware nestjs rabbitmq
Last synced: 11 days ago
JSON representation
nestjs rabbitmq appender
- Host: GitHub
- URL: https://github.com/aquariuslt/nest-rabbitmq-appender
- Owner: aquariuslt
- License: mit
- Created: 2019-09-26T08:27:42.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T06:39:12.000Z (5 months ago)
- Last Synced: 2024-05-28T07:51:54.130Z (5 months ago)
- Topics: logger, logger-middleware, nestjs, rabbitmq
- Language: TypeScript
- Homepage:
- Size: 1.85 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS RabbitMQ Logger Appender
[](https://www.npmjs.com/package/nest-rabbitmq-appender)
[](https://github.com/aquariuslt/nest-rabbitmq-appender)
[](https://codecov.io/gh/aquariuslt/nest-rabbitmq-appender) [](https://github.com/semantic-release/semantic-release)
Provide a rabbitmq logger appender like logback options style.
> Inspired by `spring-amqp` project
> Warning: In Beta
## Usage
### Installation
```shell script
yarn add nest-rabbitmq-appender
```
### Register Module
You should pass an AMQP connection option as register `RabbitmqAppenderModule` options at least with `url` and `queue`.
```typescript
export type RabbitmqAppenderOptions = {
url: string; // rabbitmq connection url
queue: string; // rabbitmq logging queue
} & Partial;
```
```typescript
import { Module } from '@nestjs/common';
import { RabbitmqAppenderModule } from 'nest-rabbitmq-appender';
import { ConfigService } from '@/config/config.service';
import { RemoteLogger } from '@/remote.logger';
@Module({
imports: [
ConfigModule,
RabbitmqAppenderModule.forRootAsync({
inject: [ConfigService],
useFactory: (config: ConfigService) => config.loggingAppenderOptions // config.loggingAppenderOptions suppose be type of `RabbitmqAppenderOptions`
})
]
})
export class AppModule {}
```
### Use RemoteLogger extending NestJS Bundled logger
```typescript
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { RemoteLogger } from 'nest-rabbitmq-appender';
async function bootstrap() {
const app = await NestFactory.create(AppModule, {
logger: false
});
app.useLogger(app.get(RemoteLogger));
await app.listen(3000);
}
bootstrap();
```
### Advanced Usage: Add Customize Data as HookFunction
`RemoteLogger` provided a public function: `setHookFunction(hookFn)` for advanced usage.
Mostly you want to add additional data when sending log data to remote message queue.
Like environment variables set from kubernetes (`POD_ID`,`POD_UID`...), or `NODE_ENV` in node.js application,
or some dynamic value base on runtime status.
You should use an `hookFunction` to create additional properties when send to rabbitmq.
```typescript
function hookFunction(message?:string, context?string){
return {
// calculate and return data according to your business logic
}
}
```
```typescript
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { RemoteLogger } from 'nest-rabbitmq-appender';
async function bootstrap() {
const app = await NestFactory.create(AppModule, {
logger: false
});
const remoteLogger = app.get(RemoteLogger);
const hookFn = () => {
return {
NODE_ENV: process.env.NODE_ENV,
NODE_IP: process.env.NODE_IP,
// or any other data in context, it will merge with origin message
}
};
remoteLogger.setHookFunction(hookFn);
app.useLogger(remoteLogger);
await app.listen(3000);
}
bootstrap();
```