sharkey/packages/backend/src/server/api/endpoints/admin/server-info.ts

import * as os from 'os';
import * as si from 'systeminformation';
import { getConnection } from 'typeorm';
import define from '../../define';
import { redisClient } from '../../../../db/redis';

export const meta = {
	requireCredential: true as const,
	requireModerator: true,

	tags: ['admin', 'meta'],

	params: {
	},

	res: {
		type: 'object' as const,
		optional: false as const, nullable: false as const,
		properties: {
			machine: {
				type: 'string' as const,
				optional: false as const, nullable: false as const,
			},
			os: {
				type: 'string' as const,
				optional: false as const, nullable: false as const,
				example: 'linux',
			},
			node: {
				type: 'string' as const,
				optional: false as const, nullable: false as const,
			},
			psql: {
				type: 'string' as const,
				optional: false as const, nullable: false as const,
			},
			cpu: {
				type: 'object' as const,
				optional: false as const, nullable: false as const,
				properties: {
					model: {
						type: 'string' as const,
						optional: false as const, nullable: false as const,
					},
					cores: {
						type: 'number' as const,
						optional: false as const, nullable: false as const,
					},
				},
			},
			mem: {
				type: 'object' as const,
				optional: false as const, nullable: false as const,
				properties: {
					total: {
						type: 'number' as const,
						optional: false as const, nullable: false as const,
						format: 'bytes',
					},
				},
			},
			fs: {
				type: 'object' as const,
				optional: false as const, nullable: false as const,
				properties: {
					total: {
						type: 'number' as const,
						optional: false as const, nullable: false as const,
						format: 'bytes',
					},
					used: {
						type: 'number' as const,
						optional: false as const, nullable: false as const,
						format: 'bytes',
					},
				},
			},
			net: {
				type: 'object' as const,
				optional: false as const, nullable: false as const,
				properties: {
					interface: {
						type: 'string' as const,
						optional: false as const, nullable: false as const,
						example: 'eth0',
					},
				},
			},
		},
	},
};

// eslint-disable-next-line import/no-default-export
export default define(meta, async () => {
	const memStats = await si.mem();
	const fsStats = await si.fsSize();
	const netInterface = await si.networkInterfaceDefault();

	return {
		machine: os.hostname(),
		os: os.platform(),
		node: process.version,
		psql: await getConnection().query('SHOW server_version').then(x => x[0].server_version),
		redis: redisClient.server_info.redis_version,
		cpu: {
			model: os.cpus()[0].model,
			cores: os.cpus().length,
		},
		mem: {
			total: memStats.total,
		},
		fs: {
			total: fsStats[0].size,
			used: fsStats[0].used,
		},
		net: {
			interface: netInterface,
		},
	};
});