Replace winston with pino

Author: Matija Petrunic

.env.sample

@@ -19,8 +19,5 @@ BACKEND_LOCAL_PORT=3000
 DB_CONTAINER_NAME=fastify-starter-db
 DB_LOCAL_PORT=5432
 METRICS_IP_WHITELIST=*
-# Winston-loki default url is empty
-# WINSTON_LOKI_URL=
-# WINSTON_LOKI_BASIC_AUTH=
-# WINSTON_LOKI_APP_NAME=myApp
-# WINSTON_LOKI_BATCHING=false
+# By default prints to stdout
+# LOG_FILE = <file_location>

docker-compose.yml

@@ -13,7 +13,7 @@ services:
           - .:/usr/app
           - node_modules:/usr/app/node_modules
     ports:
-          - "${BACKEND_LOCAL_PORT:-3000}:${SERVER_PORT:-3000}"
+          - "${BACKEND_LOCAL_PORT:-3001}:${SERVER_PORT:-3000}"
           - "${DEBUG_PORT:-56745}:56745"
   db:
     image: postgres:9.6-alpine
@@ -29,4 +29,3 @@ services:
 volumes:
   node_modules:
   postgres:
-

package.json

@@ -54,13 +54,16 @@
     "node-cleanup": "^2.1.2",
     "pg": "^8.5.1",
     "pg-native": "^3.0.0",
+    "pino": "^6.11.3",
+    "pino-pretty": "^5.0.1",
     "typeorm": "^0.2.30",
-    "typeorm-seeding": "^1.6.1",
-    "winston-loki": "6.0.0-rc.9"
+    "typeorm-seeding": "^1.6.1"
   },
   "devDependencies": {
     "@types/chai": "^4.2.14",
     "@types/faker": "^5.1.5",
+    "@types/pino": "^6.3.8",
+    "@types/pino-pretty": "^4.7.0",
     "@types/mocha": "^8.2.0",
     "@types/node": "^14.14.22",
     "@types/node-cleanup": "^2.1.1",

src/App.ts

@@ -14,7 +14,6 @@ import { Connection } from "typeorm";
 import { config as envPluginConfig } from "./config";
 import { getDatabaseConnection } from "./services/db";
 import { logger } from "./services/logger";
-import { fastifyLogger } from "./services/logger/fastify";
 import { routesPlugin } from "./services/plugins/routes";
 import { SWAGGER_CONFIG } from "./services/swagger";
 export class App {
@@ -30,7 +29,7 @@ export class App {
    */
   public static async init(): Promise<App> {
     const instance = fastify({
-      logger: fastifyLogger,
+      logger: logger,
       return503OnClosing: true,
     });
     const app = new App(instance);

src/controllers/sample.ts

@@ -1,14 +1,14 @@
 import { SampleRepository } from "../repositories/sample";
 import { ApiController } from "../services/fastify-types";
-import { logger } from "../services/logger";
 
 interface GetQuery {
   name?: string;
 }
 
 export const get: ApiController<GetQuery> = {
   handler: async function (request, reply) {
-    logger.info("Fetching samples", { requestId: request.id });
+    request.log.info("Fetching samples");
+
     const sampleRepository = this.db.getCustomRepository(SampleRepository);
     if (request.query.name) {
       reply.send(await sampleRepository.findByName(request.query.name));

src/services/logger/fastify.ts

@@ -1,53 +1,17 @@
-import winston from "@nodefactory/winston";
-import LokiTransport from "winston-loki";
-import Transports from "winston-transport";
+import pino from "pino";
 
-const format = winston.format.printf(
-  ({ level, message, labels, timestamp, requestId }) => {
-    message = winston.format
-      .colorize({ all: false, message: true })
-      .colorize(level, message);
-    let log = `${timestamp} [${
-      labels.module
-    }] ${level.toUpperCase()}: ${message}`;
-    if (requestId) {
-      log += " RequestId: " + requestId;
-    }
-    return log;
-  }
-);
+export let logger: pino.Logger;
 
-const transportsConfig: Transports[] = [
-  new winston.transports.Console({
-    format: winston.format.combine(
-      winston.format.timestamp(),
-      winston.format.align(),
-      format
-    ),
-  }),
-];
-
-if (process.env.WINSTON_LOKI_URL) {
-  transportsConfig.push(
-    new LokiTransport({
-      host: process.env.WINSTON_LOKI_URL,
-      batching: process.env.WINSTON_LOKI_BATCHING == "true",
-      basicAuth: process.env.WINSTON_LOKI_BASIC_AUTH ?? undefined,
-      labels: {
-        app: process.env.WINSTON_LOKI_APP_NAME ?? "",
-      },
-    })
+if (process.env.LOG_FILE) {
+  logger = pino({
+    level: process.env.LOG_LEVEL || "debug",
+  });
+} else {
+  logger = pino(
+    {
+      level: process.env.LOG_LEVEL || "debug",
+      prettyPrint: true,
+    },
+    process.stdout
   );
 }
-
-export const logger = winston.createLogger({
-  level: process.env.LOG_LEVEL || "debug",
-
-  format: winston.format.json({}),
-  defaultMeta: {
-    labels: {
-      module: "default",
-    },
-  },
-  transports: transportsConfig,
-});

src/services/logger/index.ts

@@ -1,10 +1,10 @@
-import { Logger as WinstonLogger } from "@nodefactory/winston";
+import pino from "pino";
 import { Logger } from "typeorm";
 
 import { logger } from "./index";
 
 export class TypeOrmLogger implements Logger {
-  private readonly logger: WinstonLogger;
+  private readonly logger: pino.Logger;
 
   constructor() {
     this.logger = logger.child({ label: "database" });

src/services/logger/typeorm.ts

@@ -6,11 +6,11 @@ import { app } from "./app-setup";
 
 describe("Sample e2e test", function () {
   beforeEach(async function () {
-    logger.silent = true;
+    logger.level = "silent";
   });
 
   afterEach(async function () {
-    logger.silent = false;
+    logger.level = "silent";
   });
 
   it("Should successfully query database", async function () {

test/e2e/sample.spec.ts

@@ -15,7 +15,7 @@ describe("sample controller", function () {
   let sampleRepositoryStub: SinonStubbedInstance<SampleRepository>;
 
   beforeEach(async function () {
-    logger.silent = true;
+    logger.level = "silent";
     app = await App.init();
     sampleRepositoryStub = sinon.createStubInstance(SampleRepository);
     app.instance.decorate("db", {
@@ -24,7 +24,7 @@ describe("sample controller", function () {
   });
 
   afterEach(async function () {
-    logger.silent = false;
+    logger.level = "silent";
   });
 
   it("get samples", async function () {