θΏ™ζ˜―indexlocζδΎ›ηš„ζœεŠ‘οΌŒδΈθ¦θΎ“ε…₯任何密码
Skip to content

[FEAT] Implement winston logger for server endpoints #1723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 19, 2024
Merged

[FEAT] Implement winston logger for server endpoints #1723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9123c4
implement winston logger for backend endpoints
shatfield4 Jun 19, 2024
c34ddc3
implement winston logger for developer api
shatfield4 Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions server/endpoints/api/document/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const { CollectorApi } = require("../../../utils/collectorApi");
const fs = require("fs");
const path = require("path");
const { Document } = require("../../../models/documents");
const logger = require("../../../utils/logger");
const documentsPath =
process.env.NODE_ENV === "development"
? path.resolve(__dirname, "../../../storage/documents")
Expand Down Expand Up @@ -115,7 +116,7 @@ function apiDocumentEndpoints(app) {
});
response.status(200).json({ success: true, error: null, documents });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/document/upload" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -213,7 +214,7 @@ function apiDocumentEndpoints(app) {
});
response.status(200).json({ success: true, error: null, documents });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/document/upload-link" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -346,7 +347,7 @@ function apiDocumentEndpoints(app) {
await EventLogs.logEvent("api_raw_document_uploaded");
response.status(200).json({ success: true, error: null, documents });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/document/raw-text" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -391,7 +392,7 @@ function apiDocumentEndpoints(app) {
const localFiles = await viewLocalFiles();
response.status(200).json({ localFiles });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/documents" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -447,7 +448,7 @@ function apiDocumentEndpoints(app) {

response.status(200).json({ types });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/document/accepted-file-types" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -497,7 +498,7 @@ function apiDocumentEndpoints(app) {
},
});
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/document/metadata-schema" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -555,7 +556,7 @@ function apiDocumentEndpoints(app) {
}
response.status(200).json({ document });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/document/:docName" });
response.sendStatus(500).end();
}
});
Expand Down
13 changes: 7 additions & 6 deletions server/endpoints/api/system/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const {
} = require("../../../utils/helpers/chat/convertTo");
const { dumpENV, updateENV } = require("../../../utils/helpers/updateENV");
const { reqBody } = require("../../../utils/http");
const logger = require("../../../utils/logger");
const { validApiKey } = require("../../../utils/middleware/validApiKey");

function apiSystemEndpoints(app) {
Expand All @@ -29,7 +30,7 @@ function apiSystemEndpoints(app) {
await dumpENV();
response.sendStatus(200).end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/system/env-dump" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -66,7 +67,7 @@ function apiSystemEndpoints(app) {
const settings = await SystemSettings.currentSettings();
response.status(200).json({ settings });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/system" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -98,7 +99,7 @@ function apiSystemEndpoints(app) {
const vectorCount = await VectorDb.totalVectors();
response.status(200).json({ vectorCount });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/system/vector-count" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -148,7 +149,7 @@ function apiSystemEndpoints(app) {
if (process.env.NODE_ENV === "production") await dumpENV();
response.status(200).json({ newValues, error });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/system/update-env" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -202,7 +203,7 @@ function apiSystemEndpoints(app) {
response.setHeader("Content-Type", contentType);
response.status(200).send(data);
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/system/export-chats" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -268,7 +269,7 @@ function apiSystemEndpoints(app) {
.json({ success: true, message: "Documents removed successfully" })
.end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/system/remove-documents" });
response.sendStatus(500).end();
}
}
Expand Down
3 changes: 2 additions & 1 deletion server/endpoints/api/userManagement/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const { User } = require("../../../models/user");
const { multiUserMode } = require("../../../utils/http");
const logger = require("../../../utils/logger");
const { validApiKey } = require("../../../utils/middleware/validApiKey");

function apiUserManagementEndpoints(app) {
Expand Down Expand Up @@ -55,7 +56,7 @@ function apiUserManagementEndpoints(app) {
}));
response.status(200).json({ users: filteredUsers });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/users" });
response.sendStatus(500).end();
}
});
Expand Down
21 changes: 12 additions & 9 deletions server/endpoints/api/workspace/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const {
convertToChatHistory,
writeResponseChunk,
} = require("../../../utils/helpers/chat/responses");
const logger = require("../../../utils/logger");

