@axiom-lattice/gateway 2.1.19 → 2.1.20

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @axiom-lattice/gateway@2.1.19 build /home/runner/work/agentic/agentic/packages/gateway
+> @axiom-lattice/gateway@2.1.20 build /home/runner/work/agentic/agentic/packages/gateway
 > tsup src/index.ts --format cjs,esm --dts --clean --sourcemap
 
 CLI Building entry: src/index.ts
@@ -9,13 +9,13 @@
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.mjs     61.30 KB
-ESM dist/index.mjs.map 132.19 KB
-ESM ⚡️ Build success in 147ms
-CJS dist/index.js     63.84 KB
-CJS dist/index.js.map 132.29 KB
-CJS ⚡️ Build success in 148ms
+ESM dist/index.mjs     59.42 KB
+ESM dist/index.mjs.map 129.40 KB
+ESM ⚡️ Build success in 154ms
+CJS dist/index.js     61.85 KB
+CJS dist/index.js.map 129.46 KB
+CJS ⚡️ Build success in 157ms
 DTS Build start
-DTS ⚡️ Build success in 7807ms
-DTS dist/index.d.ts  3.32 KB
-DTS dist/index.d.mts 3.32 KB
+DTS ⚡️ Build success in 7579ms
+DTS dist/index.d.ts  3.72 KB
+DTS dist/index.d.mts 3.72 KB

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @axiom-lattice/gateway
 
+## 2.1.20
+
+### Patch Changes
+
+- ef0fb84: update lagger lattice
+- Updated dependencies [ef0fb84]
+  - @axiom-lattice/protocols@2.1.9
+  - @axiom-lattice/core@2.1.15
+  - @axiom-lattice/queue-redis@1.0.8
+
 ## 2.1.19
 
 ### Patch Changes

package/LOGGER_CONFIG.md

