Skip to content
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

Add centralized logging mechanism using Winston #16

Merged
merged 3 commits into from
Nov 24, 2024
Merged

Add centralized logging mechanism using Winston #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8dd85bd
Add centralized logging mechanism using Winston
SunWuyuan Nov 23, 2024
905a312
1
SunWuyuan Nov 24, 2024
183ad00
使用winston管理日志
SunWuyuan Nov 24, 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
84 changes: 29 additions & 55 deletions app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,54 +3,23 @@ var app = express();
const jwt = require("jsonwebtoken");

const configManager = require("./server/configManager.js");
const logger = require("./server/lib/logger.js");

require("dotenv").config({ override: true });
//console.log(global.config);
// 日志部分
/*
const opentelemetry = require("@opentelemetry/sdk-node");
const {
getNodeAutoInstrumentations,
} = require("@opentelemetry/auto-instrumentations-node");
const {
OTLPTraceExporter,
} = require("@opentelemetry/exporter-trace-otlp-proto");
const { BatchSpanProcessor } = require("@opentelemetry/sdk-trace-base");
const { Resource } = require("@opentelemetry/resources");
const {
SemanticResourceAttributes,
} = require("@opentelemetry/semantic-conventions");
const traceExporter = new OTLPTraceExporter({ url: "https://api.axiom.co/v1/traces", headers: { Authorization: `Bearer ${process.env.AXIOM_TOKEN}`, "X-Axiom-Dataset": process.env.AXIOM_DATASET, }, });
const resource = new Resource({
[SemanticResourceAttributes.SERVICE_NAME]: "node traces",
});
const sdk = new opentelemetry.NodeSDK({
spanProcessor: new BatchSpanProcessor(traceExporter),
resource: resource,
instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();
*/

// 路由处理...

var morganlogger = require("morgan");
morganlogger.token("colored-status", (req, res) => {
const status = res.statusCode;
let color;
if (status >= 500) {
color = "\x1b[31m"; // 红色
} else if (status >= 400) {
color = "\x1b[33m"; // 黄色
} else if (status >= 300) {
color = "\x1b[36m"; // 青色
} else {
color = "\x1b[32m"; // 绿色
}
return color + status + "\x1b[0m"; // 重置颜色
});

expressWinston = require("express-winston");

app.use(
morganlogger(":method :colored-status :response-time ms :remote-addr :url")
expressWinston.logger({
winstonInstance: logger, // 使用外部定义的logger
meta: true, // optional: control whether you want to log the meta data about the request (default to true).
msg: "HTTP {{req.method}} {{res.statusCode}} {{res.responseTime}}ms {{req.url}} {{req.ip}}", // optional: customize the default logging message. Eg. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}"
colorize: false, // Color the text and status code, using the Express/morgan color palette (text: gray, status: default green, 3XX cyan, 4XX yellow, 5XX red).
ignoreRoute: function (req, res) {
return false;
}, // optional: allows to skip some loggin. It is passed the http request and http response objects, should return true to skip the request logging.
level: "info", // 记录所有请求为info级别
})
);

// cors配置
Expand All @@ -65,7 +34,7 @@ var corsOptions = {
if (!origin || corslist.indexOf(new URL(origin).hostname) !== -1) {
callback(null, true);
} else {
console.log(origin);
logger.debug(origin);
callback(new Error("Not allowed by CORS"));
}
},
Expand Down Expand Up @@ -97,7 +66,10 @@ app.set("env", __dirname + "/.env");
app.set("data", __dirname + "/data");
app.set("views", __dirname + "/views");
app.set("prisma", __dirname + "/prisma");
app.set("node_modules/@prisma/client", __dirname + "/node_modules/@prisma/client");
app.set(
"node_modules/@prisma/client",
__dirname + "/node_modules/@prisma/client"
);

app.set("view engine", "ejs");

Expand All @@ -118,14 +90,16 @@ let zcjwttoken;
zcjwttoken = await configManager.getConfig("security.jwttoken");
})();
app.all("*", async function (req, res, next) {
Error("test");

//console.log(req.method +' '+ req.url + " IP:" + req.ip);
const token =
(req.headers["authorization"] || "").replace("Bearer ", "") ||
(req.cookies && req.cookies.token) ||
(req.body && req.body.token) ||
(req.headers && req.headers["token"]) ||
(req.query && req.query.token);
console.log(token);
logger.debug(token);
// Continue with the token verification
if (token) {
jwt.verify(token, zcjwttoken, (err, decodedToken) => {
Expand All @@ -141,7 +115,7 @@ app.all("*", async function (req, res, next) {
is_admin: 0,
usertoken: "",
};
//console.log("JWT验证失败: " + err.message);
logger.error("JWT验证失败: " + err.message);
} else {
// If verification succeeds, store user info
let userInfo = decodedToken;
Expand All @@ -155,8 +129,8 @@ app.all("*", async function (req, res, next) {
is_admin: 0,
usertoken: token,
};
//console.log("JWT验证成功: " + userInfo.email);
//console.log("调试用户信息(session): " + JSON.stringify(res.locals));
logger.debug("JWT验证成功: " + userInfo.email);
logger.debug("调试用户信息(session): " + JSON.stringify(res.locals));
}

next();
Expand All @@ -173,7 +147,7 @@ app.all("*", async function (req, res, next) {
is_admin: 0,
usertoken: "",
};
console.log("未找到JWT Token");
logger.debug("未找到JWT Token");
next();
}
});
Expand Down Expand Up @@ -223,15 +197,16 @@ app.get("/check", function (req, res, next) {
message: "success",
code: 200,
});
logger.debug("check");
});

process.on("uncaughtException", function (err) {
console.log("Caught exception: " + err);
logger.error("Caught exception: " + err);
});

// Centralized error-handling middleware function
app.use((err, req, res, next) => {
console.error(err.stack);
logger.error(err);
res.status(500).send({
status: "error",
message: "Something went wrong!",
Expand All @@ -247,7 +222,6 @@ app.all("*", function (req, res, next) {
code: "404",
message: "找不到页面",
});

});

module.exports = app;
5 changes: 4 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,17 @@
"express": "^4.21.1",
"express-jwt": "^8.3.0",
"express-session": "^1.18.1",
"express-winston": "^4.2.0",
"html-entities": "^2.5.2",
"jsonwebtoken": "^9.0.0",
"morgan": "^1.10.0",
"mysql": "^2.18.1",
"nodemailer": "^6.9.16",
"otpauth": "^9.3.5",
"phpass": "^0.1.1",
"request": "^2.88.0"
"request": "^2.88.0",
"winston": "^3.17.0",
"winston-daily-rotate-file": "^5.0.0"
},
"devDependencies": {
"prisma": "^5.22.0"
Expand Down
Loading