Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
🔥 improve tcp (#1026)
Thibault Le Ouay6854555f01f7
diff --git a/apps/checker/handlers/checker.go b/apps/checker/handlers/checker.goindex 1bf972381..ec4afd46d 100644--- a/apps/checker/handlers/checker.go+++ b/apps/checker/handlers/checker.go@@ -281,7 +281,7 @@ func (h Handler) HTTPCheckerHandler(c *gin.Context) {log.Ctx(ctx).Error().Err(err).Msg("failed to send event to tinybird")}- if req.Status == "active" {+ if req.Status != "error" {checker.UpdateStatus(ctx, checker.UpdateData{MonitorId: req.MonitorID,Status: "error",diff --git a/apps/checker/handlers/tcp.go b/apps/checker/handlers/tcp.goindex 80932e0d2..1a3b11451 100644--- a/apps/checker/handlers/tcp.go+++ b/apps/checker/handlers/tcp.go@@ -1,6 +1,7 @@package handlersimport (+ "encoding/json""fmt""net/http""strconv"@@ -22,6 +23,21 @@ type TCPResponse struct {Timing checker.TCPResponseTiming `json:"timing"`}+// Only used for Tinybird+type TCPData struct {+ Timing string `json:"timing"`+ ErrorMessage string `json:"error"`+ Region string `json:"region"`++ RequestId int64 `json:"requestId,omitempty"`+ WorkspaceID int64 `json:"workspaceId"`+ MonitorID int64 `json:"monitorId"`+ Timestamp int64 `json:"timestamp"`+ Latency int64 `json:"latency"`++ Error uint8 `json:"errorMessage"`+}+func (h Handler) TCPHandler(c *gin.Context) {ctx := c.Request.Context()dataSourceName := "tcp_response__v0"@@ -50,6 +66,7 @@ func (h Handler) TCPHandler(c *gin.Context) {return}+workspaceId, err := strconv.ParseInt(req.WorkspaceID, 10, 64)if err != nil {@@ -57,6 +74,7 @@ func (h Handler) TCPHandler(c *gin.Context) {return}+monitorId, err := strconv.ParseInt(req.MonitorID, 10, 64)if err != nil {@@ -66,6 +84,7 @@ func (h Handler) TCPHandler(c *gin.Context) {}var called int+op := func() error {called++res, err := checker.PingTcp(int(req.Timeout), req.URL)@@ -74,18 +93,24 @@ func (h Handler) TCPHandler(c *gin.Context) {return fmt.Errorf("unable to check tcp %s", err)}- r := TCPResponse{- WorkspaceID: workspaceId,- Timestamp: req.CronTimestamp,- Timing: checker.TCPResponseTiming{- TCPStart: res.TCPStart,- TCPDone: res.TCPDone,- },- Region: h.Region,- MonitorID: monitorId,+ timingAsString, err := json.Marshal(res)+ if err != nil {+ return fmt.Errorf("error while parsing timing data %s: %w", req.URL, err)}+latency := res.TCPDone - res.TCPStart+ data := TCPData{+ WorkspaceID: workspaceId,+ Timestamp: req.CronTimestamp,+ Error: 0,+ ErrorMessage: "",+ Region: h.Region,+ MonitorID: monitorId,+ Timing: string(timingAsString),+ Latency: latency,+ }+if req.Status == "active" && req.DegradedAfter > 0 && latency > req.DegradedAfter {checker.UpdateStatus(ctx, checker.UpdateData{MonitorId: req.MonitorID,@@ -105,15 +130,27 @@ func (h Handler) TCPHandler(c *gin.Context) {}if req.Status == "error" {- checker.UpdateStatus(ctx, checker.UpdateData{- MonitorId: req.MonitorID,- Status: "active",- Region: h.Region,- CronTimestamp: req.CronTimestamp,- })+ if req.DegradedAfter == 0 || (req.DegradedAfter > 0 && latency < req.DegradedAfter) {+ checker.UpdateStatus(ctx, checker.UpdateData{+ MonitorId: req.MonitorID,+ Status: "active",+ Region: h.Region,+ CronTimestamp: req.CronTimestamp,+ })+ }++ if req.DegradedAfter > 0 && latency > req.DegradedAfter {+ checker.UpdateStatus(ctx, checker.UpdateData{+ MonitorId: req.MonitorID,+ Status: "degraded",+ Region: h.Region,+ CronTimestamp: req.CronTimestamp,+ })+ }+}- if err := h.TbClient.SendEvent(ctx, r, dataSourceName); err != nil {+ if err := h.TbClient.SendEvent(ctx, data, dataSourceName); err != nil {log.Ctx(ctx).Error().Err(err).Msg("failed to send event to tinybird")}@@ -121,17 +158,18 @@ func (h Handler) TCPHandler(c *gin.Context) {}if err := backoff.Retry(op, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), 3)); err != nil {- if err := h.TbClient.SendEvent(ctx, TCPResponse{- WorkspaceID: workspaceId,- Timestamp: req.CronTimestamp,- Error: err.Error(),- Region: h.Region,- MonitorID: monitorId,+ if err := h.TbClient.SendEvent(ctx, TCPData{+ WorkspaceID: workspaceId,+ Timestamp: req.CronTimestamp,+ ErrorMessage: err.Error(),+ Region: h.Region,+ MonitorID: monitorId,+ Error: 1,}, dataSourceName); err != nil {log.Ctx(ctx).Error().Err(err).Msg("failed to send event to tinybird")}- if req.Status == "active" {+ if req.Status != "error" {checker.UpdateStatus(ctx, checker.UpdateData{MonitorId: req.MonitorID,Status: "error",@@ -152,11 +190,13 @@ func (h Handler) TCPHandlerRegion(c *gin.Context) {region := c.Param("region")if region == "" {c.String(http.StatusBadRequest, "region is required")+return}if c.GetHeader("Authorization") != fmt.Sprintf("Basic %s", h.Secret) {c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})+return}@@ -166,32 +206,42 @@ func (h Handler) TCPHandlerRegion(c *gin.Context) {if region != "" && region != h.Region {c.Header("fly-replay", fmt.Sprintf("region=%s", region))c.String(http.StatusAccepted, "Forwarding request to %s", region)+return}}+var req request.TCPCheckerRequest+if err := c.ShouldBindJSON(&req); err != nil {log.Ctx(ctx).Error().Err(err).Msg("failed to decode checker request")c.JSON(http.StatusBadRequest, gin.H{"error": "invalid request"})+return}workspaceId, err := strconv.ParseInt(req.WorkspaceID, 10, 64)if err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": "invalid request"})+return}+monitorId, err := strconv.ParseInt(req.MonitorID, 10, 64)if err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": "invalid request"})+return}var called int+var response TCPResponse+op := func() error {called++res, err := checker.PingTcp(int(req.Timeout), req.URL)+if err != nil {return fmt.Errorf("unable to check tcp %s", err)}@@ -207,8 +257,27 @@ func (h Handler) TCPHandlerRegion(c *gin.Context) {MonitorID: monitorId,}+ timingAsString, err := json.Marshal(res)+ if err != nil {+ return fmt.Errorf("error while parsing timing data %s: %w", req.URL, err)+ }++ latency := res.TCPDone - res.TCPStart++ data := TCPData{+ WorkspaceID: workspaceId,+ Timestamp: req.CronTimestamp,+ Error: 0,+ ErrorMessage: "",+ Region: h.Region,+ MonitorID: monitorId,+ Timing: string(timingAsString),+ Latency: latency,+ RequestId: req.RequestId,+ }+if req.RequestId != 0 {- if err := h.TbClient.SendEvent(ctx, response, dataSourceName); err != nil {+ if err := h.TbClient.SendEvent(ctx, data, dataSourceName); err != nil {log.Ctx(ctx).Error().Err(err).Msg("failed to send event to tinybird")}}@@ -216,16 +285,19 @@ func (h Handler) TCPHandlerRegion(c *gin.Context) {return nil}- if err := backoff.Retry(op, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), 3)); err != nil {- if err := h.TbClient.SendEvent(ctx, TCPResponse{- WorkspaceID: workspaceId,- Timestamp: req.CronTimestamp,- Error: err.Error(),- Region: h.Region,- MonitorID: monitorId,+ if err := backoff.Retry(op, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), 3)); err != nil && req.RequestId != 0 {+ if err := h.TbClient.SendEvent(ctx, TCPData{+ WorkspaceID: workspaceId,+ Timestamp: req.CronTimestamp,+ ErrorMessage: err.Error(),+ Region: h.Region,+ MonitorID: monitorId,+ Error: 1,+ RequestId: req.RequestId,}, dataSourceName); err != nil {log.Ctx(ctx).Error().Err(err).Msg("failed to send event to tinybird")}}+c.JSON(http.StatusOK, response)}diff --git a/apps/docs/api-reference/check/http/post-http.mdx b/apps/docs/api-reference/check/http/post-http.mdxnew file mode 100644index 000000000..e10327625--- /dev/null+++ b/apps/docs/api-reference/check/http/post-http.mdx@@ -0,0 +1,4 @@+---+title: Create a Check run for a HTTP request+openapi: post /check/http+---diff --git a/apps/docs/api-reference/check/post-check.mdx b/apps/docs/api-reference/check/post-check.mdxdeleted file mode 100644index dfff21a5d..000000000--- a/apps/docs/api-reference/check/post-check.mdx+++ /dev/null@@ -1,4 +0,0 @@-----title: Create a Check run-openapi: post /check----diff --git a/apps/server/src/v1/check/post.test.ts b/apps/server/src/v1/check/http/post.test.tssimilarity index 97%rename from apps/server/src/v1/check/post.test.tsrename to apps/server/src/v1/check/http/post.test.tsindex 3006c4040..36641b5e7 100644--- a/apps/server/src/v1/check/post.test.ts+++ b/apps/server/src/v1/check/http/post.test.ts@@ -1,6 +1,6 @@import { expect, test } from "bun:test";-import { api } from "../index";+import { api } from "../../index";import { afterEach, mock } from "bun:test";@@ -30,7 +30,7 @@ test("Create a single check ", async () => {),);- const res = await api.request("/check", {+ const res = await api.request("/check/http", {method: "POST",headers: {"x-openstatus-key": "1",diff --git a/apps/server/src/v1/check/post.ts b/apps/server/src/v1/check/http/post.tssimilarity index 95%rename from apps/server/src/v1/check/post.tsrename to apps/server/src/v1/check/http/post.tsindex 4badd35b7..854c04ba9 100644--- a/apps/server/src/v1/check/post.ts+++ b/apps/server/src/v1/check/http/post.ts@@ -3,9 +3,9 @@ import { createRoute, type z } from "@hono/zod-openapi";import { db } from "@openstatus/db";import { check } from "@openstatus/db/src/schema/check";import percentile from "percentile";-import { env } from "../../env";-import { openApiErrorResponses } from "../../libs/errors/openapi-error-responses";-import type { checkAPI } from "./index";+import { env } from "../../../env";+import { openApiErrorResponses } from "../../../libs/errors/openapi-error-responses";+import type { checkAPI } from "../index";import {AggregatedResponseSchema,AggregatedResult,@@ -18,7 +18,7 @@ const postRoute = createRoute({method: "post",tags: ["page"],description: "Run a single check",- path: "/",+ path: "/http",request: {body: {description: "The run request to create",@@ -42,7 +42,7 @@ const postRoute = createRoute({},});-export function registerPostCheck(api: typeof checkAPI) {+export function registerHTTPPostCheck(api: typeof checkAPI) {return api.openapi(postRoute, async (c) => {const data = c.req.valid("json");const workspaceId = Number(c.get("workspaceId"));diff --git a/apps/server/src/v1/check/schema.ts b/apps/server/src/v1/check/http/schema.tssimilarity index 98%rename from apps/server/src/v1/check/schema.tsrename to apps/server/src/v1/check/http/schema.tsindex d6aadf81e..6c1dbddc7 100644--- a/apps/server/src/v1/check/schema.ts+++ b/apps/server/src/v1/check/http/schema.ts@@ -1,5 +1,5 @@import { z } from "zod";-import { MonitorSchema } from "../monitors/schema";+import { MonitorSchema } from "../../monitors/schema";export const CheckSchema = MonitorSchema.pick({url: true,diff --git a/apps/server/src/v1/check/index.ts b/apps/server/src/v1/check/index.tsindex 23de62426..d384cd880 100644--- a/apps/server/src/v1/check/index.ts+++ b/apps/server/src/v1/check/index.ts@@ -3,12 +3,12 @@ import { OpenAPIHono } from "@hono/zod-openapi";import type { Variables } from "../index";import { handleZodError } from "../../libs/errors";-import { registerPostCheck } from "./post";+import { registerHTTPPostCheck } from "./http/post";const checkAPI = new OpenAPIHono<{ Variables: Variables }>({defaultHook: handleZodError,});-registerPostCheck(checkAPI);+registerHTTPPostCheck(checkAPI);export { checkAPI };diff --git a/apps/web/src/app/api/checker/cron/_cron.ts b/apps/web/src/app/api/checker/cron/_cron.tsindex 1a80dbbe1..d97e4bfc2 100644--- a/apps/web/src/app/api/checker/cron/_cron.ts+++ b/apps/web/src/app/api/checker/cron/_cron.ts@@ -15,7 +15,7 @@ import {} from "@openstatus/db/src/schema";import { env } from "@/env";-import type { payloadSchema } from "../schema";+import type { httpPayloadSchema, tpcPayloadSchema } from "../schema";const periodicityAvailable = selectMonitorSchema.pick({ periodicity: true });@@ -156,19 +156,42 @@ const createCronTask = async ({status: MonitorStatus;region: string;}) => {- const payload: z.infer<typeof payloadSchema> = {- workspaceId: String(row.workspaceId),- monitorId: String(row.id),- url: row.url,- method: row.method || "GET",- cronTimestamp: timestamp,- body: row.body,- headers: row.headers,- status: status,- assertions: row.assertions ? JSON.parse(row.assertions) : null,- degradedAfter: row.degradedAfter,- timeout: row.timeout,- };+ let payload:+ | z.infer<typeof httpPayloadSchema>+ | z.infer<typeof tpcPayloadSchema>+ | null = null;+ //+ if (row.jobType === "http") {+ payload = {+ workspaceId: String(row.workspaceId),+ monitorId: String(row.id),+ url: row.url,+ method: row.method || "GET",+ cronTimestamp: timestamp,+ body: row.body,+ headers: row.headers,+ status: status,+ assertions: row.assertions ? JSON.parse(row.assertions) : null,+ degradedAfter: row.degradedAfter,+ timeout: row.timeout,+ };+ }+ if (row.jobType === "tcp") {+ payload = {+ workspaceId: String(row.workspaceId),+ monitorId: String(row.id),+ url: row.url,+ status: status,+ assertions: row.assertions ? JSON.parse(row.assertions) : null,+ cronTimestamp: timestamp,+ degradedAfter: row.degradedAfter,+ timeout: row.timeout,+ };+ }++ if (!payload) {+ throw new Error("Invalid jobType");+ }const newTask: google.cloud.tasks.v2beta3.ITask = {httpRequest: {diff --git a/apps/web/src/app/api/checker/schema.ts b/apps/web/src/app/api/checker/schema.tsindex 606075367..17a255e93 100644--- a/apps/web/src/app/api/checker/schema.ts+++ b/apps/web/src/app/api/checker/schema.ts@@ -3,7 +3,7 @@ import { z } from "zod";import { base } from "@openstatus/assertions";import { monitorMethods, monitorStatus } from "@openstatus/db/src/schema";-export const payloadSchema = z.object({+export const httpPayloadSchema = z.object({workspaceId: z.string(),monitorId: z.string(),method: z.enum(monitorMethods),@@ -17,4 +17,15 @@ export const payloadSchema = z.object({degradedAfter: z.number().nullable(),});-export type Payload = z.infer<typeof payloadSchema>;+export type HttpPayload = z.infer<typeof httpPayloadSchema>;++export const tpcPayloadSchema = z.object({+ status: z.enum(monitorStatus),+ workspaceId: z.string(),+ url: z.string(),+ monitorId: z.string(),+ assertions: z.array(base).nullable(),+ cronTimestamp: z.number(),+ timeout: z.number().default(45000),+ degradedAfter: z.number().nullable(),+});diff --git a/apps/web/src/app/api/checker/test/http/route.ts b/apps/web/src/app/api/checker/test/http/route.tsindex 43bd0f3bf..c65e41848 100644--- a/apps/web/src/app/api/checker/test/http/route.ts+++ b/apps/web/src/app/api/checker/test/http/route.ts@@ -4,7 +4,7 @@ import { z } from "zod";import { monitorFlyRegionSchema } from "@openstatus/db/src/schema/constants";import { checkRegion } from "@/components/ping-response-analysis/utils";-import { payloadSchema } from "../../schema";+import { httpPayloadSchema } from "../../schema";import { isAnInvalidTestUrl } from "../../utils";export const runtime = "edge";@@ -19,7 +19,7 @@ export function GET() {export async function POST(request: Request) {try {const json = await request.json();- const _valid = payloadSchema+ const _valid = httpPayloadSchema.pick({ url: true, method: true, headers: true, body: true }).merge(z.object({ region: monitorFlyRegionSchema.default("ams") })).safeParse(json);diff --git a/apps/web/src/app/api/checker/test/route.ts b/apps/web/src/app/api/checker/test/route.tsindex 827e94610..180a43d6c 100644--- a/apps/web/src/app/api/checker/test/route.ts+++ b/apps/web/src/app/api/checker/test/route.ts@@ -4,7 +4,7 @@ import { z } from "zod";import { monitorFlyRegionSchema } from "@openstatus/db/src/schema/constants";import { checkRegion } from "@/components/ping-response-analysis/utils";-import { payloadSchema } from "../schema";+import { httpPayloadSchema } from "../schema";import { isAnInvalidTestUrl } from "../utils";export const runtime = "edge";@@ -19,7 +19,7 @@ export function GET() {export async function POST(request: Request) {try {const json = await request.json();- const _valid = payloadSchema+ const _valid = httpPayloadSchema.pick({ url: true, method: true, headers: true, body: true }).merge(z.object({ region: monitorFlyRegionSchema.default("ams") })).safeParse(json);diff --git a/packages/db/src/schema/monitors/validation.ts b/packages/db/src/schema/monitors/validation.tsindex 355f2277b..995f61388 100644--- a/packages/db/src/schema/monitors/validation.ts+++ b/packages/db/src/schema/monitors/validation.ts@@ -49,6 +49,7 @@ export const selectMonitorSchema = createSelectSchema(monitor, {}).extend({headers: headersToArraySchema.default([]),body: bodyToStringSchema.default(""),+ // for tcp monitors the method is not neededmethod: monitorMethodsSchema.default("GET"),});