Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

perf(backend:server): lower default workers from 2 to 1 to optimize memory usage on small systems (e.g. Raspberry Pi)

johaven9cffde83435f
diff --git a/backend/src/app.service.ts b/backend/src/app.service.ts
index 77c154fd..3b7819d2 100755
--- a/backend/src/app.service.ts
+++ b/backend/src/app.service.ts
@@ -7,6 +7,7 @@
import { Injectable, Logger } from '@nestjs/common'
import { setupPrimary } from '@socket.io/cluster-adapter'
import cluster, { Worker } from 'node:cluster'
+import { cpus } from 'node:os'
import process from 'node:process'
import { configuration } from './configuration/config.environment'
import { SCHEDULER_ENV, SCHEDULER_STATE } from './infrastructure/scheduler/scheduler.constants'
@@ -22,21 +23,21 @@ export class AppService {
// setup connections between the workers
setupPrimary()
}
- AppService.logger.log(`CPU cores : ${configuration.server.workers}`)
- AppService.logger.log(`Master server started on ${process.pid}`)
+ AppService.logger.log(`Workers: ${configuration.server.workers} / CPU cores: ${cpus().length}`)
+ AppService.logger.log(`[Master:${process.pid}] started`)
for (let i = 0; i < configuration.server.workers; i++) {
AppService.forkProcess(i === configuration.server.workers - 1)
}
cluster.on('exit', (worker: Worker, code: number, signal: string) => {
- AppService.logger.log(`Worker ${worker.process.pid} (code: ${code}, signal: ${signal}) died.`)
+ AppService.logger.log(`[Worker:${worker.process.pid}] (code: ${code}, signal: ${signal}) died.`)
if (configuration.server.restartOnFailure) {
const isScheduler = worker.process.pid === AppService.schedulerPID
- AppService.logger.log(`Restarting ${isScheduler ? `(with Scheduler)` : ''}...`)
+ AppService.logger.log(`[Worker:${worker.process.pid}] restarting ${isScheduler ? `(with Scheduler)` : ''}...`)
AppService.forkProcess(isScheduler)
}
})
} else {
- AppService.logger.log(`Cluster server started on ${process.pid}`)
+ AppService.logger.log(`[Worker:${process.pid}] started`)
bootstrap()
}
}
@@ -45,7 +46,7 @@ export class AppService {
const w: Worker = cluster.fork({ [SCHEDULER_ENV]: isScheduler ? SCHEDULER_STATE.ENABLED : SCHEDULER_STATE.DISABLED })
if (isScheduler) {
AppService.schedulerPID = w.process.pid
- AppService.logger.log(`Scheduler enabled on Worker ${w.process.pid}`)
+ AppService.logger.log(`[Worker:${w.process.pid}] Scheduler role enabled`)
}
}
}
diff --git a/backend/src/configuration/config.validation.ts b/backend/src/configuration/config.validation.ts
index da6c2c4d..c137bf1b 100644
--- a/backend/src/configuration/config.validation.ts
+++ b/backend/src/configuration/config.validation.ts
@@ -38,10 +38,10 @@ export class ServerConfig {
@Max(65535)
port: number = 8080
- @Transform(({ value }) => (value === 0 || value === 'auto' ? cpus().length : Math.max(Number(value), 2)))
+ @Transform(({ value }) => (value === 0 || value === 'auto' ? cpus().length : Math.max(Number(value), 1)))
@IsInt()
- @Min(2)
- workers: number = 2
+ @Min(1)
+ workers: number = 1
@IsOptional()
trustProxy: boolean | string | number = 1
diff --git a/environment/environment.dist.yaml b/environment/environment.dist.yaml
index 171b41b1..6f510ee2 100755
--- a/environment/environment.dist.yaml
+++ b/environment/environment.dist.yaml
@@ -3,9 +3,9 @@ server:
host: 0.0.0.0
# default port : `8080`
port: 8080
- # workers: `auto` (use all cpus) | number
- # regardless of the value, starts with at least 2 workers, 1 worker is dedicated to scheduled tasks
- workers: 2
+ # workers: `auto` or `0` (use all cpus) | number of CPUs to use
+ # default: 1
+ workers: 1
# trust proxy: number (trust the nth hop from the front-facing proxy server as the client) | `true` | `false` | `127.0.0.1,192.168.1.1/24`
# default: 1
trustProxy: 1