Skip to content

Open-source status page, incident response and uptime monitoring

feat: more tinybird (#27)

Maximilian Kaske4d25bf3f4bfa
diff --git a/apps/web/src/app/api/checker/cron/_cron.ts b/apps/web/src/app/api/checker/cron/_cron.ts
index 8faa62fc6..875ea36da 100644
--- a/apps/web/src/app/api/checker/cron/_cron.ts
+++ b/apps/web/src/app/api/checker/cron/_cron.ts
@@ -46,6 +46,7 @@ export const cron = async ({
url: `${DEFAULT_URL}/api/checker/regions/${region}`,
body: {
url: `${DEFAULT_URL}/api/ping`,
+ // FIXME: what is the concret timezone format? In DE, is 02h later
cronTimestamp: timestamp, // used to group all region requests - can be also cronId
},
});
diff --git a/apps/web/src/app/monitor/[id]/page.tsx b/apps/web/src/app/monitor/[id]/page.tsx
index 67a5523cd..5a443738e 100644
--- a/apps/web/src/app/monitor/[id]/page.tsx
+++ b/apps/web/src/app/monitor/[id]/page.tsx
@@ -15,6 +15,8 @@ const searchParamsSchema = z.object({
statusCode: z.coerce.number().optional(),
region: z.enum(availableRegions).optional(),
cronTimestamp: z.coerce.number().optional(),
+ fromDate: z.coerce.number().optional(),
+ toDate: z.coerce.number().optional(),
});
export default async function Monitor({
diff --git a/apps/web/src/app/monitor/layout.tsx b/apps/web/src/app/monitor/layout.tsx
index c5a0919c8..756ba6054 100644
--- a/apps/web/src/app/monitor/layout.tsx
+++ b/apps/web/src/app/monitor/layout.tsx
@@ -1,9 +1,7 @@
import * as React from "react";
-import Link from "next/link";
-import { ChevronLeft } from "lucide-react";
+import { BackButton } from "@/components/layout/back-button";
import { Footer } from "@/components/layout/footer";
-import { Button } from "@/components/ui/button";
// same layout as /play
export default function MonitorLayout({
@@ -14,12 +12,7 @@ export default function MonitorLayout({
return (
<main className="container mx-auto flex min-h-screen w-full flex-col items-center justify-center space-y-6 p-4 md:p-8">
<div className="z-10 flex w-full flex-1 flex-col items-start justify-center">
- <Button asChild variant="link" className="group mb-1">
- <Link href="/">
- <ChevronLeft className="text-muted-foreground group-hover:text-foreground mr-1 h-4 w-4" />{" "}
- Back
- </Link>
- </Button>
+ <BackButton />
<div className="border-border w-full rounded-lg border p-3 backdrop-blur-[2px] md:p-6">
{children}
</div>
diff --git a/apps/web/src/app/play/@modal/(..)monitor/[id]/page.tsx b/apps/web/src/app/play/@modal/(..)monitor/[id]/page.tsx
index 93608a07f..14fa30988 100644
--- a/apps/web/src/app/play/@modal/(..)monitor/[id]/page.tsx
+++ b/apps/web/src/app/play/@modal/(..)monitor/[id]/page.tsx
@@ -16,6 +16,8 @@ const searchParamsSchema = z.object({
statusCode: z.coerce.number().optional(),
region: z.enum(availableRegions).optional(),
cronTimestamp: z.coerce.number().optional(),
+ fromDate: z.coerce.number().optional(),
+ toDate: z.coerce.number().optional(),
});
export default async function Monitor({
diff --git a/apps/web/src/app/play/layout.tsx b/apps/web/src/app/play/layout.tsx
index c5ccadc46..79876349d 100644
--- a/apps/web/src/app/play/layout.tsx
+++ b/apps/web/src/app/play/layout.tsx
@@ -1,9 +1,7 @@
import * as React from "react";
-import Link from "next/link";
-import { ChevronLeft } from "lucide-react";
+import { BackButton } from "@/components/layout/back-button";
import { Footer } from "@/components/layout/footer";
-import { Button } from "@/components/ui/button";
export default function PlayLayout({
children,
@@ -15,12 +13,7 @@ export default function PlayLayout({
return (
<main className="container mx-auto flex min-h-screen w-full flex-col items-center justify-center space-y-6 p-4 md:p-8">
<div className="z-10 flex w-full flex-1 flex-col items-start justify-center">
- <Button asChild variant="link" className="group mb-1">
- <Link href="/">
- <ChevronLeft className="text-muted-foreground group-hover:text-foreground mr-1 h-4 w-4" />{" "}
- Back
- </Link>
- </Button>
+ <BackButton />
<div className="border-border w-full rounded-lg border p-3 backdrop-blur-[2px] md:p-6">
{children}
{modal}
diff --git a/apps/web/src/app/play/page.tsx b/apps/web/src/app/play/page.tsx
index 33bb0038d..f6f6996df 100644
--- a/apps/web/src/app/play/page.tsx
+++ b/apps/web/src/app/play/page.tsx
@@ -1,10 +1,35 @@
+import * as z from "zod";
+
+import { groupByRange } from "@openstatus/tinybird";
+
import { Tracker } from "@/components/monitor/tracker";
import { getMonitorListData } from "@/lib/tb";
+import { ToggleButton } from "./toggle-button";
+
+/**
+ * allowed URL search params
+ */
+const searchParamsSchema = z.object({
+ groupBy: z.enum(groupByRange).optional(),
+});
+
+export default async function PlayPage({
+ searchParams,
+}: {
+ searchParams: { [key: string]: string | string[] | undefined };
+}) {
+ const search = searchParamsSchema.safeParse(searchParams);
+ const params = search.success ? search.data : undefined;
+
+ const data = search.success
+ ? await getMonitorListData({ siteId: "openstatus", ...params })
+ : await getMonitorListData({ siteId: "openstatus" });
-export default async function PlayPage() {
- const data = await getMonitorListData({ siteId: "openstatus" });
return (
- <div className="flex flex-col items-center justify-center gap-4">
+ <div className="relative flex flex-col items-center justify-center gap-4">
+ <div className="absolute right-2 top-2">
+ <ToggleButton groupBy={params?.groupBy} />
+ </div>
<p className="font-cal mb-2 text-3xl">Status</p>
<p className="text-lg font-light">Learn more on how to build your own.</p>
<Tracker
diff --git a/apps/web/src/app/play/toggle-button.tsx b/apps/web/src/app/play/toggle-button.tsx
new file mode 100644
index 000000000..4eac3677f
--- /dev/null
+++ b/apps/web/src/app/play/toggle-button.tsx
@@ -0,0 +1,48 @@
+"use client";
+
+import * as React from "react";
+import { usePathname, useRouter } from "next/navigation";
+import { CalendarDays } from "lucide-react";
+
+import type { GroupByRange } from "@openstatus/tinybird";
+
+import { Button } from "@/components/ui/button";
+import {
+ Tooltip,
+ TooltipContent,
+ TooltipProvider,
+ TooltipTrigger,
+} from "@/components/ui/tooltip";
+import useUpdateSearchParams from "@/hooks/use-update-search-params";
+
+// TODO: move to @/components folder
+export function ToggleButton({ groupBy }: { groupBy?: GroupByRange }) {
+ const router = useRouter();
+ const updateSearchParams = useUpdateSearchParams();
+ const pathname = usePathname();
+
+ const isDay = groupBy === "day";
+
+ return (
+ <TooltipProvider>
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <Button
+ variant={isDay ? "default" : "outline"}
+ size="icon"
+ onClick={() => {
+ router.replace(
+ `${pathname}?${updateSearchParams({
+ groupBy: isDay ? null : "day",
+ })}`,
+ );
+ }}
+ >
+ <CalendarDays className="h-4 w-4" />
+ </Button>
+ </TooltipTrigger>
+ <TooltipContent>{isDay ? "by ping" : "by day"}</TooltipContent>
+ </Tooltip>
+ </TooltipProvider>
+ );
+}
diff --git a/apps/web/src/components/layout/back-button.tsx b/apps/web/src/components/layout/back-button.tsx
new file mode 100644
index 000000000..a4f25b21a
--- /dev/null
+++ b/apps/web/src/components/layout/back-button.tsx
@@ -0,0 +1,16 @@
+"use client";
+
+import { useRouter } from "next/navigation";
+import { ChevronLeft } from "lucide-react";
+
+import { Button } from "../ui/button";
+
+export const BackButton = () => {
+ const router = useRouter();
+ return (
+ <Button variant="link" className="group mb-1" onClick={router.back}>
+ <ChevronLeft className="text-muted-foreground group-hover:text-foreground mr-1 h-4 w-4" />{" "}
+ Back
+ </Button>
+ );
+};
diff --git a/apps/web/src/components/monitor/tracker.tsx b/apps/web/src/components/monitor/tracker.tsx
index 5176f0156..3d9283a1c 100644
--- a/apps/web/src/components/monitor/tracker.tsx
+++ b/apps/web/src/components/monitor/tracker.tsx
@@ -4,7 +4,7 @@ import * as React from "react";
import Link from "next/link";
import { cva } from "class-variance-authority";
import { format } from "date-fns";
-import { AlertCircle, CheckCircle2, Eye, Info } from "lucide-react";
+import { Eye, Info } from "lucide-react";
import type { Monitor } from "@openstatus/tinybird";
@@ -45,15 +45,10 @@ interface TrackerProps {
maxSize?: number;
}
-// TODO: instead of slicing and setting placeholder data,
-// just start from end and absolute position the same number of divs
-// with a lighter bg color
// TODO: discusss to move data fetching inside of Tracker
export function Tracker({ data, url, id, name, maxSize = 35 }: TrackerProps) {
- const slicedData = data.slice(0, maxSize);
- const placeholderData: null[] = Array(
- Math.max(0, maxSize - slicedData.length),
- ).fill(null);
+ const slicedData = data.slice(0, maxSize).reverse();
+ const placeholderData: null[] = Array(maxSize).fill(null);
const reducedData = slicedData.reduce(
(prev, curr) => {
@@ -80,13 +75,17 @@ export function Tracker({ data, url, id, name, maxSize = 35 }: TrackerProps) {
{`${totalUptime}%`} uptime
</p>
</div>
- <div className="flex gap-0.5">
- {placeholderData.map((_, i) => {
- return <div key={i} className={tracker({ variant: "empty" })} />;
- })}
- {slicedData.reverse().map((props) => {
- return <Bar key={props.cronTimestamp} {...props} />;
- })}
+ <div className="relative">
+ <div className="z-[-1] flex gap-0.5">
+ {placeholderData.map((_, i) => {
+ return <div key={i} className={tracker({ variant: "empty" })} />;
+ })}
+ </div>
+ <div className="absolute right-0 top-0 flex gap-0.5">
+ {slicedData.map((props) => {
+ return <Bar key={props.cronTimestamp} {...props} />;
+ })}
+ </div>
</div>
</div>
);
@@ -119,6 +118,12 @@ const Bar = ({ count, ok, avgLatency, cronTimestamp }: Monitor) => {
const ratio = ok / count;
const isOk = ratio === 1; // TODO: when operational, downtime, degraded
+ // FIX: this is an easy way to detect if cronTimestamps have been aggregated
+ const isMidnight = String(cronTimestamp).endsWith("00000");
+ const date = new Date(cronTimestamp);
+ const toDate = isMidnight ? date.setDate(date.getDate() + 1) : cronTimestamp;
+ const dateFormat = isMidnight ? "dd/MM/yy" : "dd/MM/yy HH:mm";
+
return (
<HoverCard
openDelay={100}
@@ -135,7 +140,7 @@ const Bar = ({ count, ok, avgLatency, cronTimestamp }: Monitor) => {
{isOk ? "Operational" : "Downtime"}
</p>
<Link
- href={`/monitor/openstatus?cronTimestamp=${cronTimestamp}`}
+ href={`/monitor/openstatus?fromDate=${cronTimestamp}&toDate=${toDate}`}
className="text-muted-foreground hover:text-foreground"
>
<Eye className="h-4 w-4" />
@@ -143,7 +148,7 @@ const Bar = ({ count, ok, avgLatency, cronTimestamp }: Monitor) => {
</div>
<div className="flex justify-between">
<p className="text-xs font-light">
- {format(new Date(cronTimestamp), "dd/MM/yy HH:mm")}
+ {format(new Date(cronTimestamp), dateFormat)}
</p>
<p className="text-muted-foreground text-xs">
avg. <span className="font-mono">{avgLatency}ms</span>
diff --git a/apps/web/src/components/ui/button.tsx b/apps/web/src/components/ui/button.tsx
index 6e4304739..5c83a8215 100644
--- a/apps/web/src/components/ui/button.tsx
+++ b/apps/web/src/components/ui/button.tsx
@@ -6,24 +6,26 @@ import type { VariantProps } from "class-variance-authority";
import { cn } from "@/lib/utils";
const buttonVariants = cva(
- "inline-flex items-center justify-center rounded-md text-sm font-medium transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:opacity-50 disabled:pointer-events-none ring-offset-background",
+ "inline-flex items-center justify-center rounded-md text-sm font-medium transition-colors focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-50",
{
variants: {
variant: {
- default: "bg-primary text-primary-foreground hover:bg-primary/90",
+ default:
+ "bg-primary text-primary-foreground shadow hover:bg-primary/90",
destructive:
- "bg-destructive text-destructive-foreground hover:bg-destructive/90",
+ "bg-destructive text-destructive-foreground shadow-sm hover:bg-destructive/90",
outline:
- "border border-input hover:bg-accent hover:text-accent-foreground",
+ "border border-input bg-background shadow-sm hover:bg-accent hover:text-accent-foreground",
secondary:
- "bg-secondary text-secondary-foreground hover:bg-secondary/80",
+ "bg-secondary text-secondary-foreground shadow-sm hover:bg-secondary/80",
ghost: "hover:bg-accent hover:text-accent-foreground",
- link: "underline-offset-4 hover:underline text-primary",
+ link: "text-primary underline-offset-4 hover:underline",
},
size: {
- default: "h-10 py-2 px-4",
- sm: "h-9 px-3 rounded-md",
- lg: "h-11 px-8 rounded-md",
+ default: "h-9 px-4 py-2",
+ sm: "h-8 rounded-md px-3 text-xs",
+ lg: "h-10 rounded-md px-8",
+ icon: "h-9 w-9",
},
},
defaultVariants: {
diff --git a/apps/web/src/hooks/use-update-search-params.ts b/apps/web/src/hooks/use-update-search-params.ts
new file mode 100644
index 000000000..622709166
--- /dev/null
+++ b/apps/web/src/hooks/use-update-search-params.ts
@@ -0,0 +1,29 @@
+import * as React from "react";
+import { useSearchParams } from "next/navigation";
+
+export default function useUpdateSearchParams() {
+ const searchParams = useSearchParams();
+
+ /**
+ * Get a new searchParams string by merging the current searchParams with a provided key/value pair.
+ * If param is `null`, will be deleted.
+ */
+ const update = React.useCallback(
+ (params: Record<string, boolean | string | number | null>) => {
+ const newSearchParams = new URLSearchParams(searchParams?.toString());
+
+ for (const [key, value] of Object.entries(params)) {
+ if (value === null) {
+ newSearchParams.delete(key);
+ } else {
+ newSearchParams.set(key, String(value));
+ }
+ }
+
+ return newSearchParams.toString();
+ },
+ [searchParams],
+ );
+
+ return update;
+}
diff --git a/apps/web/src/lib/tb.ts b/apps/web/src/lib/tb.ts
index 36ccb7b7d..b45520148 100644
--- a/apps/web/src/lib/tb.ts
+++ b/apps/web/src/lib/tb.ts
@@ -9,7 +9,6 @@ import {
} from "@openstatus/tinybird";
import { env } from "@/env.mjs";
-import MOCK_RESPONSE from "@/mock/response-list.json";
const tb = new Tinybird({ token: env.TINY_BIRD_API_KEY });
@@ -19,12 +18,8 @@ export async function getResponseListData(
Pick<ResponseListParams, "siteId" | "region" | "cronTimestamp" | "limit">
>,
) {
- let data = MOCK_RESPONSE;
- if (process.env.NODE_ENV !== "development") {
- const res = await getResponseList(tb)(props);
- data = res.data;
- }
- return data;
+ const res = await getResponseList(tb)(props);
+ return res.data;
}
export async function getMonitorListData(props: Partial<MonitorListParams>) {
diff --git a/apps/web/src/mock/response-list.json b/apps/web/src/mock/response-list.json
deleted file mode 100644
index d894b777f..000000000
--- a/apps/web/src/mock/response-list.json
+++ /dev/null
@@ -1,62 +0,0 @@
-[
- {
- "id": "openstatus",
- "monitorId": "openstatus",
- "workspaceId": "openstatus",
- "pageId": "openstatus",
- "timestamp": 1687718354031,
- "cronTimestamp": 1687718354031,
- "statusCode": 200,
- "latency": 221,
- "region": "fra1",
- "url": "http://localhost:3000/api/v0/ping"
- },
- {
- "id": "openstatus",
- "monitorId": "openstatus",
- "workspaceId": "openstatus",
- "pageId": "openstatus",
- "timestamp": 16877183268,
- "cronTimestamp": 16877183268,
- "statusCode": 200,
- "latency": 660,
- "region": "fra1",
- "url": "http://localhost:3000/api/v0/ping"
- },
- {
- "id": "openstatus",
- "monitorId": "openstatus",
- "workspaceId": "openstatus",
- "pageId": "openstatus",
- "timestamp": 1687718289489,
- "cronTimestamp": null,
- "statusCode": 500,
- "latency": 332,
- "region": "fra1",
- "url": "http://localhost:3000/api/v0/ping"
- },
- {
- "id": "openstatus",
- "monitorId": "openstatus",
- "workspaceId": "openstatus",
- "pageId": "openstatus",
- "timestamp": 168771832688,
- "cronTimestamp": 168771832688,
- "statusCode": 500,
- "latency": 660,
- "region": "fra1",
- "url": "http://localhost:3000/api/v0/ping"
- },
- {
- "id": "openstatus",
- "monitorId": "openstatus",
- "workspaceId": "openstatus",
- "pageId": "openstatus",
- "timestamp": 16877182894,
- "cronTimestamp": 16877182894,
- "statusCode": 200,
- "latency": 332,
- "region": "fra1",
- "url": "http://localhost:3000/api/v0/ping"
- }
-]
diff --git a/packages/tinybird/datasources/ping_response.datasource b/packages/tinybird/datasources/ping_response.datasource
new file mode 100644
index 000000000..dd719112f
--- /dev/null
+++ b/packages/tinybird/datasources/ping_response.datasource
@@ -0,0 +1,16 @@
+VERSION 2
+
+SCHEMA >
+ `id` String `json:$.id`,
+ `latency` Int16 `json:$.latency`,
+ `monitorId` String `json:$.monitorId`,
+ `pageId` String `json:$.pageId`,
+ `region` String `json:$.region`,
+ `statusCode` Int16 `json:$.statusCode`,
+ `timestamp` Int64 `json:$.timestamp`,
+ `url` String `json:$.url`,
+ `workspaceId` String `json:$.workspaceId`,
+ `cronTimestamp` Nullable(Int64) `json:$.cronTimestamp`
+
+ENGINE "MergeTree"
+ENGINE_SORTING_KEY "id, timestamp, url, workspaceId"
\ No newline at end of file
diff --git a/packages/tinybird/pipes/monitor_list.pipe b/packages/tinybird/pipes/monitor_list.pipe
new file mode 100644
index 000000000..cc9c9c5f3
--- /dev/null
+++ b/packages/tinybird/pipes/monitor_list.pipe
@@ -0,0 +1,22 @@
+VERSION 0
+
+TOKEN "monitor_list__v0_endpoint_read_0539" READ
+
+NODE monitor_list__v0_0
+SQL >
+
+ %
+ SELECT
+ {% if defined(groupBy) and groupBy == "day" %}
+ toUnixTimestamp64Milli(toDateTime64(DATE(cronTimestamp / 1000), 3))
+ {% else %}
+ cronTimestamp
+ {% end %}
+ AS cronTimestamp, ROUND(AVG(latency)) as avgLatency, COUNT(*) as count, COUNT(CASE WHEN statusCode BETWEEN 200 AND 299 THEN 1 ELSE NULL END) as ok
+ FROM ping_response__v2
+ WHERE id = {{ String(siteId, 'openstatus') }} AND cronTimestamp IS NOT NULL
+ GROUP BY cronTimestamp
+ ORDER BY cronTimestamp DESC
+ LIMIT {{Int32(limit, 1000)}}
+
+
diff --git a/packages/tinybird/pipes/response_list.pipe b/packages/tinybird/pipes/response_list.pipe
new file mode 100644
index 000000000..12b9c310c
--- /dev/null
+++ b/packages/tinybird/pipes/response_list.pipe
@@ -0,0 +1,23 @@
+VERSION 1
+
+NODE response_list__v1_0
+SQL >
+
+ %
+ SELECT *
+ FROM ping_response__v2
+ WHERE id = {{ String(siteId, 'openstatus') }}
+ {% if defined(region) %}
+ AND region = {{ String(region) }}
+ {% end %}
+ {% if defined(cronTimestamp) %}
+ AND cronTimestamp = {{ Int64(cronTimestamp) }}
+ {% end %}
+ {% if defined(fromDate) %}
+ AND cronTimestamp >= {{ Int64(fromDate) }}
+ {% end %}
+ {% if defined(toDate) %}
+ AND cronTimestamp <= {{ Int64(toDate) }}
+ {% end %}
+ ORDER BY timestamp DESC
+ LIMIT {{Int32(limit, 100)}}
diff --git a/packages/tinybird/src/validation.ts b/packages/tinybird/src/validation.ts
index 47e63bd3e..a8ca0a0e7 100644
--- a/packages/tinybird/src/validation.ts
+++ b/packages/tinybird/src/validation.ts
@@ -70,20 +70,28 @@ export const tbBuildResponseList = z.object({
export const tbParameterResponseList = z.object({
siteId: z.string().optional().default("openstatus"), // REMINDER: remove default once alpha
monitorId: z.string().optional().default("openstatus"), // REMINDER: remove default once alpha
- start: z.number().int().default(0), // always start from a date
- end: z.number().int().optional(),
- limit: z.number().int().optional().default(100), // used for pagination
+ fromDate: z.number().int().default(0), // always start from a date
+ toDate: z.number().int().optional(),
+ limit: z.number().int().optional().default(2500), // one day has 2448 pings (17 (regions) * 6 (per hour) * 24)
region: z.enum(availableRegions).optional(),
cronTimestamp: z.number().int().optional(),
});
+/**
+ * All `groupBy` options for the monitoring list
+ * - "day" will aggregate data within the same day
+ * - "cron" will get data from single cron job
+ */
+export const groupByRange = ["day", "cron"] as const;
+
/**
* Params for pipe monitor_list__v0
*/
export const tbParameterMonitorList = z.object({
siteId: z.string().optional().default("openstatus"), // REMINDER: remove default once alpha
- limit: z.number().int().optional().default(100), // used for pagination
+ limit: z.number().int().optional().default(2500), // one day has 2448 pings (17 (regions) * 6 (per hour) * 24)
cronTimestamp: z.number().int().optional(),
+ groupBy: z.enum(groupByRange).optional(), // TODO: rename to frequency: z.enum(["1d", "auto"]) - where "auto" the default periodicity setup
});
/**
@@ -97,7 +105,8 @@ export const tbBuildMonitorList = z.object({
});
export type Ping = z.infer<typeof tbIngestPingResponse>;
-export type Region = (typeof availableRegions)[number];
+export type Region = (typeof availableRegions)[number]; // TODO: rename type AvailabeRegion
export type Monitor = z.infer<typeof tbBuildMonitorList>;
export type ResponseListParams = z.infer<typeof tbParameterResponseList>;
export type MonitorListParams = z.infer<typeof tbParameterMonitorList>;
+export type GroupByRange = (typeof groupByRange)[number];