@@ -0,0 +1,135 @@
+# Logger Configuration Guide
+
+Gateway 支持通过 `LatticeGatewayConfig` 自定义 logger 配置。
+
+## 默认配置
+
+如果不提供 `loggerConfig`，Gateway 会使用以下默认配置：
+
+```typescript
+{
+  name: "default",
+  description: "Default logger for lattice-gateway service",
+  type: LoggerType.PINO,
+  serviceName: "lattice/gateway",
+  loggerName: "lattice/gateway",
+  file: {
+    file: "./logs/lattice/gateway",
+    frequency: "daily",
+    mkdir: true,
+  },
+}
+```
+
+## 自定义配置示例
+
+### 示例 1: 自定义日志文件路径
+
+```typescript
+import { LatticeGateway } from "@axiom-lattice/gateway";
+import { LoggerType } from "@axiom-lattice/protocols";
+
+LatticeGateway.startAsHttpEndpoint({
+  port: 4001,
+  loggerConfig: {
+    file: "./logs/my-custom-app.log", // 简单字符串路径
+  },
+  queueServiceConfig: {
+    type: "memory",
+    defaultStartPollingQueue: true,
+  },
+});
+```
+
+### 示例 2: 详细文件配置
+
+```typescript
+import { LatticeGateway } from "@axiom-lattice/gateway";
+import { LoggerType } from "@axiom-lattice/protocols";
+
+LatticeGateway.startAsHttpEndpoint({
+  port: 4001,
+  loggerConfig: {
+    serviceName: "my-service",
+    loggerName: "my-logger",
+    file: {
+      file: "./logs/my-service", // 文件路径（不含扩展名）
+      frequency: "daily",          // 轮转频率: "daily" | "hourly" | "minutely"
+      mkdir: true,                 // 自动创建目录
+      maxFiles: 30,                // 保留30天的日志文件
+    },
+  },
+  queueServiceConfig: {
+    type: "memory",
+    defaultStartPollingQueue: true,
+  },
+});
+```
+
+### 示例 3: 使用控制台日志（开发环境）
+
+```typescript
+import { LatticeGateway } from "@axiom-lattice/gateway";
+import { LoggerType } from "@axiom-lattice/protocols";
+
+LatticeGateway.startAsHttpEndpoint({
+  port: 4001,
+  loggerConfig: {
+    type: LoggerType.CONSOLE, // 使用控制台输出
+    serviceName: "my-service",
+  },
+  queueServiceConfig: {
+    type: "memory",
+    defaultStartPollingQueue: true,
+  },
+});
+```
+
+### 示例 4: 仅覆盖部分配置
+
+```typescript
+import { LatticeGateway } from "@axiom-lattice/gateway";
+
+LatticeGateway.startAsHttpEndpoint({
+  port: 4001,
+  loggerConfig: {
+    // 只覆盖文件路径，其他使用默认值
+    file: "./logs/custom-path/app",
+  },
+  queueServiceConfig: {
+    type: "memory",
+    defaultStartPollingQueue: true,
+  },
+});
+```
+
+## 配置选项说明
+
+### GatewayLoggerConfig
+
+| 字段 | 类型 | 说明 | 默认值 |
+|------|------|------|--------|
+| `name` | `string?` | Logger 名称 | `"default"` |
+| `description` | `string?` | Logger 描述 | `"Default logger for lattice-gateway service"` |
+| `type` | `LoggerType?` | Logger 类型 | `LoggerType.PINO` |
+| `serviceName` | `string?` | 服务名称 | `"lattice/gateway"` |
+| `loggerName` | `string?` | Logger 实例名称 | `"lattice/gateway"` |
+| `file` | `string \| PinoFileOptions?` | 文件路径或详细配置 | `{ file: "./logs/lattice/gateway", frequency: "daily", mkdir: true }` |
+| `context` | `Record<string, any>?` | 初始上下文 | `{}` |
+
+### PinoFileOptions
+
+| 字段 | 类型 | 说明 | 默认值 |
+|------|------|------|--------|
+| `file` | `string?` | 日志文件路径 | `"./logs/app"` |
+| `frequency` | `"daily" \| "hourly" \| "minutely" \| string` | 日志轮转频率 | `"daily"` |
+| `mkdir` | `boolean?` | 自动创建目录 | `true` |
+| `size` | `string?` | 最大文件大小（如 "10M", "100K"） | - |
+| `maxFiles` | `number?` | 保留的最大文件数 | - |
+
+## 注意事项
+
+1. **配置合并**: 提供的 `loggerConfig` 会与默认配置合并，未指定的字段会使用默认值
+2. **文件路径**: 如果指定的是字符串路径，会自动使用默认的 `daily` 轮转策略
+3. **生产环境**: 在生产环境（`NODE_ENV=production`）下，如果没有指定 `file` 配置，会自动使用文件日志
+4. **开发环境**: 在开发环境下，如果没有指定 `file` 配置，会使用控制台输出（pino-pretty）

package/README.md

@@ -8,7 +8,8 @@
 - 代理调用服务
 - 流式响应支持
 - 事件总线
-- 队列服务
+- 队列服务（基于 QueueLattice）
+- 日志服务（基于 LoggerLattice，支持自定义配置）
 
 ## 安装
 
@@ -89,6 +90,31 @@ console.log(result); // { success: true, message: "Configuration updated success
 - `GET /api/v1/run/:thread_id`: 获取运行状态
 - `GET /api/v1/run/:thread_id/messages`: 获取消息历史
 
+## Logger 配置
+
+Gateway 使用 Logger Lattice 进行日志管理，支持自定义日志配置。详细说明请参考 [LOGGER_CONFIG.md](./LOGGER_CONFIG.md)。
+
+### 快速开始
+
+```typescript
+import { LatticeGateway } from "@axiom-lattice/gateway";
+import { LoggerType } from "@axiom-lattice/protocols";
+
+// 使用默认配置
+LatticeGateway.startAsHttpEndpoint({
+  port: 4001,
+});
+
+// 自定义日志配置
+LatticeGateway.startAsHttpEndpoint({
+  port: 4001,
+  loggerConfig: {
+    file: "./logs/my-app/gateway",
+    serviceName: "my-service",
+  },
+});
+```
+
 ## 目录结构
 
 - `src/config/`: 配置文件