function apiWorkspaceEndpoints(app) {
if (!app) return;
Expand Down Expand Up @@ -79,7 +80,7 @@ function apiWorkspaceEndpoints(app) {
});
response.status(200).json({ workspace, message });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspace/new" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -121,7 +122,7 @@ function apiWorkspaceEndpoints(app) {
const workspaces = await Workspace.where();
response.status(200).json({ workspaces });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspaces" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -170,7 +171,7 @@ function apiWorkspaceEndpoints(app) {
const workspace = await Workspace.get({ slug });
response.status(200).json({ workspace });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspace/:slug" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -221,7 +222,7 @@ function apiWorkspaceEndpoints(app) {
}
response.sendStatus(200).end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspace/:slug" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -301,7 +302,7 @@ function apiWorkspaceEndpoints(app) {
);
response.status(200).json({ workspace, message });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspace/:slug/update" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -362,7 +363,7 @@ function apiWorkspaceEndpoints(app) {
const history = await WorkspaceChats.forWorkspace(workspace.id);
response.status(200).json({ history: convertToChatHistory(history) });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspace/:slug/chats" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -441,7 +442,9 @@ function apiWorkspaceEndpoints(app) {
});
response.status(200).json({ workspace: updatedWorkspace });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, {
origin: "/v1/workspace/:slug/update-embeddings",
});
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -603,7 +606,7 @@ function apiWorkspaceEndpoints(app) {
});
response.status(200).json({ ...result });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspace/:slug/chat" });
response.status(500).json({
id: uuidv4(),
type: "abort",
Expand Down Expand Up @@ -726,7 +729,7 @@ function apiWorkspaceEndpoints(app) {
});
response.end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/v1/workspace/:slug/stream-chat" });
writeResponseChunk(response, {
id: uuidv4(),
type: "abort",
Expand Down
31 changes: 17 additions & 14 deletions server/endpoints/system.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ const {
generateRecoveryCodes,
} = require("../utils/PasswordRecovery");
const { SlashCommandPresets } = require("../models/slashCommandsPresets");
const logger = require("../utils/logger");

function systemEndpoints(app) {
if (!app) return;
Expand All @@ -75,7 +76,7 @@ function systemEndpoints(app) {
const results = await SystemSettings.currentSettings();
response.status(200).json({ results });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/setup-complete" });
response.sendStatus(500).end();
}
});
Expand All @@ -98,7 +99,7 @@ function systemEndpoints(app) {

response.sendStatus(200).end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/check-token" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -241,7 +242,7 @@ function systemEndpoints(app) {
});
}
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/request-token" });
response.sendStatus(500).end();
}
});
Expand Down Expand Up @@ -307,7 +308,7 @@ function systemEndpoints(app) {
: await VectorDb.totalVectors();
response.status(200).json({ vectorCount });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/system-vectors" });
response.sendStatus(500).end();
}
}
Expand All @@ -322,7 +323,7 @@ function systemEndpoints(app) {
await purgeDocument(name);
response.sendStatus(200).end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/remove-document" });
response.sendStatus(500).end();
}
}
Expand All @@ -337,7 +338,7 @@ function systemEndpoints(app) {
for await (const name of names) await purgeDocument(name);
response.sendStatus(200).end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/remove-documents" });
response.sendStatus(500).end();
}
}
Expand All @@ -352,7 +353,7 @@ function systemEndpoints(app) {
await purgeFolder(name);
response.sendStatus(200).end();
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/remove-folder" });
response.sendStatus(500).end();
}
}
Expand All @@ -366,7 +367,7 @@ function systemEndpoints(app) {
const localFiles = await viewLocalFiles();
response.status(200).json({ localFiles });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/local-files" });
response.sendStatus(500).end();
}
}
Expand All @@ -380,7 +381,9 @@ function systemEndpoints(app) {
const online = await new CollectorApi().online();
response.sendStatus(online ? 200 : 503);
} catch (e) {
console.log(e.message, e);
logger.error(e.message, {
origin: "/system/document-processing-status",
});
response.sendStatus(500).end();
}
}
Expand All @@ -399,7 +402,7 @@ function systemEndpoints(app) {

response.status(200).json({ types });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/accepted-document-types" });
response.sendStatus(500).end();
}
}
Expand All @@ -419,7 +422,7 @@ function systemEndpoints(app) {
if (process.env.NODE_ENV === "production") await dumpENV();
response.status(200).json({ newValues, error });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/update-env" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -455,7 +458,7 @@ function systemEndpoints(app) {
if (process.env.NODE_ENV === "production") await dumpENV();
response.status(200).json({ success: !error, error });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/update-password" });
response.sendStatus(500).end();
}
}
Expand Down Expand Up @@ -505,7 +508,7 @@ function systemEndpoints(app) {
multi_user_mode: false,
});

console.log(e.message, e);
logger.error(e.message, { origin: "/system/enable-multi-user" });
response.sendStatus(500).end();
}
}
Expand All @@ -516,7 +519,7 @@ function systemEndpoints(app) {
const multiUserMode = await SystemSettings.isMultiUserMode();
response.status(200).json({ multiUserMode });
} catch (e) {
console.log(e.message, e);
logger.error(e.message, { origin: "/system/multi-user-mode" });
response.sendStatus(500).end();
}
});
Expand Down
Loading