Merge pull request #534 from sivertschou/add-logging

Add logging with winston and Better Stack Logtail

Author: sivertschou

.github/actions/deploy/action.yaml

@@ -17,6 +17,8 @@ inputs:
     type: string
   discord_webhook_url:
     type: string
+  logtail_token:
+    type: string
   mail_host:
     required: true
     type: string
@@ -88,6 +90,7 @@ runs:
           DATABASE_URL=${{ inputs.database_url }} \
           DATABASE_PASSWORD=${{ inputs.database_password }} \
           DISCORD_WEBHOOK_URL=${{ inputs.discord_webhook_url }} \
+          LOGTAIL_TOKEN=${{ inputs.logtail_token }} \
           REDIS_URL=${{ inputs.redis_url }} \
           MAIL_HOST=${{ inputs.mail_host }} \
           MAIL_PORT=${{ inputs.mail_port }} \
@@ -140,6 +143,7 @@ runs:
           DATABASE_URL=${{ inputs.database_url }} \
           DATABASE_PASSWORD=${{ inputs.database_password }} \
           DISCORD_WEBHOOK_URL=${{ inputs.discord_webhook_url }} \
+          LOGTAIL_TOKEN=${{ inputs.logtail_token }} \
           REDIS_URL=${{ inputs.redis_url }} \
           MAIL_HOST=${{ inputs.mail_host }} \
           MAIL_PORT=${{ inputs.mail_port }} \

.github/workflows/build-and-deploy.yaml

@@ -95,6 +95,7 @@ jobs:
           cloudflare_api_key: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           database_password: ${{ secrets.DATABASE_PASSWORD }}
           database_url: ${{ secrets.DATABASE_URL }}
+          logtail_token: ${{ secrets.LOGTAIL_TOKEN }}
           mail_host: ${{ secrets.MAIL_HOST }}
           mail_password: ${{ secrets.MAIL_PASSWORD }}
           mail_port: ${{ secrets.MAIL_PORT }}
@@ -129,6 +130,7 @@ jobs:
           database_password: ${{ secrets.DATABASE_PASSWORD }}
           database_url: ${{ secrets.DATABASE_URL }}
           discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }}
+          logtail_token: ${{ secrets.LOGTAIL_TOKEN }}
           mail_host: ${{ secrets.MAIL_HOST }}
           mail_password: ${{ secrets.MAIL_PASSWORD }}
           mail_port: ${{ secrets.MAIL_PORT }}

apps/backend/package.json

