Method testDatabase

api/src/services/server.ts:264–323

()

		return this.accountability?.admin === true ? data : { status: data.status };

		async function testDatabase(): Promise<Record<string, ServerHealthCheck[]>> {
			if (enabledServices.includes('database') === false) {
				return {};
			}

			const database = getDatabase();
			const client = env['DB_CLIENT'];

			const checks: Record<string, ServerHealthCheck[]> = {};

			// Response time
			// ----------------------------------------------------------------------------------------
			checks[`${client}:responseTime`] = [
				{
					status: 'ok',
					componentType: 'datastore',
					observedUnit: 'ms',
					observedValue: 0,
					threshold: env['DB_HEALTHCHECK_THRESHOLD'] ? +env['DB_HEALTHCHECK_THRESHOLD'] : 150,
				},
			];

			const startTime = performance.now();

			if (await hasDatabaseConnection()) {
				checks[`${client}:responseTime`]![0]!.status = 'ok';
			} else {
				checks[`${client}:responseTime`]![0]!.status = 'error';
				checks[`${client}:responseTime`]![0]!.output = `Can't connect to the database.`;
			}

			const endTime = performance.now();
			checks[`${client}:responseTime`]![0]!.observedValue = +(endTime - startTime).toFixed(3);

			if (
				Number(checks[`${client}:responseTime`]![0]!.observedValue!) >
					checks[`${client}:responseTime`]![0]!.threshold! &&
				checks[`${client}:responseTime`]![0]!.status !== 'error'
			) {
				checks[`${client}:responseTime`]![0]!.status = 'warn';
			}

			checks[`${client}:connectionsAvailable`] = [
				{
					status: 'ok',
					componentType: 'datastore',
					observedValue: database.client.pool.numFree(),
				},
			];

			checks[`${client}:connectionsUsed`] = [
				{
					status: 'ok',
					componentType: 'datastore',
					observedValue: database.client.pool.numUsed(),
				},
			];