@xtreamsrl/winston-gcp-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 GCP Cloud Logging using the @google-cloud/logging-winston package.

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

Installation

npm install @xtreamsrl/winston-gcp-logger

Usage

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

import { WinstonGCPLogger } from '@xtreamsrl/winston-gcp-logger';
import { LoggingModule } from '@xtreamsrl/nest-logging';

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

Configuration

gcpProjectId

The id of the GCP project to send logs to.

gcpLogName

The name of the GCP log group to send logs to.

gcpRedirectToStdout

Boolean flag that opts-in redirecting the output to STDOUT instead of ingesting logs to Cloud Logging using Logging API. Defaults to false. Redirecting logs can be used in Google Cloud environments with installed logging agent to delegate log ingestion to the agent. Redirected logs are formatted as one line Json string following the structured logging guidelines.

level

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

Environment variables

The logger can be configured using environment variables.

DISABLE_CLOUD_LOGGING

Boolean flag that opts-out sending logs to Cloud Logging using Logging API. To be used ONLY in local development environments.

Build

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

Run unit tests

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

Linting

Run nx lint winston-gcp-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