diff --git a/server/src/api/validation/statusPageValidation.ts b/server/src/api/validation/statusPageValidation.ts index ad2277797..e92f28a57 100644 --- a/server/src/api/validation/statusPageValidation.ts +++ b/server/src/api/validation/statusPageValidation.ts @@ -112,6 +112,7 @@ export const checkSnapshotResponseSchema = z bestPractices: z.number().optional(), seo: z.number().optional(), performance: z.number().optional(), + containerSummary: z.object({ total: z.number(), running: z.number(), stopped: z.number(), unhealthy: z.number() }).optional(), }) .passthrough(); diff --git a/server/src/domain/checks/check.model.ts b/server/src/domain/checks/check.model.ts index 9f3c2fbc1..a101375f4 100644 --- a/server/src/domain/checks/check.model.ts +++ b/server/src/domain/checks/check.model.ts @@ -14,6 +14,7 @@ import type { GotTimings, ILighthouseAudit, } from "@/domain/checks/check.type.js"; +import { DockerContainerInfo, DockerContainerStates, DockerContainerSummary, DockerHealthStatuses } from "@/types/network.js"; type CheckMetadataDocument = Omit & { monitorId: Types.ObjectId; @@ -172,6 +173,34 @@ const auditsSchema = new Schema( { _id: false } ); +const dockerContainerSchema = new Schema( + { + id: { type: String, required: true }, + name: { type: String, default: "" }, + image: { type: String, default: "" }, + state: { type: String, enum: DockerContainerStates, default: "created" }, + status: { type: String, default: "" }, + health: { type: String, enum: DockerHealthStatuses, default: "none" }, + cpuPct: { type: Number }, + memoryUsedBytes: { type: Number }, + memoryLimitBytes: { type: Number }, + memoryPct: { type: Number }, + restartCount: { type: Number }, + startedAt: { type: String }, + }, + { _id: false } +); + +const containerSummarySchema = new Schema( + { + total: { type: Number, default: 0 }, + running: { type: Number, default: 0 }, + stopped: { type: Number, default: 0 }, + unhealthy: { type: Number, default: 0 }, + }, + { _id: false } +); + const metadataSchema = new Schema( { monitorId: { @@ -268,6 +297,14 @@ const CheckSchema = new Schema( type: auditsSchema, default: undefined, }, + containers: { + type: [dockerContainerSchema], + default: undefined, + }, + containerSummary: { + type: containerSummarySchema, + default: undefined, + }, }, { timestamps: true, @@ -291,5 +328,5 @@ CheckSchema.index({ "metadata.teamId": 1, status: 1, createdAt: -1 }); const CheckModel = model("Check", CheckSchema); export type { CheckDocument, CheckMetadataDocument }; -export { CheckModel }; +export { CheckModel, containerSummarySchema }; export default CheckModel; diff --git a/server/src/domain/checks/check.repository.mongo.ts b/server/src/domain/checks/check.repository.mongo.ts index e64113b6c..9b46f2dbd 100644 --- a/server/src/domain/checks/check.repository.mongo.ts +++ b/server/src/domain/checks/check.repository.mongo.ts @@ -167,6 +167,8 @@ class MongoChecksRepository implements IChecksRepository { seo: doc.seo, performance: doc.performance, audits: mapAudits(doc.audits), + containers: doc.containers, + containerSummary: doc.containerSummary, createdAt: toDateString(doc.createdAt), updatedAt: toDateString(doc.updatedAt), }; diff --git a/server/src/domain/checks/check.service.ts b/server/src/domain/checks/check.service.ts index 40dd88f80..5eb071bab 100644 --- a/server/src/domain/checks/check.service.ts +++ b/server/src/domain/checks/check.service.ts @@ -2,7 +2,7 @@ import { Types } from "mongoose"; import { IChecksRepository } from "@/domain/checks/check.repository.interface.js"; import { IMonitorsRepository } from "@/domain/monitors/monitor.repository.interface.js"; import type { Check, CheckErrorInfo, ChecksQueryResult, ChecksSummary, ILighthouseAudit } from "@/domain/checks/check.type.js"; -import type { MonitorPayloadMap, MonitorStatusResponse } from "@/types/network.js"; +import type { DockerStatusPayload, MonitorPayloadMap, MonitorStatusResponse } from "@/types/network.js"; import type { HardwareStatusPayload, PageSpeedStatusPayload } from "@/types/network.js"; import { AppError } from "@/utils/AppError.js"; import { ILogger } from "@/utils/logger.js"; @@ -131,6 +131,12 @@ export class CheckService implements ICheckService { check.capture = hardwarePayload?.capture; check.net = net; } + + if (type === "docker") { + const dockerPayload = payload as DockerStatusPayload | undefined; + check.containers = dockerPayload?.containers; + check.containerSummary = dockerPayload?.summary; + } return check; }; diff --git a/server/src/domain/checks/check.snapshot.ts b/server/src/domain/checks/check.snapshot.ts index 3ee208d04..7348a2d55 100644 --- a/server/src/domain/checks/check.snapshot.ts +++ b/server/src/domain/checks/check.snapshot.ts @@ -11,6 +11,7 @@ import type { SnapshotHostInfo, SnapshotMemoryInfo, } from "@/domain/checks/check.type.js"; +import { DockerContainerSummary } from "@/types/network.js"; import { toDateString } from "@/utils/mongoMappers.js"; export type CheckSnapshotSource = Pick< @@ -23,6 +24,7 @@ export type CheckSnapshotSource = Pick< disk?: CheckDiskInfo[]; host?: CheckHostInfo; audits?: CheckAudits; + containerSummary?: DockerContainerSummary; }; const mapCpu = (cpu?: CheckCpuInfo): SnapshotCpuInfo | undefined => @@ -66,6 +68,9 @@ const mapAudits = (audits?: CheckAudits): CheckAudits | undefined => tbt: audits.tbt, }; +const mapContainerSummary = (summary?: DockerContainerSummary): DockerContainerSummary | undefined => + summary && { total: summary.total, running: summary.running, stopped: summary.stopped, unhealthy: summary.unhealthy }; + export const toCheckSnapshot = (source: CheckSnapshotSource): CheckSnapshot => ({ id: source.id, status: source.status, @@ -82,4 +87,5 @@ export const toCheckSnapshot = (source: CheckSnapshotSource): CheckSnapshot => ( seo: source.seo, performance: source.performance, audits: mapAudits(source.audits), + containerSummary: mapContainerSummary(source.containerSummary), }); diff --git a/server/src/domain/checks/check.type.ts b/server/src/domain/checks/check.type.ts index aa1eb3782..77486aa79 100644 --- a/server/src/domain/checks/check.type.ts +++ b/server/src/domain/checks/check.type.ts @@ -1,5 +1,7 @@ import type { MonitorType } from "@/domain/monitors/monitor.type.js"; +import { DockerContainerInfo, DockerContainerSummary } from "@/types/network.js"; import type { Response } from "got"; +import { number } from "zod"; export const CHECK_TTL_SENTINEL = 366; @@ -107,6 +109,8 @@ export interface Check { host?: CheckHostInfo; errors?: CheckErrorInfo[]; capture?: CheckCaptureInfo; + containers?: DockerContainerInfo[]; + containerSummary?: DockerContainerSummary; net?: CheckNetworkInterfaceInfo[]; accessibility?: number; bestPractices?: number; @@ -197,6 +201,8 @@ export type CheckSnapshot = Pick< memory?: SnapshotMemoryInfo; disk?: SnapshotDiskInfo[]; host?: SnapshotHostInfo; + // Docker Only + containerSummary?: DockerContainerSummary; }; export interface HardwareDiskStats { name: string; @@ -252,3 +258,28 @@ export type DailyCheckBucket = { downChecks: number; avgResponseTime: number | null; }; + +export type DockerStatsBucket = { + _id: string; + avgResponseTime: number | null; + upCount: number; + totalCount: number; + avgRunning: number | null; + avgTotal: number | null; + avgUnhealthy: number | null; +}; + +export interface DockerStats { + aggregateData: { totalChecks: number }; + upChecks: { totalChecks: number }; + aggregate: DockerStatsBucket[]; + latest: { + containers: DockerContainerInfo[]; + summary?: DockerContainerSummary; + checkedAt: string; + } | null; +} + +export interface DockerChecksResult extends DockerStats { + monitorType: "docker"; +} diff --git a/server/src/domain/monitors/monitor.model.ts b/server/src/domain/monitors/monitor.model.ts index ba803dc67..89888900a 100644 --- a/server/src/domain/monitors/monitor.model.ts +++ b/server/src/domain/monitors/monitor.model.ts @@ -9,6 +9,7 @@ import type { SnapshotHostInfo, SnapshotMemoryInfo, } from "@/domain/checks/check.type.js"; +import { containerSummarySchema } from "@/domain/checks/check.model.js"; type CheckSnapshotDocument = Omit & { createdAt: Date }; @@ -113,6 +114,7 @@ const checkSnapshotSchema = new Schema( seo: { type: Number }, performance: { type: Number }, audits: { type: snapshotAuditsSchema }, + containerSummary: { type: containerSummarySchema }, createdAt: { type: Date, required: true }, }, { _id: false, suppressReservedKeysWarning: true }