Skip to content

Open-source status page, incident response and uptime monitoring

🔥 api improvement (#539)

Thibault Le Ouayf07e881f752a
diff --git a/apps/server/src/index.ts b/apps/server/src/index.ts
index 37eb67a56..a2f843e9b 100644
--- a/apps/server/src/index.ts
+++ b/apps/server/src/index.ts
@@ -7,7 +7,7 @@ import { env } from "./env";
import { publicRoute } from "./public";
import { api } from "./v1";
-const app = new Hono();
+const app = new Hono({ strict: false });
app.use("*", sentry({ dsn: process.env.SENTRY_DSN }));
/**
diff --git a/apps/server/src/v1/monitor.ts b/apps/server/src/v1/monitor.ts
index 59757e2db..a24f241c1 100644
--- a/apps/server/src/v1/monitor.ts
+++ b/apps/server/src/v1/monitor.ts
@@ -7,10 +7,16 @@ import {
monitorMethods,
monitorPeriodicity,
} from "@openstatus/db/src/schema";
+import { getMonitorList, Tinybird } from "@openstatus/tinybird";
+import { Redis } from "@openstatus/upstash";
+import { env } from "../env";
import type { Variables } from "./index";
import { ErrorSchema } from "./shared";
+const tb = new Tinybird({ token: env.TINY_BIRD_API_KEY });
+const redis = Redis.fromEnv();
+
const ParamsSchema = z.object({
id: z
.string()
@@ -464,4 +470,97 @@ monitorApi.openapi(deleteRoute, async (c) => {
return c.jsonT({ message: "Deleted" });
});
+const dailyStatsSchema = z.object({
+ ok: z.number().int().openapi({
+ description: "The number of ok responses",
+ }),
+ count: z
+ .number()
+ .int()
+ .openapi({ description: "The total number of request" }),
+ avgLatency: z.number().int().openapi({ description: "The average latency" }),
+ day: z.string().openapi({ description: "the date of the event" }),
+});
+
+const dailyStatsSchemaArray = z
+ .array(dailyStatsSchema)
+ .openapi({ description: "The daily stats" });
+
+const getMonitorStats = createRoute({
+ method: "get",
+ tags: ["monitor"],
+ description: "Get monitor daily summary",
+ path: "/:id/summary",
+ request: {
+ params: ParamsSchema,
+ },
+ responses: {
+ 200: {
+ content: {
+ "application/json": {
+ schema: z.object({
+ data: dailyStatsSchemaArray,
+ }),
+ },
+ },
+ description: "All the historical metrics",
+ },
+ 404: {
+ content: {
+ "application/json": {
+ schema: ErrorSchema,
+ },
+ },
+ description: "Not found",
+ },
+ 401: {
+ content: {
+ "application/json": {
+ schema: ErrorSchema,
+ },
+ },
+ description: "Returns an error",
+ },
+ },
+});
+monitorApi.openapi(getMonitorStats, async (c) => {
+ const workspaceId = Number(c.get("workspaceId"));
+ const { id } = c.req.valid("param");
+
+ const monitorId = Number(id);
+ const _monitor = await db
+ .select()
+ .from(monitor)
+ .where(eq(monitor.id, monitorId))
+ .get();
+
+ if (!_monitor) return c.jsonT({ code: 404, message: "Not Found" });
+
+ if (workspaceId !== _monitor.workspaceId)
+ return c.jsonT({ code: 401, message: "Unauthorized" });
+
+ const cache = await redis.get<z.infer<typeof dailyStatsSchemaArray>>(
+ `${monitorId}-daily-stats`,
+ );
+
+ if (cache) {
+ console.log("fetching from cache");
+ return c.jsonT({
+ data: cache,
+ });
+ }
+
+ console.log("fetching from tinybird");
+ const res = await getMonitorList(tb)({
+ monitorId: String(monitorId),
+ limit: 30,
+ // return data in utc
+ timezone: "Etc/UTC",
+ });
+
+ await redis.set(`${monitorId}-daily-stats`, res.data, { ex: 600 });
+
+ return c.jsonT({ data: res.data });
+});
+
export { monitorApi };
diff --git a/apps/web/src/lib/tracker.ts b/apps/web/src/lib/tracker.ts
index 868fae9c6..7c89d2c3e 100644
--- a/apps/web/src/lib/tracker.ts
+++ b/apps/web/src/lib/tracker.ts
@@ -80,7 +80,9 @@ function fillEmptyData(data: Monitor[], dateSequence: Date[]) {
for (const date of dateSequence) {
const timestamp = date.getTime();
const cronTimestamp =
- dataIndex < data.length ? data[dataIndex].day.getTime() : undefined;
+ dataIndex < data.length
+ ? new Date(data[dataIndex].day).getTime()
+ : undefined;
if (
cronTimestamp &&
diff --git a/packages/tinybird/src/validation.ts b/packages/tinybird/src/validation.ts
index 2c5e98264..23d9cf79f 100644
--- a/packages/tinybird/src/validation.ts
+++ b/packages/tinybird/src/validation.ts
@@ -60,7 +60,10 @@ export const tbBuildMonitorList = z.object({
count: z.number().int(),
ok: z.number().int(),
avgLatency: z.number().int(),
- day: z.coerce.date(),
+ day: z.string().transform((val) => {
+ // That's a hack because clickhouse return the date in UTC but in shitty format (2021-09-01 00:00:00)
+ return new Date(`${val} GMT`).toISOString();
+ }),
});
/**
diff --git a/utils/api-bruno/Monitor Summary.bru b/utils/api-bruno/Monitor Summary.bru
new file mode 100644
index 000000000..31884786a
--- /dev/null
+++ b/utils/api-bruno/Monitor Summary.bru
@@ -0,0 +1,15 @@
+meta {
+ name: Monitor Summary
+ type: http
+ seq: 3
+}
+
+get {
+ url: {{url}}/v1/monitor/1/summary
+ body: none
+ auth: none
+}
+
+headers {
+ x-openstatus-key: 1
+}