mirror of
https://github.com/tdurieux/anonymous_github.git
synced 2026-05-16 06:49:09 +02:00
Improve error dashboard
This commit is contained in:
@@ -27,10 +27,9 @@ export default class AnonymousError extends CustomError {
|
||||
this.cause = opt?.cause;
|
||||
}
|
||||
|
||||
detail(): string | undefined {
|
||||
url(): string | undefined {
|
||||
if (this.value == null) return undefined;
|
||||
try {
|
||||
if (this.value instanceof Repository) return this.value.repoId;
|
||||
if (this.value instanceof AnonymizedFile) {
|
||||
const repoId = this.value.repository?.repoId;
|
||||
// anonymizedPath getter can throw if the file isn't initialized;
|
||||
@@ -43,6 +42,17 @@ export default class AnonymousError extends CustomError {
|
||||
}
|
||||
return repoId ? `/r/${repoId}/${p ?? ""}` : p;
|
||||
}
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
detail(): string | undefined {
|
||||
if (this.value == null) return undefined;
|
||||
try {
|
||||
if (this.value instanceof Repository) return this.value.repoId;
|
||||
if (this.value instanceof AnonymizedFile) return undefined;
|
||||
if (this.value instanceof GitHubRepository) return this.value.fullName;
|
||||
if (this.value instanceof User) return this.value.username;
|
||||
if (this.value instanceof GitHubBase) {
|
||||
@@ -57,9 +67,9 @@ export default class AnonymousError extends CustomError {
|
||||
|
||||
toString(): string {
|
||||
let out = this.message;
|
||||
const detail = this.detail();
|
||||
if (detail) {
|
||||
out += `: ${detail}`;
|
||||
const info = this.url() ?? this.detail();
|
||||
if (info) {
|
||||
out += `: ${info}`;
|
||||
}
|
||||
if (this.cause) {
|
||||
out += `\n\tCause by ${this.cause}\n${this.cause.stack}`;
|
||||
|
||||
@@ -465,9 +465,13 @@ export default class Repository {
|
||||
async removeCache() {
|
||||
await storage.rm(this.repoId);
|
||||
this.model.isReseted = true;
|
||||
this.model.size = { storage: 0, file: 0 };
|
||||
if (isConnected) {
|
||||
try {
|
||||
await this.model.save();
|
||||
await AnonymizedRepositoryModel.updateOne(
|
||||
{ _id: this._model._id },
|
||||
{ $set: { isReseted: true, size: this._model.size } }
|
||||
).exec();
|
||||
} catch (error) {
|
||||
logger.error("removeCache save failed", serializeError(error));
|
||||
}
|
||||
|
||||
+134
-4
@@ -3,6 +3,15 @@ import config from "../config";
|
||||
|
||||
export const ERROR_LOG_KEY = "admin:errors";
|
||||
export const ERROR_LOG_MAX = 1000;
|
||||
export const ERROR_LOG_HOURLY_PREFIX = "admin:errors:hourly:";
|
||||
export const ERROR_LOG_DROPPED_KEY = "admin:errors:dropped";
|
||||
// 48h retention on the hourly counters: stats endpoint reads "last 24h" and
|
||||
// "previous 24h" buckets — anything older has nothing to compare against.
|
||||
export const ERROR_LOG_HOURLY_TTL = 48 * 60 * 60;
|
||||
// Hard cap on the JSON payload stored per entry. The recent detail() change
|
||||
// (commit 6f418d6) can produce kilobyte payloads; without a cap the read
|
||||
// path pulls multiple MB on every poll.
|
||||
const MAX_PAYLOAD_BYTES = 4096;
|
||||
|
||||
export type Logger = {
|
||||
debug: (...args: unknown[]) => void;
|
||||
@@ -77,21 +86,132 @@ function getRedis(): RedisClientType | null {
|
||||
}
|
||||
}
|
||||
|
||||
// In-process counter for entries that couldn't be persisted (no Redis client,
|
||||
// disconnected, or Redis-side rejection). Mirrors `admin:errors:dropped` once
|
||||
// Redis is back. Read by /admin/errors/stats so the admin page surfaces
|
||||
// "you're losing logs" instead of silently rendering an empty table.
|
||||
let droppedInProcess = 0;
|
||||
export function getInProcessDropped(): number {
|
||||
return droppedInProcess;
|
||||
}
|
||||
|
||||
function trimStack(s: unknown): unknown {
|
||||
if (typeof s === "string" && s.length > 800) {
|
||||
return s.slice(0, 800) + "…[truncated]";
|
||||
}
|
||||
return s;
|
||||
}
|
||||
function trimRawArg(a: unknown): unknown {
|
||||
if (!a || typeof a !== "object") return a;
|
||||
const o = a as Record<string, unknown>;
|
||||
if (typeof o.stack === "string") {
|
||||
return { ...o, stack: trimStack(o.stack) };
|
||||
}
|
||||
return o;
|
||||
}
|
||||
|
||||
function clampPayload(entry: {
|
||||
ts: string;
|
||||
level: "warn" | "error";
|
||||
module: string;
|
||||
message: string;
|
||||
raw: unknown[];
|
||||
}): string {
|
||||
// Cap raw to first 3 args and trim long stacks before stringifying.
|
||||
if (entry.raw.length > 3) entry.raw = entry.raw.slice(0, 3);
|
||||
entry.raw = entry.raw.map(trimRawArg);
|
||||
let s = JSON.stringify(entry);
|
||||
if (s.length <= MAX_PAYLOAD_BYTES) return s;
|
||||
// Step 1: keep just the first arg (typically the human message + the
|
||||
// structured detail object).
|
||||
entry.raw = entry.raw.slice(0, 1);
|
||||
s = JSON.stringify(entry);
|
||||
if (s.length <= MAX_PAYLOAD_BYTES) return s;
|
||||
// Step 2: replace the payload with a placeholder so the entry still shows
|
||||
// up in the list but doesn't blow the cap.
|
||||
entry.raw = [{ truncated: true, originalBytes: s.length }];
|
||||
return JSON.stringify(entry);
|
||||
}
|
||||
|
||||
// Map a logged entry to the bucket the admin UI uses. Mirrors the inline
|
||||
// logic in /errors/stats so server and client agree on what "5xx / 4xx /
|
||||
// info" means.
|
||||
function bucketFor(
|
||||
detail: Record<string, unknown> | undefined,
|
||||
level: "warn" | "error"
|
||||
): "error" | "warn" | "info" {
|
||||
const s =
|
||||
detail && typeof detail.httpStatus === "number"
|
||||
? (detail.httpStatus as number)
|
||||
: detail && typeof detail.status === "number"
|
||||
? (detail.status as number)
|
||||
: null;
|
||||
if (typeof s === "number") {
|
||||
if (s >= 500) return "error";
|
||||
if (s === 401 || s === 403 || s === 404) return "info";
|
||||
if (s >= 400) return "warn";
|
||||
}
|
||||
return level === "error" ? "error" : "warn";
|
||||
}
|
||||
|
||||
function hourKey(ts: string): string {
|
||||
// YYYYMMDDHH in UTC — sortable, lexicographically aligns with time.
|
||||
const d = new Date(ts);
|
||||
const y = d.getUTCFullYear();
|
||||
const m = String(d.getUTCMonth() + 1).padStart(2, "0");
|
||||
const day = String(d.getUTCDate()).padStart(2, "0");
|
||||
const h = String(d.getUTCHours()).padStart(2, "0");
|
||||
return `${ERROR_LOG_HOURLY_PREFIX}${y}${m}${day}${h}`;
|
||||
}
|
||||
|
||||
function persistError(entry: {
|
||||
ts: string;
|
||||
level: "warn" | "error";
|
||||
module: string;
|
||||
message: string;
|
||||
raw: unknown[];
|
||||
}) {
|
||||
const client = getRedis();
|
||||
if (!client || !client.isOpen) return;
|
||||
const payload = JSON.stringify(entry);
|
||||
if (!client || !client.isOpen) {
|
||||
droppedInProcess++;
|
||||
return;
|
||||
}
|
||||
const payload = clampPayload(entry);
|
||||
// Pre-compute the structured fields the stats endpoint needs so the read
|
||||
// path doesn't have to parse the JSON list at all.
|
||||
const detail = entry.raw.find(
|
||||
(a) => a && typeof a === "object" && !Array.isArray(a)
|
||||
) as Record<string, unknown> | undefined;
|
||||
const bucket = bucketFor(detail, entry.level);
|
||||
const code =
|
||||
(detail && typeof detail.message === "string"
|
||||
? (detail.message as string)
|
||||
: "") ||
|
||||
(detail && typeof detail.code === "string"
|
||||
? (detail.code as string)
|
||||
: "") ||
|
||||
"_";
|
||||
const hKey = hourKey(entry.ts);
|
||||
client
|
||||
.multi()
|
||||
.lPush(ERROR_LOG_KEY, payload)
|
||||
.lTrim(ERROR_LOG_KEY, 0, ERROR_LOG_MAX - 1)
|
||||
.hIncrBy(hKey, "total", 1)
|
||||
.hIncrBy(hKey, `bucket:${bucket}`, 1)
|
||||
.hIncrBy(hKey, `level:${entry.level}`, 1)
|
||||
.hIncrBy(hKey, `module:${entry.module}`, 1)
|
||||
.hIncrBy(hKey, `cb:${bucket}:${code}`, 1)
|
||||
.expire(hKey, ERROR_LOG_HOURLY_TTL)
|
||||
.exec()
|
||||
.catch(() => undefined);
|
||||
.catch(() => {
|
||||
droppedInProcess++;
|
||||
// Best-effort flush of the in-process counter to redis so the admin UI
|
||||
// sees the same number across processes.
|
||||
const c = getRedis();
|
||||
if (c && c.isOpen) {
|
||||
c.incr(ERROR_LOG_DROPPED_KEY).catch(() => undefined);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function emit(level: Level, module: string, args: unknown[]) {
|
||||
@@ -108,9 +228,10 @@ function emit(level: Level, module: string, args: unknown[]) {
|
||||
? console.debug
|
||||
: console.log;
|
||||
sink(line);
|
||||
if (level === "error") {
|
||||
if (level === "error" || level === "warn") {
|
||||
persistError({
|
||||
ts,
|
||||
level,
|
||||
module,
|
||||
message: typeof args[0] === "string" ? args[0] : "",
|
||||
raw: args.map((a) => {
|
||||
@@ -141,6 +262,7 @@ type ErrorLike = {
|
||||
request?: { url?: string; method?: string };
|
||||
response?: { url?: string; status?: number };
|
||||
detail?: () => string | undefined;
|
||||
url?: string | (() => string | undefined);
|
||||
};
|
||||
|
||||
export function serializeError(err: unknown): Record<string, unknown> {
|
||||
@@ -162,6 +284,14 @@ export function serializeError(err: unknown): Record<string, unknown> {
|
||||
// AnonymousError carries an httpStatus and an inner cause.
|
||||
if (typeof e.httpStatus === "number") out.httpStatus = e.httpStatus;
|
||||
if (e.code !== undefined && e.code !== e.message) out.code = e.code;
|
||||
if (typeof e.url === "function") {
|
||||
try {
|
||||
const u = e.url();
|
||||
if (u) out.url = u;
|
||||
} catch {
|
||||
/* ignore */
|
||||
}
|
||||
}
|
||||
if (typeof e.detail === "function") {
|
||||
try {
|
||||
const d = e.detail();
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
import { model } from "mongoose";
|
||||
|
||||
import { IDailyStatsDocument, IDailyStatsModel } from "./dailyStats.types";
|
||||
import DailyStatsSchema from "./dailyStats.schema";
|
||||
|
||||
const DailyStatsModel = model<IDailyStatsDocument>(
|
||||
"DailyStats",
|
||||
DailyStatsSchema
|
||||
) as IDailyStatsModel;
|
||||
|
||||
export default DailyStatsModel;
|
||||
@@ -0,0 +1,11 @@
|
||||
import { Schema } from "mongoose";
|
||||
|
||||
const DailyStatsSchema = new Schema({
|
||||
date: { type: Date, unique: true, index: true },
|
||||
nbRepositories: { type: Number, default: 0 },
|
||||
nbUsers: { type: Number, default: 0 },
|
||||
nbPageViews: { type: Number, default: 0 },
|
||||
nbPullRequests: { type: Number, default: 0 },
|
||||
});
|
||||
|
||||
export default DailyStatsSchema;
|
||||
@@ -0,0 +1,12 @@
|
||||
import { Document, Model } from "mongoose";
|
||||
|
||||
export interface IDailyStats {
|
||||
date: Date;
|
||||
nbRepositories: number;
|
||||
nbUsers: number;
|
||||
nbPageViews: number;
|
||||
nbPullRequests: number;
|
||||
}
|
||||
|
||||
export interface IDailyStatsDocument extends IDailyStats, Document {}
|
||||
export interface IDailyStatsModel extends Model<IDailyStatsDocument> {}
|
||||
Reference in New Issue
Block a user