From d5057ab8889231dd09033ed8327452648fd50bc7 Mon Sep 17 00:00:00 2001 From: Hayden Young Date: Thu, 14 Oct 2021 18:27:19 +0100 Subject: feat: initial addition of a healthz, readyz and metrics route --- api/src/routes/-/healthz.ts | 10 ++++++++++ api/src/routes/-/metrics.ts | 10 ++++++++++ api/src/routes/-/readyz.ts | 10 ++++++++++ 3 files changed, 30 insertions(+) create mode 100644 api/src/routes/-/healthz.ts create mode 100644 api/src/routes/-/metrics.ts create mode 100644 api/src/routes/-/readyz.ts (limited to 'api/src') diff --git a/api/src/routes/-/healthz.ts b/api/src/routes/-/healthz.ts new file mode 100644 index 00000000..bfd98a22 --- /dev/null +++ b/api/src/routes/-/healthz.ts @@ -0,0 +1,10 @@ +import { Router, Response, Request } from "express"; +import { route } from "@fosscord/api"; + +const router = Router(); + +router.get("/", route({}), (req: Request, res: Response) => { + res.sendStatus(200); +}); + +export default router; diff --git a/api/src/routes/-/metrics.ts b/api/src/routes/-/metrics.ts new file mode 100644 index 00000000..bfd98a22 --- /dev/null +++ b/api/src/routes/-/metrics.ts @@ -0,0 +1,10 @@ +import { Router, Response, Request } from "express"; +import { route } from "@fosscord/api"; + +const router = Router(); + +router.get("/", route({}), (req: Request, res: Response) => { + res.sendStatus(200); +}); + +export default router; diff --git a/api/src/routes/-/readyz.ts b/api/src/routes/-/readyz.ts new file mode 100644 index 00000000..bfd98a22 --- /dev/null +++ b/api/src/routes/-/readyz.ts @@ -0,0 +1,10 @@ +import { Router, Response, Request } from "express"; +import { route } from "@fosscord/api"; + +const router = Router(); + +router.get("/", route({}), (req: Request, res: Response) => { + res.sendStatus(200); +}); + +export default router; -- cgit 1.5.1 From 35ef010ba9a33776e858d1116dce568ce5a9c41e Mon Sep 17 00:00:00 2001 From: Hayden Young Date: Thu, 14 Oct 2021 18:47:05 +0100 Subject: feat: implement a database check on the healthz and readyz probes, remove /-/metrics --- api/src/routes/-/healthz.ts | 9 ++++++++- api/src/routes/-/metrics.ts | 10 ---------- api/src/routes/-/readyz.ts | 9 ++++++++- 3 files changed, 16 insertions(+), 12 deletions(-) delete mode 100644 api/src/routes/-/metrics.ts (limited to 'api/src') diff --git a/api/src/routes/-/healthz.ts b/api/src/routes/-/healthz.ts index bfd98a22..a42575f8 100644 --- a/api/src/routes/-/healthz.ts +++ b/api/src/routes/-/healthz.ts @@ -1,10 +1,17 @@ import { Router, Response, Request } from "express"; import { route } from "@fosscord/api"; +import { getConnection } from "typeorm"; const router = Router(); router.get("/", route({}), (req: Request, res: Response) => { - res.sendStatus(200); + try { + // test that the database is alive & responding + getConnection(); + return res.sendStatus(200); + } catch(e) { + res.sendStatus(503); + } }); export default router; diff --git a/api/src/routes/-/metrics.ts b/api/src/routes/-/metrics.ts deleted file mode 100644 index bfd98a22..00000000 --- a/api/src/routes/-/metrics.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { Router, Response, Request } from "express"; -import { route } from "@fosscord/api"; - -const router = Router(); - -router.get("/", route({}), (req: Request, res: Response) => { - res.sendStatus(200); -}); - -export default router; diff --git a/api/src/routes/-/readyz.ts b/api/src/routes/-/readyz.ts index bfd98a22..a42575f8 100644 --- a/api/src/routes/-/readyz.ts +++ b/api/src/routes/-/readyz.ts @@ -1,10 +1,17 @@ import { Router, Response, Request } from "express"; import { route } from "@fosscord/api"; +import { getConnection } from "typeorm"; const router = Router(); router.get("/", route({}), (req: Request, res: Response) => { - res.sendStatus(200); + try { + // test that the database is alive & responding + getConnection(); + return res.sendStatus(200); + } catch(e) { + res.sendStatus(503); + } }); export default router; -- cgit 1.5.1 From bbd6b0085e0d3df7c28be04838e83fbc12a238c0 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Fri, 15 Oct 2021 00:46:09 +0200 Subject: :art: exclude healthz/readyz from auth --- api/src/middlewares/Authentication.ts | 2 ++ 1 file changed, 2 insertions(+) (limited to 'api/src') diff --git a/api/src/middlewares/Authentication.ts b/api/src/middlewares/Authentication.ts index 5a082751..59a181e6 100644 --- a/api/src/middlewares/Authentication.ts +++ b/api/src/middlewares/Authentication.ts @@ -9,6 +9,8 @@ export const NO_AUTHORIZATION_ROUTES = [ "/ping", "/gateway", "/experiments", + "/-/readyz", + "/-/healthz", /\/guilds\/\d+\/widget\.(json|png)/ ]; -- cgit 1.5.1