@@ -96,3 +122,4 @@ console.log(result); // { success: true, message: "Configuration updated success
 - `src/routes/`: 路由定义
 - `src/services/`: 服务实现
 - `src/types/`: 类型定义
+- `LOGGER_CONFIG.md`: Logger 配置详细文档

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import * as http from 'http';
 import * as fastify from 'fastify';
+import { LoggerType, PinoFileOptions } from '@axiom-lattice/protocols';
 
 declare const defaultSwaggerConfig: {
     openapi: {
@@ -100,12 +101,25 @@ declare class AgentTaskConsumer {
     trigger_agent_task(taskRequest: AgentTaskRequest): void;
 }
 
+/**
+ * Logger configuration for gateway
+ */
+interface GatewayLoggerConfig {
+    name?: string;
+    description?: string;
+    type?: LoggerType;
+    serviceName?: string;
+    loggerName?: string;
+    file?: string | PinoFileOptions;
+    context?: Record<string, any>;
+}
 interface LatticeGatewayConfig {
     port?: number;
     queueServiceConfig?: {
         type: QueueServiceType;
         defaultStartPollingQueue: boolean;
     };
+    loggerConfig?: Partial<GatewayLoggerConfig>;
 }
 declare const LatticeGateway: {
     startAsHttpEndpoint: (config?: LatticeGatewayConfig) => Promise<void>;
@@ -117,4 +131,4 @@ declare const LatticeGateway: {
     AgentTaskConsumer: typeof AgentTaskConsumer;
 };
 
-export { LatticeGateway, type LatticeGatewayConfig };
+export { type GatewayLoggerConfig, LatticeGateway, type LatticeGatewayConfig };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as http from 'http';
 import * as fastify from 'fastify';
+import { LoggerType, PinoFileOptions } from '@axiom-lattice/protocols';
 
 declare const defaultSwaggerConfig: {
     openapi: {
@@ -100,12 +101,25 @@ declare class AgentTaskConsumer {
     trigger_agent_task(taskRequest: AgentTaskRequest): void;
 }
 
+/**
+ * Logger configuration for gateway
+ */
+interface GatewayLoggerConfig {
+    name?: string;
+    description?: string;
+    type?: LoggerType;
+    serviceName?: string;
+    loggerName?: string;
+    file?: string | PinoFileOptions;
+    context?: Record<string, any>;
+}
 interface LatticeGatewayConfig {
     port?: number;
     queueServiceConfig?: {
         type: QueueServiceType;
         defaultStartPollingQueue: boolean;
     };
+    loggerConfig?: Partial<GatewayLoggerConfig>;
 }
 declare const LatticeGateway: {
     startAsHttpEndpoint: (config?: LatticeGatewayConfig) => Promise<void>;
@@ -117,4 +131,4 @@ declare const LatticeGateway: {
     AgentTaskConsumer: typeof AgentTaskConsumer;
 };
 
-export { LatticeGateway, type LatticeGatewayConfig };
+export { type GatewayLoggerConfig, LatticeGateway, type LatticeGatewayConfig };

package/dist/index.js

@@ -1700,144 +1700,6 @@ var registerLatticeRoutes = (app2) => {
   app2.post("/api/schedules/:taskId/resume", resumeScheduledTask);
 };
 
-// src/logger/Logger.ts
-var import_pino = __toESM(require("pino"));
-var import_pino_pretty = require("pino-pretty");
-var import_pino_roll = require("pino-roll");
-var PinoLoggerFactory = class _PinoLoggerFactory {
-  constructor() {
-    const isProd = process.env.NODE_ENV === "production";
-    const loggerConfig = {
-      // 自定义时间戳格式
-      timestamp: () => `,"@timestamp":"${(/* @__PURE__ */ new Date()).toISOString()}"`,
-      // 关闭默认的时间戳键
-      base: {
-        "@version": "1",
-        app_name: "lattice",
-        service_name: "lattice/graph-server",
-        thread_name: "main",
-        logger_name: "lattice-graph-logger"
-      },
-      formatters: {
-        level: (label, number) => {
-          return {
-            level: label.toUpperCase(),
-            level_value: number * 1e3
-          };
-        }
-      }
-    };
-    if (isProd) {
-      try {
-        this.pinoLogger = (0, import_pino.default)(
-          loggerConfig,
-          import_pino.default.transport({
-            target: "pino-roll",
-            options: {
-              file: "./logs/fin_ai_graph_server",
-              frequency: "daily",
-              mkdir: true
-            }
-          })
-        );
-      } catch (error) {
-        console.error(
-          "\u65E0\u6CD5\u521D\u59CB\u5316 pino-roll \u65E5\u5FD7\u8BB0\u5F55\u5668\uFF0C\u56DE\u9000\u5230\u63A7\u5236\u53F0\u65E5\u5FD7",
-          error
-        );
-        this.pinoLogger = (0, import_pino.default)({
-          ...loggerConfig,
-          transport: {
-            target: "pino-pretty",
-            options: {
-              colorize: true
-            }
-          }
-        });
-      }
-    } else {
-      this.pinoLogger = (0, import_pino.default)({
-        ...loggerConfig,
-        transport: {
-          target: "pino-pretty",
-          options: {
-            colorize: true
-          }
-        }
-      });
-    }
-  }
-  static getInstance() {
-    if (!_PinoLoggerFactory.instance) {
-      _PinoLoggerFactory.instance = new _PinoLoggerFactory();
-    }
-    return _PinoLoggerFactory.instance;
-  }
-  getPinoLogger() {
-    return this.pinoLogger;
-  }
-};
-var Logger = class _Logger {
-  constructor(options) {
-    this.context = options?.context || {};
-    this.name = options?.name || "lattice-graph-logger";
-    this.serviceName = options?.serviceName || "lattice/graph-server";
-  }
-  /**
-   * 获取合并了上下文的日志对象
-   * @param additionalContext 额外的上下文数据
-   * @returns 带有上下文的pino日志对象
-   */
-  getContextualLogger(additionalContext) {
-    const pinoLogger = PinoLoggerFactory.getInstance().getPinoLogger();
-    const contextObj = {
-      "x-user-id": this.context["x-user-id"] || "",
-      "x-tenant-id": this.context["x-tenant-id"] || "",
-      "x-request-id": this.context["x-request-id"] || "",
-      "x-task-id": this.context["x-task-id"] || "",
-      "x-thread-id": this.context["x-thread-id"] || "",
-      service_name: this.serviceName,
-      logger_name: this.name,
-      ...additionalContext
-    };
-    return pinoLogger.child(contextObj);
-  }
-  info(msg, obj) {
-    this.getContextualLogger(obj).info(msg);
-  }
-  error(msg, obj) {
-    this.getContextualLogger(obj).error(msg);
-  }
-  warn(msg, obj) {
-    this.getContextualLogger(obj).warn(msg);
-  }
-  debug(msg, obj) {
-    this.getContextualLogger(obj).debug(msg);
-  }
-  /**
-   * 更新Logger实例的上下文
-   */
-  updateContext(context) {
-    this.context = {
-      ...this.context,
-      ...context
-    };
-  }
-  /**
-   * 创建一个新的Logger实例，继承当前Logger的上下文
-   */
-  child(options) {
-    return new _Logger({
-      name: options.name || this.name,
-      serviceName: options.serviceName || this.serviceName,
-      context: {
-        ...this.context,
-        ...options.context
-      }
-    });
-  }
-};
-
 // src/swagger.ts
 var import_swagger = __toESM(require("@fastify/swagger"));
 var import_swagger_ui = __toESM(require("@fastify/swagger-ui"));
@@ -2183,13 +2045,27 @@ _AgentTaskConsumer.agent_run_endpoint = "http://localhost:4001/api/runs";
 var AgentTaskConsumer = _AgentTaskConsumer;
 
 // src/index.ts
+var import_core10 = require("@axiom-lattice/core");
+var import_protocols2 = require("@axiom-lattice/protocols");
 process.on("unhandledRejection", (reason, promise) => {
   console.error("\u672A\u5904\u7406\u7684Promise\u62D2\u7EDD:", reason);
 });
-var logger = new Logger({
-  serviceName: "lattice-gateway",
-  name: "fastify-server"
-});
+var DEFAULT_LOGGER_CONFIG = {
+  name: "default",
+  description: "Default logger for lattice-gateway service",
+  type: import_protocols2.LoggerType.PINO,
+  serviceName: "lattice/gateway",
+  loggerName: "lattice/gateway"
+};
+var loggerLattice = initializeLogger(DEFAULT_LOGGER_CONFIG);
+var logger = loggerLattice.client;
+function initializeLogger(config) {
+  if (import_core10.loggerLatticeManager.hasLattice("default")) {
+    import_core10.loggerLatticeManager.removeLattice("default");
+  }
+  (0, import_core10.registerLoggerLattice)("default", config);
+  return (0, import_core10.getLoggerLattice)("default");
+}
 var app = (0, import_fastify.default)({
   logger: false,
   // 禁用内置日志记录器
@@ -2197,17 +2073,33 @@ var app = (0, import_fastify.default)({
   // Default 50MB, configurable via BODY_LIMIT env var
 });
 app.addHook("onRequest", (request, reply, done) => {
+  const getHeaderValue = (header) => {
+    if (Array.isArray(header)) {
+      return header[0];
+    }
+    return header;
+  };
   const context = {
-    "x-tenant-id": request.headers["x-tenant-id"],
-    "x-request-id": request.headers["x-request-id"]
+    "x-tenant-id": getHeaderValue(request.headers["x-tenant-id"]),
+    "x-request-id": getHeaderValue(request.headers["x-request-id"])
   };
+  if (loggerLattice.updateContext) {
+    loggerLattice.updateContext(context);
+  }
   done();
 });
 app.addHook("onResponse", (request, reply, done) => {
+  const getHeaderValue = (header) => {
+    if (Array.isArray(header)) {
+      return header[0];
+    }
+    return header;
+  };
   const context = {
-    "x-tenant-id": request.headers["x-tenant-id"],
-    "x-request-id": request.headers["x-request-id"]
+    "x-tenant-id": getHeaderValue(request.headers["x-tenant-id"]),
+    "x-request-id": getHeaderValue(request.headers["x-request-id"])
   };
+  loggerLattice.info(`${request.method} ${request.url} - ${reply.statusCode}`);
   done();
 });
 app.register(import_cors.default, {
@@ -2225,9 +2117,15 @@ app.register(import_cors.default, {
 });
 app.register(import_sensible.default);
 app.setErrorHandler((error, request, reply) => {
+  const getHeaderValue = (header) => {
+    if (Array.isArray(header)) {
+      return header[0];
+    }
+    return header;
+  };
   const context = {
-    "x-tenant-id": request.headers["x-tenant-id"],
-    "x-request-id": request.headers["x-request-id"]
+    "x-tenant-id": getHeaderValue(request.headers["x-tenant-id"]),
+    "x-request-id": getHeaderValue(request.headers["x-request-id"])
   };
   logger.error(
     `\u8BF7\u6C42\u9519\u8BEF: ${request.method} ${request.url} error:${error.message}`,
@@ -2243,9 +2141,19 @@ app.setErrorHandler((error, request, reply) => {
     error: error.message || "\u670D\u52A1\u5668\u5185\u90E8\u9519\u8BEF"
   });
 });
-app.decorate("logger", logger);
 var start = async (config) => {
   try {
+    if (config?.loggerConfig) {
+      const loggerConfig = {
+        ...DEFAULT_LOGGER_CONFIG,
+        ...config.loggerConfig,
+        // Merge file config if provided
+        file: config.loggerConfig.file || DEFAULT_LOGGER_CONFIG.file
+      };
+      loggerLattice = initializeLogger(loggerConfig);
+      logger = loggerLattice.client;
+    }
+    app.decorate("loggerLattice", loggerLattice);
     const target_port = config?.port || Number(process.env.PORT) || 4001;
     await app.listen({ port: target_port, host: "0.0.0.0" });
     logger.info(`Lattice Gateway is running on port: ${target_port}`);