Adding syslog client for backend logs

Author: Shawn-dv

README.md

@@ -355,6 +355,14 @@ ADMIN_WALLET_PRIVATE_KEY='YOUR_ADMIN_WALLET_PRIVATE_KEY'
 # Sets how many times passwords are hashed. Higher values mean stronger security but slower processing
 CRYPTION_SALT=10
 
+# Syslog Server Configuration
+SYSLOG_SERVER_ENABLED='True'
+SYSLOG_SERVER_HOST='192.168.1.100'
+SYSLOG_SERVER_PORT=514
+SYSLOG_SERVER_LEVEL=3
+SYSLOG_SERVER_USERNAME=''
+SYSLOG_SERVER_PASSWORD=''
+
 # Server Configuration
 HOST_PROTOCOL='https://'
 HOST_PORT='6000'

backend/package-lock.json

@@ -61,6 +61,7 @@
         "secure-random-password": "^0.2.3",
         "socket.io": "^4.7.5",
         "swagger-ui-express": "^4.4.0",
+        "syslog-client": "^1.1.1",
         "uuid": "^10.0.0",
         "vm": "^0.1.0",
         "websocket-stream": "^5.5.2",

backend/package.json

@@ -23,6 +23,7 @@ import { UtilityModule } from './modules/utility/utility.module';
 import { MediaModule } from './modules/media/media.module';
 import { AdminModule } from './modules/admin/admin.module';
 import { BuildingModule } from './modules/building/building.module';
+import { SyslogModule } from './modules/logging/syslog.module';
 //import { ScheduleModule } from '@nestjs/schedule';
 
 @Module({
@@ -47,6 +48,7 @@ import { BuildingModule } from './modules/building/building.module';
       serveRoot: '/app/uploads/*',
     }),
     AuthenticationModule,
+    SyslogModule,
     UserModule,
     BrokerModule,
     forwardRef(() => DeviceModule),

backend/src/app.module.ts

@@ -8,10 +8,20 @@ import { Inject, Logger } from '@nestjs/common';
 import { TestService } from './modules/broker/services/test.service';
 import { MqttLogService } from './modules/broker/services/mqtt-log.service';
 import { readFileSync } from 'fs';
+import { SyslogService } from './modules/logging/syslog.service';
 
 async function bootstrap() {
   const app = await NestFactory.create<NestExpressApplication>(AppModule);
 
+  const syslog = app.get(SyslogService);
+
+  console.log = (...args) => {
+    const msg = args
+      .map((a) => (typeof a === 'string' ? a : JSON.stringify(a)))
+      .join(' ');
+    syslog.log(msg);
+  };
+
   const config = new DocumentBuilder()
     .setTitle('FidesInnova')
     .setDescription('The FidesInnova API description')

backend/src/main.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { SyslogService } from './syslog.service';
+
+@Module({
+  imports: [],
+  controllers: [],
+  providers: [SyslogService],
+  exports: [SyslogService],
+})
+export class SyslogModule {}

backend/src/modules/logging/syslog.module.ts

@@ -0,0 +1,47 @@
+import { Injectable } from '@nestjs/common';
+import * as Syslog from 'syslog-client';
+
+@Injectable()
+export class SyslogService {
+  private client: Syslog.Client | null = null;
+  private enabled = false;
+  private username: string;
+  private password: string;
+
+  constructor() {
+    this.enabled = process.env.Syslog_Server_Enabled === 'True';
+    this.username = process.env.Syslog_Server_Username || '';
+    this.password = process.env.Syslog_Server_Password || '';
+
+    if (this.enabled) {
+      this.client = Syslog.createClient(process.env.Syslog_Server_Host, {
+        port: Number(process.env.Syslog_Server_Port || 514),
+        transport: Syslog.Transport.Udp,
+        // auth: {
+        //   username: this.username,
+        //   password: this.password,
+        // },
+      });
+    }
+  }
+
+  log(message: string) {
+    if (!this.client || !this.enabled) return;
+
+    const messageWithUser =
+      this.username && this.password
+        ? `[${this.username}] ${message}`
+        : message;
+
+    this.client.log(
+      messageWithUser,
+      {
+        facility: Syslog.Facility.Local0,
+        severity: Number(process.env.Syslog_Serverl_Level || 3),
+      },
+      (err) => {
+        if (err) console.error('Syslog send error:', err);
+      },
+    );
+  }
+}