From c0fa025feff12455dedbe7dd8643cf831d6c63ea Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Thu, 23 Jun 2022 09:30:50 +0800 Subject: [PATCH 1/6] feat: add /api/v1/db/meta/nocodb/health --- scripts/sdk/swagger.json | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/scripts/sdk/swagger.json b/scripts/sdk/swagger.json index acbac69bab..5dabc2d321 100644 --- a/scripts/sdk/swagger.json +++ b/scripts/sdk/swagger.json @@ -5128,6 +5128,27 @@ "description": "" } }, + "/api/v1/db/meta/nocodb/health": { + "parameters": [], + "get": { + "summary": "", + "operationId": "utils-app-health", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "tags": [ + "Utils" + ], + "description": "" + } + }, "/api/v1/db/meta/cache": { "get": { "summary": "Your GET endpoint", From 7e80f6c2f6aada8775076e5f018229bfd47035e0 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Thu, 23 Jun 2022 09:31:00 +0800 Subject: [PATCH 2/6] feat: add appHealth --- packages/nocodb-sdk/src/lib/Api.ts | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/packages/nocodb-sdk/src/lib/Api.ts b/packages/nocodb-sdk/src/lib/Api.ts index 2c992d87d2..be954c20bf 100644 --- a/packages/nocodb-sdk/src/lib/Api.ts +++ b/packages/nocodb-sdk/src/lib/Api.ts @@ -3208,6 +3208,22 @@ export class Api< ...params, }), + /** + * No description + * + * @tags Utils + * @name AppHealth + * @request GET:/api/v1/db/meta/nocodb/health + * @response `200` `any` OK + */ + appHealth: (params: RequestParams = {}) => + this.request({ + path: `/api/v1/db/meta/nocodb/health`, + method: 'GET', + format: 'json', + ...params, + }), + /** * @description Get All K/V pairs in NocoCache * From e7e387fdc132552d45ec97411777325cad91fdd9 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Thu, 23 Jun 2022 13:37:06 +0800 Subject: [PATCH 3/6] feat: appHealth implementation --- packages/nocodb/src/lib/meta/api/utilApis.ts | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/nocodb/src/lib/meta/api/utilApis.ts b/packages/nocodb/src/lib/meta/api/utilApis.ts index 89ebef8cb6..8d45374ce5 100644 --- a/packages/nocodb/src/lib/meta/api/utilApis.ts +++ b/packages/nocodb/src/lib/meta/api/utilApis.ts @@ -60,6 +60,16 @@ export async function releaseVersion(_req: Request, res: Response) { res.json(result); } +export async function appHealth(_: Request, res: Response) { + res.json({ + message: 'OK', + timestamp: Date(), + uptime: process.uptime(), + memoryUsage: process.memoryUsage(), + cpuUsage: process.cpuUsage() + }); +} + async function _axiosRequestMake(req: Request, res: Response) { const { apiMeta } = req.body; @@ -133,5 +143,6 @@ export default router => { ); router.get('/api/v1/db/meta/nocodb/info', catchError(appInfo)); router.get('/api/v1/db/meta/nocodb/version', catchError(releaseVersion)); + router.get('/api/v1/db/meta/nocodb/health', catchError(appHealth)); router.post('/api/v1/db/meta/axiosRequestMake', catchError(axiosRequestMake)); }; From b6d1961b73e9872b47395a742daea4d36be50cc9 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Thu, 23 Jun 2022 14:15:57 +0800 Subject: [PATCH 4/6] fix: rm mem & cpu usage --- packages/nocodb/src/lib/meta/api/utilApis.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/nocodb/src/lib/meta/api/utilApis.ts b/packages/nocodb/src/lib/meta/api/utilApis.ts index 8d45374ce5..e49fc03988 100644 --- a/packages/nocodb/src/lib/meta/api/utilApis.ts +++ b/packages/nocodb/src/lib/meta/api/utilApis.ts @@ -63,10 +63,8 @@ export async function releaseVersion(_req: Request, res: Response) { export async function appHealth(_: Request, res: Response) { res.json({ message: 'OK', - timestamp: Date(), - uptime: process.uptime(), - memoryUsage: process.memoryUsage(), - cpuUsage: process.cpuUsage() + timestamp: Date.now(), + uptime: process.uptime() }); } From 3492712644dafd2b7e43dc3e3c1fe740ce5804a1 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Thu, 23 Jun 2022 14:35:40 +0800 Subject: [PATCH 5/6] docs: add health api --- packages/noco-docs/content/en/developer-resources/rest-apis.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/noco-docs/content/en/developer-resources/rest-apis.md b/packages/noco-docs/content/en/developer-resources/rest-apis.md index 5695aff635..483d280d25 100644 --- a/packages/noco-docs/content/en/developer-resources/rest-apis.md +++ b/packages/noco-docs/content/en/developer-resources/rest-apis.md @@ -167,6 +167,7 @@ Currently, the default value for {orgs} is noco. Users will be able to ch | Meta | Post | utils | testConnection | /api/v1/db/meta/projects/connection/test | | Meta | Get | utils | appInfo | /api/v1/db/meta/nocodb/info | | Meta | Get | utils | appVersion | /api/v1/db/meta/nocodb/version | +| Meta | Get | utils | appHealth | /api/v1/db/meta/nocodb/health | ## Query params From eaaf4fd1017f83164cc603fa7ed8414484d4a777 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Sat, 25 Jun 2022 12:08:08 +0800 Subject: [PATCH 6/6] fix: update health & version url --- .../noco-docs/content/en/developer-resources/rest-apis.md | 4 ++-- packages/nocodb-sdk/src/lib/Api.ts | 8 ++++---- packages/nocodb/src/lib/meta/api/utilApis.ts | 4 ++-- scripts/sdk/swagger.json | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/noco-docs/content/en/developer-resources/rest-apis.md b/packages/noco-docs/content/en/developer-resources/rest-apis.md index 483d280d25..c062707e86 100644 --- a/packages/noco-docs/content/en/developer-resources/rest-apis.md +++ b/packages/noco-docs/content/en/developer-resources/rest-apis.md @@ -166,8 +166,8 @@ Currently, the default value for {orgs} is noco. Users will be able to ch | Meta | Delete| utils | cacheDelete | /api/v1/db/meta/cache | | Meta | Post | utils | testConnection | /api/v1/db/meta/projects/connection/test | | Meta | Get | utils | appInfo | /api/v1/db/meta/nocodb/info | -| Meta | Get | utils | appVersion | /api/v1/db/meta/nocodb/version | -| Meta | Get | utils | appHealth | /api/v1/db/meta/nocodb/health | +| Meta | Get | utils | appVersion | /api/v1/version | +| Meta | Get | utils | appHealth | /api/v1/health | ## Query params diff --git a/packages/nocodb-sdk/src/lib/Api.ts b/packages/nocodb-sdk/src/lib/Api.ts index be954c20bf..41a8a37c96 100644 --- a/packages/nocodb-sdk/src/lib/Api.ts +++ b/packages/nocodb-sdk/src/lib/Api.ts @@ -3197,12 +3197,12 @@ export class Api< * * @tags Utils * @name AppVersion - * @request GET:/api/v1/db/meta/nocodb/version + * @request GET:/api/v1/version * @response `200` `any` OK */ appVersion: (params: RequestParams = {}) => this.request({ - path: `/api/v1/db/meta/nocodb/version`, + path: `/api/v1/version`, method: 'GET', format: 'json', ...params, @@ -3213,12 +3213,12 @@ export class Api< * * @tags Utils * @name AppHealth - * @request GET:/api/v1/db/meta/nocodb/health + * @request GET:/api/v1/health * @response `200` `any` OK */ appHealth: (params: RequestParams = {}) => this.request({ - path: `/api/v1/db/meta/nocodb/health`, + path: `/api/v1/health`, method: 'GET', format: 'json', ...params, diff --git a/packages/nocodb/src/lib/meta/api/utilApis.ts b/packages/nocodb/src/lib/meta/api/utilApis.ts index e49fc03988..ff04fb9d24 100644 --- a/packages/nocodb/src/lib/meta/api/utilApis.ts +++ b/packages/nocodb/src/lib/meta/api/utilApis.ts @@ -140,7 +140,7 @@ export default router => { ncMetaAclMw(testConnection, 'testConnection') ); router.get('/api/v1/db/meta/nocodb/info', catchError(appInfo)); - router.get('/api/v1/db/meta/nocodb/version', catchError(releaseVersion)); - router.get('/api/v1/db/meta/nocodb/health', catchError(appHealth)); router.post('/api/v1/db/meta/axiosRequestMake', catchError(axiosRequestMake)); + router.get('/api/v1/version', catchError(releaseVersion)); + router.get('/api/v1/health', catchError(appHealth)); }; diff --git a/scripts/sdk/swagger.json b/scripts/sdk/swagger.json index 5dabc2d321..cb5d576664 100644 --- a/scripts/sdk/swagger.json +++ b/scripts/sdk/swagger.json @@ -5107,7 +5107,7 @@ ] } }, - "/api/v1/db/meta/nocodb/version": { + "/api/v1/version": { "parameters": [], "get": { "summary": "", @@ -5128,7 +5128,7 @@ "description": "" } }, - "/api/v1/db/meta/nocodb/health": { + "/api/v1/health": { "parameters": [], "get": { "summary": "",