feat: Count daily and monthly peaks of concurrent connections (#30573)

.changeset/perfect-pianos-yawn.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/presence': minor
+---
+
+Add peak connections monitoring and methods to get and reset the counter

.changeset/slow-coats-shout.md

@@ -0,0 +1,7 @@
+---
+"@rocket.chat/meteor": minor
+---
+
+Add the daily and monthly peaks of concurrent connections to statistics
+ - Added `dailyPeakConnections` statistic for monitoring the daily peak of concurrent connections in a workspace;
+ - Added `maxMonthlyPeakConnections` statistic for monitoring the last 30 days peak of concurrent connections in a workspace;

apps/meteor/app/statistics/server/lib/statistics.ts

@@ -1,7 +1,7 @@
 import { log } from 'console';
 import os from 'os';
 
-import { Analytics, Team, VideoConf } from '@rocket.chat/core-services';
+import { Analytics, Team, VideoConf, Presence } from '@rocket.chat/core-services';
 import type { IRoom, IStats } from '@rocket.chat/core-typings';
 import { UserStatus } from '@rocket.chat/core-typings';
 import {
@@ -579,6 +579,11 @@ export const statistics = {
 		const defaultLoggedInCustomScript = (await Settings.findOneById('Custom_Script_Logged_In'))?.packageValue;
 		statistics.loggedInCustomScriptChanged = settings.get('Custom_Script_Logged_In') !== defaultLoggedInCustomScript;
 
+		statistics.dailyPeakConnections = await Presence.getPeakConnections(true);
+
+		const peak = await Statistics.findMonthlyPeakConnections();
+		statistics.maxMonthlyPeakConnections = Math.max(statistics.dailyPeakConnections, peak?.dailyPeakConnections || 0);
+
 		statistics.matrixFederation = await getMatrixFederationStatistics();
 
 		// Omnichannel call stats

apps/meteor/client/views/admin/info/DeploymentCard.stories.tsx

@@ -272,6 +272,8 @@ export default {
 			totalWebRTCCalls: 0,
 			uncaughtExceptionsCount: 0,
 			push: 0,
+			dailyPeakConnections: 0,
+			maxMonthlyPeakConnections: 0,
 			matrixFederation: {
 				enabled: false,
 			},

apps/meteor/client/views/admin/info/InformationPage.stories.tsx

@@ -302,6 +302,8 @@ export default {
 			totalWebRTCCalls: 0,
 			uncaughtExceptionsCount: 0,
 			push: 0,
+			dailyPeakConnections: 0,
+			maxMonthlyPeakConnections: 0,
 			matrixFederation: {
 				enabled: false,
 			},

apps/meteor/client/views/admin/info/UsageCard.stories.tsx

@@ -250,6 +250,8 @@ export default {
 			totalWebRTCCalls: 0,
 			uncaughtExceptionsCount: 0,
 			push: 0,
+			dailyPeakConnections: 0,
+			maxMonthlyPeakConnections: 0,
 			matrixFederation: {
 				enabled: false,
 			},

apps/meteor/server/cron/statistics.ts

@@ -37,5 +37,7 @@ export async function statsCron(logger: Logger): Promise<void> {
 
 	const now = new Date();
 
-	await cronJobs.add(name, `12 ${now.getHours()} * * *`, async () => generateStatistics(logger));
+	await cronJobs.add(name, `12 ${now.getHours()} * * *`, async () => {
+		await generateStatistics(logger);
+	});
 }

apps/meteor/server/models/raw/Statistics.ts

@@ -25,4 +25,25 @@ export class StatisticsRaw extends BaseRaw<IStats> implements IStatisticsModel {
 		).toArray();
 		return records?.[0];
 	}
+
+	async findMonthlyPeakConnections() {
+		const oneMonthAgo = new Date();
+		oneMonthAgo.setDate(oneMonthAgo.getDate() - 30);
+		oneMonthAgo.setHours(0, 0, 0, 0);
+
+		return this.findOne<Pick<IStats, 'dailyPeakConnections' | 'createdAt'>>(
+			{
+				createdAt: { $gte: oneMonthAgo },
+			},
+			{
+				sort: {
+					dailyPeakConnections: -1,
+				},
+				projection: {
+					dailyPeakConnections: 1,
+					createdAt: 1,
+				},
+			},
+		);
+	}
 }

ee/packages/presence/src/Presence.ts

@@ -19,6 +19,8 @@ export class Presence extends ServiceClass implements IPresence {
 
 	private connsPerInstance = new Map<string, number>();
 
+	private peakConnections = 0;
+
 	constructor() {
 		super();
 
@@ -35,6 +37,7 @@ export class Presence extends ServiceClass implements IPresence {
 			if (diff?.hasOwnProperty('extraInformation.conns')) {
 				this.connsPerInstance.set(id, diff['extraInformation.conns']);
 
+				this.peakConnections = Math.max(this.peakConnections, this.getTotalConnections());
 				this.validateAvailability();
 			}
 		});
@@ -251,4 +254,16 @@ export class Presence extends ServiceClass implements IPresence {
 	private getTotalConnections(): number {
 		return Array.from(this.connsPerInstance.values()).reduce((acc, conns) => acc + conns, 0);
 	}
+
+	getPeakConnections(reset = false): number {
+		const peak = this.peakConnections;
+		if (reset) {
+			this.resetPeakConnections();
+		}
+		return peak;
+	}
+
+	resetPeakConnections(): void {
+		this.peakConnections = 0;
+	}
 }

packages/core-services/src/types/IPresence.ts

@@ -19,4 +19,6 @@ export interface IPresence extends IServiceClass {
 	updateUserPresence(uid: string): Promise<void>;
 	toggleBroadcast(enabled: boolean): void;
 	getConnectionCount(): { current: number; max: number };
+	getPeakConnections(reset?: boolean): number;
+	resetPeakConnections(): void;
 }

packages/core-typings/src/IStats.ts

@@ -219,6 +219,8 @@ export interface IStats {
 	totalWebRTCCalls: number;
 	uncaughtExceptionsCount: number;
 	push: number;
+	dailyPeakConnections: number;
+	maxMonthlyPeakConnections: number;
 	matrixFederation: {
 		enabled: boolean;
 	};

packages/model-typings/src/models/IStatisticsModel.ts

@@ -4,4 +4,5 @@ import type { IBaseModel } from './IBaseModel';
 
 export interface IStatisticsModel extends IBaseModel<IStats> {
 	findLast(): Promise<IStats>;
+	findMonthlyPeakConnections(): Promise<Pick<IStats, 'dailyPeakConnections' | 'createdAt'> | null>;
 }