badmfck-api-server 5.0.3 → 5.0.6

package/dist/apiServer/monitor/LogFiles.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOG_SOURCES = void 0;
+exports.listLogSources = listLogSources;
+exports.tailLog = tailLog;
+const promises_1 = __importDefault(require("fs/promises"));
+const fs_1 = require("fs");
+const LogService_1 = require("../LogService");
+exports.LOG_SOURCES = ["process-out", "process-err", "nginx-access", "nginx-error"];
+const LABELS = {
+    "process-out": "Process stdout (pm2 out log)",
+    "process-err": "Process stderr (pm2 error log)",
+    "nginx-access": "nginx access log",
+    "nginx-error": "nginx error log",
+};
+const MAX_WINDOW = 512 * 1024;
+const MAX_LINE = 4000;
+const MAX_LINES = 2000;
+function resolvePaths(opts) {
+    const usable = (p) => (p && p !== "/dev/null" ? p : null);
+    return {
+        "process-out": usable(opts?.processOut) ?? usable(process.env.pm_out_log_path),
+        "process-err": usable(opts?.processErr) ?? usable(process.env.pm_err_log_path),
+        "nginx-access": usable(opts?.nginxAccess),
+        "nginx-error": usable(opts?.nginxError),
+    };
+}
+const ANSI = /\x1b\[[0-9;]*[A-Za-z]/g;
+function cleanLine(raw) {
+    const line = LogService_1.LogService.sanitize(raw.replace(/\r$/, "").replace(ANSI, ""));
+    return line.length > MAX_LINE ? line.slice(0, MAX_LINE) + `…(${line.length} chars)` : line;
+}
+async function listLogSources(opts) {
+    const paths = resolvePaths(opts);
+    return Promise.all(exports.LOG_SOURCES.map(async (id) => {
+        const path = paths[id];
+        const base = { id, label: LABELS[id], path, configured: !!path, exists: false, readable: false,
+            size: null, modifiedAt: null, reason: null };
+        if (!path)
+            return { ...base, reason: id.startsWith("process") ? "not running under pm2 and no path configured" : "path not configured (options.logFiles)" };
+        try {
+            const st = await promises_1.default.stat(path);
+            base.exists = true;
+            base.size = st.size;
+            base.modifiedAt = st.mtimeMs;
+            await promises_1.default.access(path, fs_1.constants.R_OK);
+            base.readable = true;
+        }
+        catch (e) {
+            base.reason = e?.code === "ENOENT" ? "file not found"
+                : e?.code === "EACCES" ? "permission denied for the node process user"
+                    : String(e?.message ?? e);
+        }
+        return base;
+    }));
+}
+async function tailLog(id, opts, req = {}) {
+    const path = resolvePaths(opts)[id];
+    if (!path)
+        throw new Error(`log source "${id}" is not configured`);
+    const wantLines = Math.min(MAX_LINES, Math.max(1, Math.floor(req.lines ?? 200)));
+    const fh = await promises_1.default.open(path, "r");
+    try {
+        const { size } = await fh.stat();
+        const since = typeof req.since === "number" && Number.isFinite(req.since) ? Math.floor(req.since) : undefined;
+        let start;
+        let rotated = false, truncated = false, onBoundary = false;
+        if (since !== undefined && since >= 0 && since <= size) {
+            start = since;
+            onBoundary = true;
+            if (size - start > MAX_WINDOW) {
+                start = size - MAX_WINDOW;
+                truncated = true;
+                onBoundary = false;
+            }
+        }
+        else {
+            rotated = since !== undefined && since > size;
+            start = Math.max(0, size - MAX_WINDOW);
+            onBoundary = start === 0;
+        }
+        const buf = Buffer.alloc(size - start);
+        if (buf.length > 0)
+            await fh.read(buf, 0, buf.length, start);
+        const lastNl = buf.lastIndexOf(0x0a);
+        const firstNl = buf.indexOf(0x0a);
+        let begin = onBoundary ? 0 : (firstNl >= 0 ? firstNl + 1 : buf.length);
+        const end = lastNl >= 0 ? lastNl + 1 : 0;
+        if (begin > end)
+            begin = end;
+        const text = buf.subarray(begin, end).toString("utf-8");
+        let lines = text.length ? text.split("\n") : [];
+        if (lines.length && lines[lines.length - 1] === "")
+            lines.pop();
+        lines = lines.map(cleanLine);
+        const filter = typeof req.filter === "string" ? req.filter.trim().toLowerCase() : "";
+        if (filter)
+            lines = lines.filter(l => l.toLowerCase().includes(filter));
+        if (lines.length > wantLines)
+            lines = lines.slice(-wantLines);
+        return { source: id, path, size, cursor: start + end, rotated, truncated, lines };
+    }
+    finally {
+        await fh.close();
+    }
+}

package/dist/apiServer/monitor/Monitor.d.ts

@@ -34,6 +34,8 @@ export declare class Monitor extends BaseEndpoint {
     httpstats(req: HTTPRequestVO): Promise<TransferPacketVO>;
     inventory(req: HTTPRequestVO): Promise<TransferPacketVO>;
     metrics(req: HTTPRequestVO): Promise<TransferPacketVO>;
+    logfiles(req: HTTPRequestVO): Promise<TransferPacketVO>;
+    logtail(req: HTTPRequestVO): Promise<TransferPacketVO>;
     metricsWeeks(req: HTTPRequestVO): Promise<TransferPacketVO>;
     metricsWeek(req: HTTPRequestVO): Promise<TransferPacketVO>;
     connections(req: HTTPRequestVO): Promise<TransferPacketVO>;

package/dist/apiServer/monitor/Monitor.js

@@ -18,6 +18,7 @@ const MonitorService_1 = require("../MonitorService");
 const DBService_1 = require("../DBService");
 const SystemInfo_1 = require("./SystemInfo");
 const ProcessMonitor_1 = require("./ProcessMonitor");
+const LogFiles_1 = require("./LogFiles");
 exports.S_MONITOR_REGISTRATE_ACTION = new badmfck_signal_1.Signal();
 exports.S_MONITOR_RESTART_REQUESTED = new badmfck_signal_1.Signal();
 const logMap = {
@@ -56,6 +57,17 @@ class Monitor extends BaseEndpoint_1.BaseEndpoint {
                     range: "",
                     $__range_values: ["week", "day", "hour"]
                 } },
+            { ignoreInterceptor: true, endpoint: "logfiles", handler: this.logfiles },
+            { ignoreInterceptor: true, endpoint: "logtail", handler: this.logtail, validationModel: {
+                    source: "",
+                    $__source_values: [...LogFiles_1.LOG_SOURCES],
+                    lines: 0,
+                    $__lines_optional: true,
+                    since: 0,
+                    $__since_optional: true,
+                    filter: "",
+                    $__filter_optional: true
+                } },
             { ignoreInterceptor: true, endpoint: "metricsWeeks", handler: this.metricsWeeks },
             { ignoreInterceptor: true, endpoint: "metricsWeek", handler: this.metricsWeek, validationModel: {
                     weekKey: ""
@@ -205,6 +217,27 @@ class Monitor extends BaseEndpoint_1.BaseEndpoint {
         const result = await MonitorService_1.REQ_STAT.request(req.data);
         return { data: result };
     }
+    async logfiles(req) {
+        await this.checkAuthentication(req);
+        return { data: await (0, LogFiles_1.listLogSources)(this.apiServiceOptions.logFiles) };
+    }
+    async logtail(req) {
+        await this.checkAuthentication(req);
+        const num = (v) => (v === undefined || v === null || v === "" ? undefined : Number(v));
+        try {
+            return { data: await (0, LogFiles_1.tailLog)(req.data.source, this.apiServiceOptions.logFiles, {
+                    lines: num(req.data.lines),
+                    since: num(req.data.since),
+                    filter: req.data.filter,
+                }) };
+        }
+        catch (e) {
+            const details = e?.code === "ENOENT" ? "log file not found"
+                : e?.code === "EACCES" ? "permission denied: the node process user can't read this file (nginx logs are usually root:adm 0640 — add the user to the adm group or point access_log to a readable file)"
+                    : String(e?.message ?? e);
+            throw { ...DefaultErrors_1.default.BAD_REQUEST, details };
+        }
+    }
     async metricsWeeks(req) {
         await this.checkAuthentication(req);
         return { data: await MonitorService_1.REQ_STAT_WEEKS.request() };

package/dist/index.d.ts

@@ -21,3 +21,5 @@ import { Deploy } from "./apiServer/deployment/Deploy";
 import { Activate } from "./apiServer/deployment/Activate";
 import { InterceptorPayAuth } from "./apiServer/interceptors/InterceptorPayAuth";
 export { MicroserviceHost, MicroserviceClient, Http, ZipUtils, UID, YYYYMMDDHH, JSONStableStringify, APIService, Initializer, LocalRequest, ValidationModel, MysqlService, TimeframeService, Validator, LogService, DataProvider, ErrorUtils, ExternalService, DBService, Deploy, Activate, InterceptorPayAuth, S_MONITOR_REGISTRATE_ACTION, S_MONITOR_RESTART_REQUESTED, ProcessMonitor };
+export type { IBlueGreenState, IBlueGreenStateOptions } from "./apiServer/deployment/BlueGreenState";
+export { S_BLUEGREEN_STATE_CHANGED } from "./apiServer/deployment/BlueGreenState";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcessMonitor = exports.S_MONITOR_RESTART_REQUESTED = exports.S_MONITOR_REGISTRATE_ACTION = exports.InterceptorPayAuth = exports.Activate = exports.Deploy = exports.DBService = exports.ExternalService = exports.ErrorUtils = exports.DataProvider = exports.LogService = exports.Validator = exports.TimeframeService = exports.MysqlService = exports.LocalRequest = exports.Initializer = exports.APIService = exports.JSONStableStringify = exports.YYYYMMDDHH = exports.UID = exports.ZipUtils = exports.Http = exports.MicroserviceClient = exports.MicroserviceHost = void 0;
+exports.S_BLUEGREEN_STATE_CHANGED = exports.ProcessMonitor = exports.S_MONITOR_RESTART_REQUESTED = exports.S_MONITOR_REGISTRATE_ACTION = exports.InterceptorPayAuth = exports.Activate = exports.Deploy = exports.DBService = exports.ExternalService = exports.ErrorUtils = exports.DataProvider = exports.LogService = exports.Validator = exports.TimeframeService = exports.MysqlService = exports.LocalRequest = exports.Initializer = exports.APIService = exports.JSONStableStringify = exports.YYYYMMDDHH = exports.UID = exports.ZipUtils = exports.Http = exports.MicroserviceClient = exports.MicroserviceHost = void 0;
 const APIService_1 = require("./apiServer/APIService");
 Object.defineProperty(exports, "APIService", { enumerable: true, get: function () { return APIService_1.APIService; } });
 Object.defineProperty(exports, "Initializer", { enumerable: true, get: function () { return APIService_1.Initializer; } });
@@ -47,3 +47,5 @@ const Activate_1 = require("./apiServer/deployment/Activate");
 Object.defineProperty(exports, "Activate", { enumerable: true, get: function () { return Activate_1.Activate; } });
 const InterceptorPayAuth_1 = require("./apiServer/interceptors/InterceptorPayAuth");
 Object.defineProperty(exports, "InterceptorPayAuth", { enumerable: true, get: function () { return InterceptorPayAuth_1.InterceptorPayAuth; } });
+var BlueGreenState_1 = require("./apiServer/deployment/BlueGreenState");
+Object.defineProperty(exports, "S_BLUEGREEN_STATE_CHANGED", { enumerable: true, get: function () { return BlueGreenState_1.S_BLUEGREEN_STATE_CHANGED; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "badmfck-api-server",
-  "version": "5.0.3",
+  "version": "5.0.6",
   "description": "Simple API http server based on express",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",