@@ -14,6 +14,8 @@
   "license": "ISC",
   "dependencies": {
     "@dundring/database": "*",
+    "@logtail/node": "^0.5.4",
+    "@logtail/winston": "^0.5.4",
     "@types/multer": "^1.4.12",
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
@@ -23,6 +25,7 @@
     "node-fetch": "^2.6.6",
     "nodemailer": "^6.9.10",
     "redis": "^4.7.0",
+    "winston": "^3.17.0",
     "ws": "^8.18.0"
   },
   "devDependencies": {

apps/backend/src/logger.ts

@@ -0,0 +1,48 @@
+import { Logtail } from '@logtail/node';
+import { LogtailTransport } from '@logtail/winston';
+import winston from 'winston';
+
+require('dotenv').config();
+
+const isProduction = process.env.NODE_ENV === 'production';
+const transports = [];
+
+if (isProduction) {
+  if (process.env.LOGTAIL_TOKEN) {
+    const logtail = new Logtail(process.env.LOGTAIL_TOKEN, {
+      endpoint: 'https://s1307406.eu-nbg-2.betterstackdata.com',
+    });
+    transports.push(new LogtailTransport(logtail));
+  }
+
+  transports.push(
+    new winston.transports.Console({
+      format: winston.format.combine(
+        winston.format.timestamp(),
+        winston.format.json()
+      ),
+    })
+  );
+}
+
+if (!isProduction) {
+  transports.push(
+    new winston.transports.Console({
+      format: winston.format.combine(
+        winston.format.colorize(),
+        winston.format.timestamp({ format: 'HH:mm:ss' }),
+        winston.format.printf(({ timestamp, level, message, ...meta }) => {
+          const metaString = Object.keys(meta).length
+            ? JSON.stringify(meta, null, 2)
+            : '';
+          return `${timestamp} [${level}]: ${message} ${metaString}`;
+        })
+      ),
+    })
+  );
+}
+
+export const logger = winston.createLogger({
+  level: 'debug',
+  transports,
+});

apps/backend/src/redis.ts

@@ -2,6 +2,7 @@ import { Member, Room, Status, WebSocketResponse } from '@dundring/types';
 import { error, hours, isSuccess, success } from '@dundring/utils';
 import { createClient } from 'redis';
 import * as websocket from './websocket';
+import { logger } from './logger';
 
 require('dotenv').config();
 
@@ -13,10 +14,10 @@ const redisClient = createClient({
 });
 const redisPublisher = redisClient.duplicate();
 const redisSubscriber = redisClient.duplicate();
-redisClient.on('error', (err) => console.log('Redis Client Error', err));
+redisClient.on('error', (err) => logger.error('Redis Client Error', err));
 
 export const initRedis = async () => {
-  console.log('Connect redis client');
+  logger.info('Connect redis client');
   await Promise.all([
     redisClient.connect(),
     redisPublisher.connect(),
@@ -34,7 +35,7 @@ const handleRoomMessage = (rawMessage: string, channelName: string) => {
 };
 
 export const createRoom = async (roomId: string, user: Member) => {
-  console.log(
+  logger.info(
     `[redis]: Create room with id=${roomId} for user=${user.username}`
   );
   await Promise.all([
@@ -47,7 +48,7 @@ export const joinRoom = async (
   roomId: string,
   user: Member
 ): Promise<Status<Room, 'Room not found'>> => {
-  console.log(`[redis]: Add user=${user.username} to room with id=${roomId}`);
+  logger.info(`[redis]: Add user=${user.username} to room with id=${roomId}`);
   const roomKey = toRoomKey(roomId);
   // TODO: Make atomic/transaction
   const usersInRoom = await redisClient.lLen(roomKey);
@@ -71,7 +72,7 @@ export const leaveRoom = async (
   roomId: string
 ): Promise<Status<number, 'Room not found'>> => {
   const roomKey = toRoomKey(roomId);
-  console.log(`[redis]: Remove user=${username} from room with id=${roomId}`);
+  logger.info(`[redis]: Remove user=${username} from room with id=${roomId}`);
 
   await Promise.all([
     redisClient.lRem(roomKey, 0, username),

apps/backend/src/server.ts

@@ -6,6 +6,7 @@ import http from 'http';
 import { initRedis } from './redis';
 import { initWebsockets } from './websocket';
 import router from './routes';
+import { logger } from './logger';
 
 require('dotenv').config();
 
@@ -56,4 +57,5 @@ initRedis();
 
 httpServer.listen(httpPort, () => {
   console.log(`App is listening on port ${httpPort}!:)`);
+  logger.info(`App is listening on port ${httpPort}!:)`);
 });

apps/backend/src/services/groupSessionService.ts

@@ -12,6 +12,7 @@ import { generateRandomString, isSuccess } from '@dundring/utils';
 import { monitoringService } from '.';
 import * as redis from '../redis';
 import * as websocket from '../websocket';
+import { logger } from '../logger';
 
 export const sendWorkoutDataToRoom = (
   username: string,
@@ -69,13 +70,13 @@ export const createRoom = async (
   const roomId = await getAvailableRoomId();
   console.log('roomId:', roomId);
   if (roomId === null) {
-    console.log(`${user.username} failed to create room.`);
+    logger.error(`${user.username} failed to create room.`);
     return {
       type: 'failed-to-create-group-session',
       message: 'Failed to create room.',
     };
   } else {
-    console.log(
+    logger.info(
       `${user.username} created room #${roomId}. Add to connection pool`
     );
 
@@ -90,7 +91,7 @@ export const createRoom = async (
 };
 
 export const joinRoom = async (roomId: string, member: Member) => {
-  console.log(
+  logger.info(
     `${member.username} tries to join ${roomId}. Add to connection pool`
   );
   const joinRoomResponse = await redis.joinRoom(roomId, member);

apps/backend/src/websocket.ts

@@ -3,6 +3,7 @@ import { WebSocketServer, WebSocket } from 'ws';
 import { groupSessionService } from './services';
 import * as redis from './redis';
 import { error, isSuccess, success } from '@dundring/utils';
+import { logger } from './logger';
 
 const connections: { [username: string]: WebSocket } = {};
 
@@ -44,7 +45,7 @@ export const initWebsockets = (webSocketServer: WebSocketServer) => {
         }
         case 'send-data': {
           if (!username) {
-            console.log('unknown tried to share workoutdata');
+            logger.warn('unknown tried to share workoutdata');
             return;
           }
           groupSessionService.sendWorkoutDataToRoom(username, req.data);
@@ -53,7 +54,7 @@ export const initWebsockets = (webSocketServer: WebSocketServer) => {
       }
     });
     ws.on('close', () => {
-      console.log('connection closed', username);
+      logger.info('connection closed', username);
       if (username && roomId) {
         groupSessionService.leaveRoom(username, roomId);
         username = '';
@@ -82,7 +83,7 @@ export const sendMessageToRoom = async (
       .filter((socket) => socket)
       .map((socket) => socket.send(JSON.stringify(message)));
   } else {
-    console.log(`[websocket]: Could not send message to room ${roomId}`);
+    logger.error(`[websocket]: Could not send message to room ${roomId}`);
   }
 };
 
@@ -95,7 +96,7 @@ export const sendMessage = (
     socket.send(JSON.stringify(message));
     return success({});
   } else {
-    console.log(
+    logger.error(
       `[websocket]: Socket not found for username ${recipientUsername}`
     );
     return error('Socket not found for username');

docker/deploy/docker-compose.yaml

@@ -27,6 +27,7 @@ services:
       - POD=green
       - TAG=${TAG_GREEN}
       - NODE_ENV=production
+      - LOGTAIL_TOKEN=${LOGTAIL_TOKEN}
     networks:
       - caddy
       - dundring
@@ -80,6 +81,7 @@ services:
       - POD=blue
       - TAG=${TAG_BLUE}
       - NODE_ENV=production
+      - LOGTAIL_TOKEN=${LOGTAIL_TOKEN}
     networks:
       - caddy
       - dundring