mirror of
https://github.com/NginxProxyManager/nginx-proxy-manager.git
synced 2026-09-24 15:10:23 +01:00
carlosalbertorg
4282d6c6e9
Nginx Proxy Manager had no way to inspect application or nginx logs from the web UI - admins had to shell into the container or read `docker logs`. This adds an admin-only Logs page that can tail: - the backend application log, now also mirrored to /data/logs/backend.log (in addition to stdout) and rotated by the logrotate timer that already runs every 2 days - the Let's Encrypt/certbot log, which certbot already writes to /data/logs/letsencrypt.log via its existing --logs-dir flag - per-host nginx access/error logs (proxy, redirection, 404 and stream hosts), with the file path always resolved server-side from a validated host_type enum + numeric host_id, never from client input Reads use a reverse chunked scan (64KB chunks, capped at 5MB scanned per request) instead of loading whole files into memory, and the frontend polls every 5s only while the tab is focused and "Live" is on, so this stays cheap on both CPU and memory. No new runtime dependencies were added on either side. Purely additive: two new admin-only endpoints (GET /api/logs/sources, GET /api/logs/tail), no existing behaviour changed.
107 lines
2.7 KiB
JavaScript
107 lines
2.7 KiB
JavaScript
import express from "express";
|
|
import internalLogViewer from "../internal/log-viewer.js";
|
|
import jwtdecode from "../lib/express/jwt-decode.js";
|
|
import validator from "../lib/validator/index.js";
|
|
import { debug, express as logger } from "../logger.js";
|
|
|
|
const router = express.Router({
|
|
caseSensitive: true,
|
|
strict: true,
|
|
mergeParams: true,
|
|
});
|
|
|
|
/**
|
|
* /api/logs/sources
|
|
*/
|
|
router
|
|
.route("/sources")
|
|
.options((_, res) => {
|
|
res.sendStatus(204);
|
|
})
|
|
.all(jwtdecode())
|
|
|
|
/**
|
|
* GET /api/logs/sources
|
|
*
|
|
* Lists the log sources available for the log viewer
|
|
*/
|
|
.get(async (req, res, next) => {
|
|
try {
|
|
const data = await internalLogViewer.listSources(res.locals.access);
|
|
res.status(200).send(data);
|
|
} catch (err) {
|
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
|
next(err);
|
|
}
|
|
});
|
|
|
|
/**
|
|
* /api/logs/tail
|
|
*/
|
|
router
|
|
.route("/tail")
|
|
.options((_, res) => {
|
|
res.sendStatus(204);
|
|
})
|
|
.all(jwtdecode())
|
|
|
|
/**
|
|
* GET /api/logs/tail
|
|
*
|
|
* Retrieve the last N lines of a log source
|
|
*/
|
|
.get(async (req, res, next) => {
|
|
try {
|
|
const data = await validator(
|
|
{
|
|
required: ["type"],
|
|
additionalProperties: false,
|
|
properties: {
|
|
type: {
|
|
type: "string",
|
|
enum: ["system", "letsencrypt", "host"],
|
|
},
|
|
host_type: {
|
|
anyOf: [{ type: "null" }, { type: "string", enum: ["proxy", "redirection", "dead", "stream"] }],
|
|
},
|
|
host_id: {
|
|
anyOf: [{ type: "null" }, { type: "integer", minimum: 1 }],
|
|
},
|
|
channel: {
|
|
anyOf: [{ type: "null" }, { type: "string", enum: ["access", "error"] }],
|
|
},
|
|
lines: {
|
|
anyOf: [{ type: "null" }, { type: "integer", minimum: 1, maximum: 1000 }],
|
|
},
|
|
level: {
|
|
anyOf: [
|
|
{ type: "null" },
|
|
{ type: "string", enum: ["INFO", "WARN", "ERROR", "DEBUG", "SUCCESS", "FATAL", "COMPLETE"] },
|
|
],
|
|
},
|
|
search: {
|
|
anyOf: [{ type: "null" }, { type: "string", minLength: 1, maxLength: 200 }],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
type: req.query.type,
|
|
host_type: typeof req.query.host_type === "string" ? req.query.host_type : null,
|
|
host_id: typeof req.query.host_id !== "undefined" ? req.query.host_id : null,
|
|
channel: typeof req.query.channel === "string" ? req.query.channel : null,
|
|
lines: typeof req.query.lines !== "undefined" ? req.query.lines : null,
|
|
level: typeof req.query.level === "string" ? req.query.level : null,
|
|
search: typeof req.query.search === "string" ? req.query.search : null,
|
|
},
|
|
);
|
|
|
|
const result = await internalLogViewer.tail(res.locals.access, data);
|
|
res.status(200).send(result);
|
|
} catch (err) {
|
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
|
next(err);
|
|
}
|
|
});
|
|
|
|
export default router;
|