@southwind-ai/shared 0.3.0 → 0.3.1

package/index.ts

@@ -17,6 +17,7 @@ export * from "./src/migration-bundle-validation.js";
 export * from "./src/mcp.js";
 export * from "./src/module-configuration.js";
 export * from "./src/correlation.js";
+export * from "./src/structured-log.js";
 export * from "./src/notification.js";
 export * from "./src/password.js";
 export * from "./src/platform-settings.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@southwind-ai/shared",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "license": "UNLICENSED",
   "type": "module",
   "engines": {
@@ -15,7 +15,8 @@
     "typecheck": "tsc --noEmit --project tsconfig.json"
   },
   "exports": {
-    ".": "./index.ts"
+    ".": "./index.ts",
+    "./structured-log": "./src/structured-log.ts"
   },
   "publishConfig": {
     "access": "public"

package/src/structured-log.ts

@@ -0,0 +1,215 @@
+/** 运行日志只承载排障线索；业务审计和 Agent Run 事实使用各自的持久化入口。 */
+export const STRUCTURED_LOG_MAX_BYTES = 2048;
+
+export type StructuredLogLevel = "info" | "warn" | "error";
+export type StructuredLogOutcome = "success" | "failure" | "denied";
+
+export interface StructuredLogInput {
+  event: string;
+  requestId?: string;
+  runId?: string;
+  jobId?: string;
+  traceId?: string;
+  diagnosticId?: string;
+  outcome?: StructuredLogOutcome;
+  errorCode?: string;
+  stageKey?: string;
+  handlerKey?: string;
+  queue?: string;
+  attemptNumber?: number;
+  method?: string;
+  /** 只接受框架登记的路由模板，不能传请求 URL 或实际对象路径。 */
+  route?: string;
+  statusCode?: number;
+  durationMs?: number;
+  actorType?: string;
+  authority?: string;
+  port?: number;
+  created?: number;
+  metadataUpdated?: number;
+  archived?: number;
+  unchanged?: number;
+  queued?: number;
+  dropped?: number;
+  completedUnits?: number;
+  totalUnits?: number;
+  count?: number;
+  /** 兼容现有 Logger 接口；未知字段在序列化时一律丢弃。 */
+  [key: string]: unknown;
+}
+
+export interface StructuredLogSink {
+  info(record: Record<string, unknown>): void;
+  warn(record: Record<string, unknown>): void;
+  error(record: Record<string, unknown>): void;
+}
+
+export interface StructuredLogger {
+  info(input: StructuredLogInput, message?: string): void;
+  warn(input: StructuredLogInput, message?: string): void;
+  error(input: StructuredLogInput, message?: string): void;
+}
+
+const stableKey = /^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)*$/;
+const correlationKey = /^[A-Za-z0-9._-]{1,128}$/;
+const errorKey = /^[A-Z][A-Z0-9_]{0,95}$/;
+const methodKey = /^[A-Z]{1,12}$/;
+const routeTemplate =
+  /^\/(?:[A-Za-z][A-Za-z0-9_-]*|:[A-Za-z][A-Za-z0-9_]*|\*)(?:\/(?:[A-Za-z][A-Za-z0-9_-]*|:[A-Za-z][A-Za-z0-9_]*|\*))*$/;
+
+/** Adapter 可接 Pino、stdout 或测试 Sink；自由文本 message 不进入日志。 */
+export function createStructuredLogger(
+  sink: StructuredLogSink,
+  component: string,
+  now: () => Date = () => new Date(),
+): StructuredLogger {
+  if (!stableKey.test(component) || component.length > 64) {
+    throw new Error("运行日志 component 必须是有界稳定 Key");
+  }
+  const emit = (level: StructuredLogLevel, input: StructuredLogInput) => {
+    const record = structuredLogRecord(level, component, input, now());
+    try {
+      sink[level](record);
+    } catch {
+      // 排障日志是旁路输出；审计和业务结果由各自的可靠存储决定。
+    }
+  };
+  return {
+    info: (input) => emit("info", input),
+    warn: (input) => emit("warn", input),
+    error: (input) => emit("error", input),
+  };
+}
+
+export function structuredLogRecord(
+  level: StructuredLogLevel,
+  component: string,
+  input: StructuredLogInput,
+  at: Date,
+): Record<string, unknown> {
+  const record: Record<string, unknown> = {
+    timestamp: at.toISOString(),
+    level,
+    component,
+    event:
+      stableKey.test(input.event) && input.event.length <= 96
+        ? input.event
+        : "logging.event.invalid",
+    retentionClass: "operational",
+  };
+  for (const key of [
+    "requestId",
+    "runId",
+    "jobId",
+    "traceId",
+    "diagnosticId",
+  ] as const) {
+    const value = input[key];
+    if (typeof value === "string" && correlationKey.test(value)) {
+      record[key] = value;
+    }
+  }
+  if (
+    input.outcome === "success" ||
+    input.outcome === "failure" ||
+    input.outcome === "denied"
+  )
+    record.outcome = input.outcome;
+  if (typeof input.errorCode === "string" && errorKey.test(input.errorCode)) {
+    record.errorCode = input.errorCode;
+  }
+  for (const key of [
+    "stageKey",
+    "handlerKey",
+    "queue",
+    "actorType",
+    "authority",
+  ] as const) {
+    const value = input[key];
+    if (
+      typeof value === "string" &&
+      value.length <= 64 &&
+      stableKey.test(value)
+    ) {
+      record[key] = value;
+    }
+  }
+  if (typeof input.method === "string" && methodKey.test(input.method)) {
+    record.method = input.method;
+  }
+  if (
+    typeof input.route === "string" &&
+    input.route.length <= 160 &&
+    (input.route === "/" || routeTemplate.test(input.route))
+  )
+    record.route = input.route;
+  if (validNumber(input.statusCode, 100, 599, true))
+    record.statusCode = input.statusCode;
+  if (validNumber(input.durationMs, 0, 3_600_000))
+    record.durationMs = input.durationMs;
+  if (validNumber(input.port, 1, 65535, true)) record.port = input.port;
+  if (validNumber(input.attemptNumber, 1, 1_000_000_000, true))
+    record.attemptNumber = input.attemptNumber;
+  for (const key of [
+    "created",
+    "metadataUpdated",
+    "archived",
+    "unchanged",
+    "queued",
+    "dropped",
+    "completedUnits",
+    "totalUnits",
+    "count",
+  ] as const) {
+    const value = input[key];
+    if (validNumber(value, 0, 1_000_000_000, true)) record[key] = value;
+  }
+  for (const key of [
+    "dropped",
+    "completedUnits",
+    "totalUnits",
+    "count",
+    "route",
+    "queued",
+    "unchanged",
+    "archived",
+    "metadataUpdated",
+    "created",
+    "port",
+    "attemptNumber",
+    "queue",
+    "handlerKey",
+    "authority",
+    "actorType",
+    "stageKey",
+    "diagnosticId",
+    "traceId",
+    "jobId",
+    "runId",
+    "requestId",
+  ] as const) {
+    if (
+      new TextEncoder().encode(JSON.stringify(record)).length <=
+      STRUCTURED_LOG_MAX_BYTES
+    )
+      break;
+    delete record[key];
+    record.truncated = true;
+  }
+  return record;
+}
+
+function validNumber(
+  value: unknown,
+  min: number,
+  max: number,
+  integer = false,
+): value is number {
+  return (
+    typeof value === "number" &&
+    Number.isFinite(value) &&
+    value >= min &&
+    value <= max &&
+    (!integer || Number.isInteger(value))
+  );
+}