Files
Checkmate/server/src/services/business/MonitorService.ts
T

902 lines
26 KiB
TypeScript

import mongoose from "mongoose";
import { IMonitor, Monitor, MonitorStats, Check } from "@/db/models/index.js";
import { StatsHourly, StatsDaily } from "@/db/models/index.js";
import ApiError from "@/utils/ApiError.js";
import { IJobQueue } from "@/services/infrastructure/JobQueue.js";
import { MonitorWithChecksResponse } from "@/types/index.js";
import { MonitorStatus, MonitorType } from "@/db/models/monitors/Monitor.js";
import { Entitlements } from "@/types/entitlements.js";
import { getStartDate } from "@/utils/TimeUtils.js";
import { IMonitorRepository } from "@/repositories/index.js";
import type { Monitor as MonitorEntity } from "@/types/domain/index.js";
export interface IImportedMonitor {
name: string;
type: MonitorType;
interval: number;
url: string;
n: number;
}
export enum MonitorImportCode {
OK = "OK",
PARTIAL = "PARTIAL",
NO_CAPACITY = "NO_CAPACITY",
UNEXPECTED = "UNEXPECTED",
}
export interface MonitorImportResult {
ok: boolean;
status: number;
code: MonitorImportCode;
attempted: number;
eligible: number;
imported: number;
errors: number;
message?: string;
}
const SERVICE_NAME = "MonitorService";
export interface IMonitorService {
create: (
orgId: string,
userId: string,
currentTeamId: string,
monitorData: MonitorEntity
) => Promise<MonitorEntity>;
getAll: (teamId: string) => Promise<MonitorEntity[]>;
getAllEmbedChecks: (
teamId: string,
search: string,
sortField: string,
sortOrder: string,
page: number,
limit: number,
type: MonitorType[],
status: MonitorStatus[]
) => Promise<{
count: number;
upCount: number;
downCount: number;
pausedCount: number;
monitors: any[];
}>;
get: (teamId: string, monitorId: string) => Promise<MonitorEntity>;
getEmbedChecks: (
teamId: string,
monitorId: string,
range: string
) => Promise<MonitorWithChecksResponse>;
togglePause: (
userId: string,
teamId: string,
monitorId: string
) => Promise<MonitorEntity>;
update: (
userId: string,
teamId: string,
monitorId: string,
updateData: Partial<MonitorEntity>
) => Promise<MonitorEntity>;
delete: (teamId: string, monitorId: string) => Promise<boolean>;
deleteAllInOrg: (orgId: string) => Promise<boolean>;
export: (teamId: string) => Promise<Array<Record<string, unknown>>>;
import: (
orgId: string,
teamId: string,
userId: string,
entitlements: Entitlements,
data: { monitors: Array<IImportedMonitor> }
) => Promise<MonitorImportResult>;
}
class MonitorService implements IMonitorService {
public SERVICE_NAME: string;
private jobQueue: IJobQueue;
private monitorRepository: IMonitorRepository;
constructor(jobQueue: IJobQueue, monitorRepository: IMonitorRepository) {
this.SERVICE_NAME = SERVICE_NAME;
this.jobQueue = jobQueue;
this.monitorRepository = monitorRepository;
}
create = async (
orgId: string,
userId: string,
currentTeamId: string,
monitorData: MonitorEntity
) => {
const monitor = await this.monitorRepository.create(
orgId,
userId,
currentTeamId,
monitorData
);
await MonitorStats.create({
monitorId: monitor.id,
currentStreakStartedAt: Date.now(),
});
await this.jobQueue.addJob(monitor);
return monitor;
};
getAll = async (teamId: string) => {
return await this.monitorRepository.findByTeamId(teamId);
};
getAllEmbedChecks = async (
teamId: string,
search: string,
sortField: string,
sortOrder: string,
page: number,
rowsPerPage: number,
type: MonitorType[] = [],
status: MonitorStatus[] = []
) => {
const counts = await this.monitorRepository.findMonitorCountsByTeamId(
teamId
);
const monitors = await this.monitorRepository.findByTeamIdWithConfig(
teamId,
{
search,
sortField,
sortOrder,
page,
rowsPerPage,
type,
status,
}
);
const monitorIds = monitors.map((m) => new mongoose.Types.ObjectId(m.id));
const checks = await Check.aggregate([
{
$match: {
"metadata.monitorId": { $in: monitorIds },
},
},
{ $sort: { createdAt: -1 } },
{
$group: {
_id: "$metadata.monitorId",
latestChecks: { $push: "$$ROOT" },
},
},
{
$project: {
latestChecks: { $slice: [{ $ifNull: ["$latestChecks", []] }, 25] },
},
},
]);
const checksMap = new Map(
checks.map((c: any) => [c._id.toString(), c.latestChecks])
);
return {
count: counts.total,
upCount: counts.upCount,
downCount: counts.downCount,
pausedCount: counts.pausedCount,
monitors,
checksMap: Object.fromEntries(checksMap),
};
};
get = async (teamId: string, monitorId: string) => {
const monitor = await this.monitorRepository.findById(monitorId, teamId);
if (!monitor) {
throw new ApiError("Monitor not found", 404);
}
return monitor;
};
private getBaseGroup = (): Record<string, any> => {
return {
_id: { $dateTrunc: { date: "$createdAt", unit: "minute" } },
count: { $sum: 1 },
avgResponseTime: { $avg: "$responseTime" },
};
};
private getBaseProjection = (): object => {
return { status: 1, responseTime: 1, createdAt: 1 };
};
private getPageSpeedGroup = (): Record<string, any> => {
return {
_id: { $dateTrunc: { date: "$createdAt", unit: "minute" } },
count: { $sum: 1 },
avgResponseTime: { $avg: "$responseTime" },
accessibility: { $avg: "$lighthouse.accessibility" },
bestPractices: { $avg: "$lighthouse.bestPractices" },
seo: { $avg: "$lighthouse.seo" },
performance: { $avg: "$lighthouse.performance" },
cls: { $avg: "$lighthouse.audits.cls.score" },
si: { $avg: "$lighthouse.audits.si.score" },
fcp: { $avg: "$lighthouse.audits.fcp.score" },
lcp: { $avg: "$lighthouse.audits.lcp.score" },
tbt: { $avg: "$lighthouse.audits.tbt.score" },
};
};
private getPageSpeedProjection = (): object => {
const projectStage: any = { status: 1, responseTime: 1, createdAt: 1 };
projectStage["lighthouse.accessibility"] = 1;
projectStage["lighthouse.seo"] = 1;
projectStage["lighthouse.bestPractices"] = 1;
projectStage["lighthouse.performance"] = 1;
projectStage["lighthouse.audits.cls.score"] = 1;
projectStage["lighthouse.audits.si.score"] = 1;
projectStage["lighthouse.audits.fcp.score"] = 1;
projectStage["lighthouse.audits.lcp.score"] = 1;
projectStage["lighthouse.audits.tbt.score"] = 1;
return projectStage;
};
private getInfraGroup = (): Record<string, any> => {
return {
_id: { $dateTrunc: { date: "$createdAt", unit: "minute" } },
count: { $sum: 1 },
avgResponseTime: { $avg: "$responseTime" },
physicalCores: { $last: "$system.cpu.physical_core" },
logicalCores: { $last: "$system.cpu.logical_core" },
frequency: { $avg: "$system.cpu.frequency" },
currentFrequency: { $last: "$system.cpu.current_frequency" },
tempsArrays: { $push: "$system.cpu.temperature" },
freePercent: { $avg: "$system.cpu.free_percent" },
usedPercent: { $avg: "$system.cpu.usage_percent" },
total_bytes: { $last: "$system.memory.total_bytes" },
available_bytes: { $last: "$system.memory.available_bytes" },
used_bytes: { $last: "$system.memory.used_bytes" },
memory_usage_percent: { $avg: "$system.memory.usage_percent" },
disksArray: { $push: "$system.disk" },
os: { $last: "$system.host.os" },
platform: { $last: "$system.host.platform" },
kernel_version: { $last: "$system.host.kernel_version" },
pretty_name: { $last: "$system.host.pretty_name" },
netsArray: { $push: "$system.net" },
};
};
private getInfraProjection = (): object => {
const projectStage: any = { status: 1, responseTime: 1, createdAt: 1 };
projectStage["system.cpu.physical_core"] = 1;
projectStage["system.cpu.logical_core"] = 1;
projectStage["system.cpu.frequency"] = 1;
projectStage["system.cpu.current_frequency"] = 1;
projectStage["system.cpu.temperature"] = 1;
projectStage["system.cpu.free_percent"] = 1;
projectStage["system.cpu.usage_percent"] = 1;
projectStage["system.memory.total_bytes"] = 1;
projectStage["system.memory.available_bytes"] = 1;
projectStage["system.memory.used_bytes"] = 1;
projectStage["system.memory.usage_percent"] = 1;
projectStage["system.disk"] = 1;
projectStage["system.host.os"] = 1;
projectStage["system.host.platform"] = 1;
projectStage["system.host.kernel_version"] = 1;
projectStage["system.host.pretty_name"] = 1;
projectStage["system.net"] = 1;
return projectStage;
};
private getDockerGroup = (): Record<string, any> => {
return {
_id: { $dateTrunc: { date: "$createdAt", unit: "minute" } },
count: { $sum: 1 },
avgResponseTime: { $last: "$responseTime" },
totalContainers: {
$last: { $size: { $ifNull: ["$dockerContainers", []] } },
},
runningContainers: {
$last: {
$size: {
$filter: {
input: { $ifNull: ["$dockerContainers", []] },
as: "c",
cond: { $eq: ["$$c.running", true] },
},
},
},
},
healthyContainers: {
$last: {
$size: {
$filter: {
input: { $ifNull: ["$dockerContainers", []] },
as: "c",
cond: { $eq: ["$$c.health.healthy", true] },
},
},
},
},
};
};
private getDockerProjection = (): object => {
const projectStage: any = { status: 1, responseTime: 1, createdAt: 1 };
projectStage["dockerContainers"] = 1;
return projectStage;
};
private getFinalProjection = (type: string): object => {
if (type === "pagespeed") {
return {
_id: 1,
count: 1,
avgResponseTime: 1,
accessibility: "$accessibility",
seo: "$seo",
bestPractices: "$bestPractices",
performance: "$performance",
cls: "$cls",
si: "$si",
fcp: "$fcp",
lcp: "$lcp",
tbt: "$tbt",
};
}
if (type === "infrastructure") {
return {
_id: 1,
count: 1,
avgResponseTime: 1,
cpu: {
physical_core: "$physicalCores",
logical_core: "$logicalCores",
frequency: "$frequency",
current_frequency: "$currentFrequency",
temperature: {
$map: {
input: {
$range: [
0,
{
$size: {
$ifNull: [{ $arrayElemAt: ["$tempsArrays", 0] }, []],
},
},
],
},
as: "idx",
in: {
$avg: {
$map: {
input: { $ifNull: ["$tempsArrays", []] },
as: "arr",
in: { $arrayElemAt: ["$$arr", "$$idx"] },
},
},
},
},
},
free_percent: "$freePercent",
used_percent: "$usedPercent",
},
memory: {
total_bytes: "$total_bytes",
available_bytes: "$available_bytes",
used_bytes: "$used_bytes",
usage_percent: "$memory_usage_percent",
},
disk: {
$map: {
input: {
$range: [
0,
{
$size: {
$ifNull: [{ $arrayElemAt: ["$disksArray", 0] }, []],
},
},
],
},
as: "idx",
in: {
$let: {
vars: {
diskGroup: {
$map: {
input: { $ifNull: ["$disksArray", []] },
as: "diskArr",
in: { $arrayElemAt: ["$$diskArr", "$$idx"] },
},
},
},
in: {
device: { $arrayElemAt: ["$$diskGroup.device", 0] },
total_bytes: { $avg: "$$diskGroup.total_bytes" },
free_bytes: { $avg: "$$diskGroup.free_bytes" },
used_bytes: { $avg: "$$diskGroup.used_bytes" },
usage_percent: { $avg: "$$diskGroup.usage_percent" },
total_inodes: { $avg: "$$diskGroup.total_inodes" },
free_inodes: { $avg: "$$diskGroup.free_inodes" },
used_inodes: { $avg: "$$diskGroup.used_inodes" },
inodes_usage_percent: {
$avg: "$$diskGroup.inodes_usage_percent",
},
read_bytes: { $avg: "$$diskGroup.read_bytes" },
write_bytes: { $avg: "$$diskGroup.write_bytes" },
read_time: { $avg: "$$diskGroup.read_time" },
write_time: { $avg: "$$diskGroup.write_time" },
},
},
},
},
},
host: {
os: "$os",
platform: "$platform",
kernel_version: "$kernel_version",
pretty_name: "$pretty_name",
},
net: {
$map: {
input: {
$range: [
0,
{
$size: { $ifNull: [{ $arrayElemAt: ["$netsArray", 0] }, []] },
},
],
},
as: "idx",
in: {
$let: {
vars: {
netGroup: {
$map: {
input: { $ifNull: ["$netsArray", []] },
as: "netArr",
in: { $arrayElemAt: ["$$netArr", "$$idx"] },
},
},
},
in: {
name: { $arrayElemAt: ["$$netGroup.name", 0] },
bytes_sent: { $avg: "$$netGroup.bytes_sent" },
bytes_recv: { $avg: "$$netGroup.bytes_recv" },
packets_sent: { $avg: "$$netGroup.packets_sent" },
packets_recv: { $avg: "$$netGroup.packets_recv" },
err_in: { $avg: "$$netGroup.err_in" },
err_out: { $avg: "$$netGroup.err_out" },
drop_in: { $avg: "$$netGroup.drop_in" },
drop_out: { $avg: "$$netGroup.drop_out" },
fifo_in: { $avg: "$$netGroup.fifo_in" },
fifo_out: { $avg: "$$netGroup.fifo_out" },
},
},
},
},
},
};
}
if (type === "docker") {
return {
_id: 1,
count: 1,
avgResponseTime: 1,
totalContainers: "$totalContainers",
runningContainers: "$runningContainers",
healthyContainers: "$healthyContainers",
runningContainersSnapshot: "$runningContainersSnapshot",
totalExposedPorts: "$totalExposedPorts",
uniqueImages: "$uniqueImages",
runningPercent: {
$cond: [
{ $gt: ["$totalContainers", 0] },
{
$multiply: [
{ $divide: ["$runningContainers", "$totalContainers"] },
100,
],
},
null,
],
},
healthyPercent: {
$cond: [
{ $gt: ["$totalContainers", 0] },
{
$multiply: [
{ $divide: ["$healthyContainers", "$totalContainers"] },
100,
],
},
null,
],
},
};
}
return {};
};
private getChecksRecent = async (monitor: MonitorEntity, startDate: Date) => {
const endDate = new Date();
const matchStage: {
"metadata.monitorId": mongoose.Types.ObjectId;
createdAt: { $gte: Date; $lt: Date };
} = {
"metadata.monitorId": new mongoose.Types.ObjectId(monitor.id),
createdAt: { $gte: startDate, $lt: endDate },
};
let groupClause;
if (monitor.type === "pagespeed") {
groupClause = this.getPageSpeedGroup();
} else if (monitor.type === "infrastructure") {
groupClause = this.getInfraGroup();
} else if (monitor.type === "docker") {
groupClause = this.getDockerGroup();
} else {
groupClause = this.getBaseGroup();
}
let projectStage;
if (monitor.type === "pagespeed") {
projectStage = this.getPageSpeedProjection();
} else if (monitor.type === "infrastructure") {
projectStage = this.getInfraProjection();
} else if (monitor.type === "docker") {
projectStage = this.getDockerProjection();
} else {
projectStage = this.getBaseProjection();
}
let finalProjection = {};
if (
monitor.type === "pagespeed" ||
monitor.type === "infrastructure" ||
monitor.type === "docker"
) {
finalProjection = this.getFinalProjection(monitor.type);
} else {
finalProjection = { _id: 1, count: 1, avgResponseTime: 1 };
}
const pipeline: any[] = [
{ $match: matchStage },
{ $project: { ...projectStage, status: 1 } },
];
// For infrastructure and docker monitors we rely on $last in group, which requires ordering by createdAt
if (monitor.type === "infrastructure" || monitor.type === "docker") {
pipeline.push({ $sort: { createdAt: 1 } });
}
pipeline.push(
{
$group: {
...groupClause,
upChecks: { $sum: { $cond: [{ $eq: ["$status", "up"] }, 1, 0] } },
downChecks: { $sum: { $cond: [{ $eq: ["$status", "down"] }, 1, 0] } },
sumResponseUp: {
$sum: { $cond: [{ $eq: ["$status", "up"] }, "$responseTime", 0] },
},
sumResponseDown: {
$sum: { $cond: [{ $eq: ["$status", "down"] }, "$responseTime", 0] },
},
},
},
{ $sort: { _id: -1 } },
{
$project: {
...finalProjection,
upChecks: 1,
downChecks: 1,
avgResponseTimeUp: {
$cond: [
{ $gt: ["$upChecks", 0] },
{ $divide: ["$sumResponseUp", "$upChecks"] },
null,
],
},
avgResponseTimeDown: {
$cond: [
{ $gt: ["$downChecks", 0] },
{ $divide: ["$sumResponseDown", "$downChecks"] },
null,
],
},
},
}
);
const checks = await Check.aggregate(pipeline)
.allowDiskUse(true)
.hint({ "metadata.monitorId": 1, createdAt: 1 });
// Get monitor stats
const monitorStats = await MonitorStats.findOne({
monitorId: monitor.id,
});
if (!monitorStats) {
throw new ApiError("Monitor stats not found", 404);
}
return {
monitor: monitor,
checks,
stats: monitorStats,
};
};
private getChecksOtherRanges = async (
monitor: MonitorEntity,
range: string,
startDate: Date
) => {
const monitorStats = await MonitorStats.findOne({
monitorId: monitor.id,
});
if (!monitorStats) {
throw new ApiError("Monitor stats not found", 404);
}
const useDaily = range === "30d";
const Model = useDaily ? StatsDaily : StatsHourly;
const endDate = new Date();
const docs = await Model.find({
monitorId: monitor.id,
windowStart: { $gte: startDate, $lt: endDate },
})
.sort({ windowStart: -1 })
.lean();
const checks = (docs as any[]).map((d) => {
const base: any = {
_id: new Date(d.windowStart).toISOString(),
count: d.count ?? 0,
avgResponseTime: d.avgResponseTime ?? 0,
upChecks: d.upChecks ?? 0,
downChecks: d.downChecks ?? 0,
avgResponseTimeUp: d.avgResponseTimeUp ?? null,
avgResponseTimeDown: d.avgResponseTimeDown ?? null,
};
if (monitor.type === "pagespeed") {
return {
...base,
accessibility: d.accessibility,
seo: d.seo,
bestPractices: d.bestPractices,
performance: d.performance,
cls: d.cls,
si: d.si,
fcp: d.fcp,
lcp: d.lcp,
tbt: d.tbt,
};
}
if (monitor.type === "infrastructure") {
return {
...base,
cpu: d.cpu,
memory: d.memory,
disk: d.disk,
host: d.host,
net: d.net,
};
}
if (monitor.type === "docker") {
return {
...base,
totalContainers: d.dockerTotalContainers,
runningContainers: d.dockerRunningContainers,
healthyContainers: d.dockerHealthyContainers,
totalExposedPorts: d.dockerTotalExposedPorts,
uniqueImages: d.dockerUniqueImages,
runningPercent: d.dockerRunningPercent,
healthyPercent: d.dockerHealthyPercent,
};
}
return base;
});
return {
monitor: monitor,
checks,
stats: monitorStats,
};
};
getEmbedChecks = async (
teamId: string,
monitorId: string,
range: string
): Promise<MonitorWithChecksResponse> => {
const monitor = await this.monitorRepository.findById(monitorId, teamId);
if (!monitor) {
throw new ApiError("Monitor not found", 404);
}
if (!monitor) {
throw new ApiError("Monitor not found", 404);
}
const startDate = getStartDate(range);
if (range === "24h" || range === "7d" || range === "30d") {
return await this.getChecksOtherRanges(monitor, range, startDate);
} else {
return await this.getChecksRecent(monitor, startDate);
}
};
async togglePause(userId: string, teamId: string, id: string) {
const updatedMonitor = await this.monitorRepository.togglePauseById(
id,
teamId,
userId
);
if (!updatedMonitor) {
throw new ApiError("Monitor not found", 404);
}
await this.jobQueue.updateJob(updatedMonitor);
if (updatedMonitor?.status !== "paused") {
await this.jobQueue.resumeJob(updatedMonitor);
} else {
await this.jobQueue.pauseJob(updatedMonitor);
}
return updatedMonitor;
}
async update(
userId: string,
teamId: string,
monitorId: string,
updateData: Partial<MonitorEntity>
) {
const allowedFields: (keyof MonitorEntity)[] = [
"name",
"secret",
"interval",
"rejectUnauthorized",
"n",
"notificationChannels",
"thresholds",
];
const safeUpdate: Partial<MonitorEntity> = {};
for (const field of allowedFields) {
if (updateData[field] !== undefined) {
(safeUpdate as any)[field] = updateData[field];
}
}
const updatedMonitor = await this.monitorRepository.updateById(
monitorId,
teamId,
userId,
safeUpdate
);
if (!updatedMonitor) {
throw new ApiError("Monitor not found", 404);
}
await this.jobQueue.updateJob(updatedMonitor);
return updatedMonitor;
}
async delete(teamId: string, monitorId: string) {
const monitor = await this.monitorRepository.findById(monitorId, teamId);
if (!monitor) {
throw new ApiError("Monitor not found", 404);
}
const deleted = await this.jobQueue.deleteJob(monitor);
if (!deleted) {
throw new ApiError("Failed to delete monitor job from queue", 500);
}
await this.monitorRepository.deleteById(monitorId, teamId);
return true;
}
async deleteAllInOrg(orgId: string) {
const montiors = await this.monitorRepository.findByOrgId(orgId);
for (const monitor of montiors) {
await this.jobQueue.deleteJob(monitor);
}
return await this.monitorRepository.deleteByOrgId(orgId);
}
export = async (teamId: string) => {
const monitor = await this.monitorRepository.findByTeamId(teamId);
return monitor.map((m) => ({
name: m.name,
url: m.url,
port: m.port,
type: m.type,
interval: m.interval,
n: m.n,
secret: m.secret,
}));
};
import = async (
orgId: string,
teamId: string,
userId: string,
entitlements: Entitlements,
data: { monitors: Array<IImportedMonitor> }
) => {
const attempted = data.monitors.length ?? 0;
let result: IMonitor[] = [];
let canImport = 0;
try {
// Get current count
const monitorCount = await this.monitorRepository.countByOrgId(orgId);
// Check limits, return NO_CAPACITY if at limit
if (monitorCount >= entitlements.monitorsMax) {
return {
ok: true,
status: 200,
attempted,
code: MonitorImportCode.NO_CAPACITY,
eligible: 0,
imported: 0,
errors: attempted,
};
}
// Proceed with import
canImport = entitlements.monitorsMax - monitorCount;
const importableMonitors = data?.monitors.slice(0, canImport);
result = await Monitor.insertMany(
importableMonitors.map((monitor) => ({
...monitor,
orgId: new mongoose.Types.ObjectId(orgId),
teamId: new mongoose.Types.ObjectId(teamId),
createdBy: new mongoose.Types.ObjectId(userId),
updatedBy: new mongoose.Types.ObjectId(userId),
}))
);
for (const monitor of result) {
await this.jobQueue.addJob(monitor);
}
} catch (error: any) {
return {
ok: false,
status: 500,
code: MonitorImportCode.UNEXPECTED,
attempted,
eligible: canImport,
imported: result.length,
errors: Math.max(0, attempted - result.length),
message: error.message,
};
}
const imported = result.length;
const errors = Math.max(0, attempted - imported);
const code =
imported === attempted ? MonitorImportCode.OK : MonitorImportCode.PARTIAL;
const status = imported === attempted ? 200 : 207;
return {
ok: true,
status,
code,
attempted,
eligible: canImport,
imported,
errors,
};
};
}
export default MonitorService;