@gus-eip/loggers v4.0.9

@gus-eip/loggers

Overview

@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications. It offers integration with various logging services, including CloudWatchLogger.

Installation

You can install the package via npm:

npm install @gus-eip/loggers

Usage

To use the logger module in your application, follow these steps:

1. Import LoggerModule from @gus-eip/loggers inside your module.

import { LoggerModule } from '@gus-eip/loggers';

2. Configure LoggerModule in your module by calling the forRoot method.

LoggerModule.forRoot({
  region: process.env.REGION,
  logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
  options: 'CloudWatchLogger',
}),

Ensure you provide the necessary environment variables (REGION and LOGGER_LOG_GROUP_NAME) for configuration.

Configuration Options

• region: The AWS region where your CloudWatch logs are located.
• logGroupName: The name of the log group where logs will be sent.
• options: The options for the logger. Currently, only 'CloudWatchLogger' is supported.

Example

import { Module } from '@nestjs/common';
import { LoggerModule } from '@gus-eip/loggers';

@Module({
  imports: [
    LoggerModule.forRoot({
      region: process.env.REGION,
      logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
      options: 'CloudWatchLogger',
    }),
  ],
})
export class AppModule {}

This repository requires AWS SSM Parameter Store access to retrieve the SQS URL dynamically. Ensure that the application has permission to read LOGGER_SQS_URL.

License

This project is licensed under the MIT License - see the LICENSE file for details.

OAP-EIP LOGGER

Whenever a new use case is added in the enum.ts file, make sure to also:

1. Add a user-friendly label for it in usecase-mapping.ts.

2. Add a new entry in source-destination-mapping.ts with the correct usecase, brand, source, and destination.

3. After publishing the updated package, update the dependency in the gus-eip-analytics repository to reflect the latest version.

Feel free to customize this README according to your specific package features, usage guidelines, and licensing terms.