@xtreamsrl/winston-aws-logger

This package exports a logger adapter of the LoggerPort interface from the @xtreamsrl/nest-logging package.

This adapter is mainly thought to be used along with the @xtreamsrl/nest-logging package, but it could be used as a standalone logger.

The logger uses the winston package and is configured to send logs to AWS Cloudwatch using the winston-cloudwatch package.

Based on env configuration option it can also send logs to stdout console in a non production environment.

Installation

npm install @xtreamsrl/winston-aws-logger

Usage

Provide the WinstonAWSLogger as the LoggerAdapter provider in the @xtreamsrl/nest-logging module configuration. Due to the configuration required, you must provide a factory provider for the WinstonAWSLogger class.

import { WinstonAWSLogger } from '@xtreamsrl/winston-aws-logger';
import { LoggingModule } from '@xtreamsrl/nest-logging';

@Module({
  imports: [
    LoggingModule.forRoot({
      context: 'root',
      global: true,
      loggerAdapter: {
        useFactory: () => new WinstonAWSLogger({
          ...
        }),
      },
      enableTracingIntegration: true,
      enableLoggerInterceptor: false,
    })
  ],
  controllers: [],
  providers: [],
})
export class AppModule {
}

Configuration

env

The environment where the application is running.

awsRegion

The AWS region where the logs will be sent.

logGroupName

The name of the log group where the logs will be sent.

level

The minimum level of logs accepted by the logger. Optional, defaults to debug.

Build

Run nx build winston-aws-logger to build the package.

Running unit tests

Run nx test winston-aws-logger to execute the unit tests via Jest.

Linting

Run nx lint winston-aws-logger to execute the lint via ESLint.

Versioning

Export the GH_TOKEN environment variable with your GitHub token with at least the repo scope:

export GH_TOKEN=<YOUR_PERSONAL_GH_TOKEN>

Then run the following command:

lerna version

The GH_TOKEN is needed to push the version commit and tag to the remote repository and to create the release on GitHub.

For general information about the versioning process, please refer to the root Readme Versioning section.

Publishing

Update your local .npmrc file to include the following lines:

@xtreamsrl:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}

The ${NPM_TOKEN} placeholder is a npm personal access token publish permissions on the @xtreamsrl organization. It can be treated as placeholder to replace with the actual token value, or you can set it as an environment variable:

export NPM_TOKEN=<YOUR_PERSONAL_NPM_TOKEN>

Then run the following command:

npm run lerna-publish

Who we are