@pluve/logger-sdk 0.0.2 → 0.0.4

package/README.md

@@ -35,6 +35,12 @@ sdk.track('error', 'TypeError: Cannot read property', {
   },
 });
 
+// 记录带 traceId 的错误（用于关联多个日志）
+sdk.track('error', 'Request failed', 'trace-abc-123', {
+  level: 'error',
+  tags: { api: '/api/user' },
+});
+
 // 记录自定义事件
 sdk.track('custom', 'User clicked button', {
   level: 'info',
@@ -48,6 +54,8 @@ sdk.track('custom', 'User clicked button', {
 
 ```typescript
 {
+  "logId": "550e8400-e29b-41d4-a716-446655440000",  // 日志 ID（UUID v4）
+  "traceId": "trace-123456",    // 可选：追踪 ID（用于关联多个日志）
   "eventType": "error",          // 固定：error/crash/pageview/custom
   "ts": 1690000000000,           // 毫秒时间戳
   "appId": "web-shop",           // 应用标识
@@ -84,14 +92,15 @@ interface SDKOptions {
 }
 ```
 
-### `track(eventType, message, options?)`
+### `track(eventType, message, traceId?, options?)`
 
-记录事件日志。
+记录事件日志。每条日志会自动生成唯一的 `logId`（UUID v4 格式）。
 
 **参数：**
 
 - `eventType`: 事件类型（`'error' | 'crash' | 'pageview' | 'custom'`）
 - `message`: 摘要信息
+- `traceId`: (可选) 追踪 ID，用于关联多个相关日志
 - `options`: 可选配置
   - `level?`: 日志级别（`'info' | 'warn' | 'error' | 'fatal'`），默认 `'info'`
   - `stack?`: 堆栈信息
@@ -109,6 +118,12 @@ sdk.track('error', 'Failed to load resource', {
   tags: { resource: 'image.png' },
 });
 
+// 记录带 traceId 的错误（用于关联多个日志）
+sdk.track('error', 'API request failed', 'trace-xyz-789', {
+  level: 'error',
+  tags: { endpoint: '/api/users', statusCode: 500 },
+});
+
 // 记录页面浏览
 sdk.track('pageview', 'User viewed product page', {
   level: 'info',
@@ -116,6 +131,29 @@ sdk.track('pageview', 'User viewed product page', {
 });
 ```
 
+### 日志 ID 和追踪 ID
+
+- **logId**: 每条日志自动生成的唯一标识符（UUID v4 格式），用于全局唯一定位日志
+- **traceId**: 可选的追踪 ID，用于关联同一请求链路上的多个日志（例如：前端请求、后端处理、数据库查询等）
+
+```typescript
+// 在请求开始时生成 traceId
+const traceId = `trace-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
+
+// 在请求的不同阶段使用相同的 traceId
+sdk.track('custom', 'Request started', traceId, {
+  level: 'info',
+  tags: { endpoint: '/api/checkout' },
+});
+
+// ... 请求处理 ...
+
+sdk.track('error', 'Request failed', traceId, {
+  level: 'error',
+  tags: { endpoint: '/api/checkout', error: 'Network timeout' },
+});
+```
+
 ### `identify(userId: string)`
 
 设置用户 ID（用于后续日志关联）。

package/dist/{cjs/index.d.ts → index.d.ts}

@@ -3,4 +3,4 @@ export { defaultTransport, TransportAdapters } from './transportAdapter';
 export type { TransportAdapter, TransportOptions } from './transportAdapter';
 export type { SDKOptions, LogEvent, LogEventType, LogEventLevel, Env } from './types';
 export type { PlatformType, EnvironmentInfo } from './utils';
-export { getEnvironmentInfo, parseBrowserInfo, isWeChatMiniProgram } from './utils';
+export { getEnvironmentInfo, parseBrowserInfo, isWeChatMiniProgram, gzipCompress, isGzipSupported } from './utils';

package/dist/{esm/index.js → index.js}

@@ -2,10 +2,10 @@
  * @Author       : 黄震 huangzhen@yfpharmacy.com
  * @Date         : 2025-11-21 14:25:26
  * @LastEditors  : 黄震 huangzhen@yfpharmacy.com
- * @LastEditTime : 2025-12-04 14:35:00
+ * @LastEditTime : 2025-12-04 15:56:03
  * @Description  : 描述
  * Copyright (c) 2025 by 益丰大药房连锁股份有限公司, All Rights Reserved.
  */
 export { LoggerSDK } from "./loggerSDK";
 export { defaultTransport, TransportAdapters } from "./transportAdapter";
-export { getEnvironmentInfo, parseBrowserInfo, isWeChatMiniProgram } from "./utils";
+export { getEnvironmentInfo, parseBrowserInfo, isWeChatMiniProgram, gzipCompress, isGzipSupported } from "./utils";

package/dist/{cjs/loggerSDK.d.ts → loggerSDK.d.ts}

@@ -14,7 +14,7 @@ export declare class LoggerSDK {
     /**
      * 记录事件
      */
-    track(eventType: LogEventType, message: string, options?: {
+    track(eventType: LogEventType, message: string, traceId?: string, options?: {
         level?: LogEventLevel;
         stack?: string;
         userId?: string;

package/dist/{esm/loggerSDK.js → loggerSDK.js}

@@ -11,7 +11,7 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 import { defaultTransport } from "./transportAdapter";
-import { isBrowser, isWeChatMiniProgram, now, getSessionId, getCurrentUrl, getEnvironmentInfo, parseBrowserInfo } from "./utils";
+import { isBrowser, isWeChatMiniProgram, now, getSessionId, getCurrentUrl, getEnvironmentInfo, parseBrowserInfo, generateUUID } from "./utils";
 export var LoggerSDK = /*#__PURE__*/function () {
   function LoggerSDK(options) {
     _classCallCheck(this, LoggerSDK);
@@ -26,7 +26,8 @@ export var LoggerSDK = /*#__PURE__*/function () {
       env: options.env || 'dev',
       debug: !!options.debug,
       pixelParam: options.pixelParam || 'data',
-      maxPixelUrlLen: options.maxPixelUrlLen || 1900
+      maxPixelUrlLen: options.maxPixelUrlLen || 1900,
+      enableGzip: !!options.enableGzip
     };
 
     // 初始化时收集环境信息
@@ -88,7 +89,7 @@ export var LoggerSDK = /*#__PURE__*/function () {
   }, {
     key: "track",
     value: (function () {
-      var _track = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(eventType, message, options) {
+      var _track = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(eventType, message, traceId, options) {
         var logEvent;
         return _regeneratorRuntime().wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
@@ -103,6 +104,9 @@ export var LoggerSDK = /*#__PURE__*/function () {
 
               // 构建标准化日志格式
               logEvent = {
+                logId: "".concat(this.opts.appId).concat(generateUUID()).concat(now()),
+                // UUID
+                traceId: traceId,
                 eventType: eventType,
                 ts: now(),
                 appId: this.opts.appId || 'unknown',
@@ -134,7 +138,7 @@ export var LoggerSDK = /*#__PURE__*/function () {
           }
         }, _callee, this, [[5, 10]]);
       }));
-      function track(_x, _x2, _x3) {
+      function track(_x, _x2, _x3, _x4) {
         return _track.apply(this, arguments);
       }
       return track;

package/dist/{esm/transportAdapter.js → transportAdapter.js}

@@ -6,12 +6,12 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
  * @Author       : 黄震 huangzhen@yfpharmacy.com
  * @Date         : 2025-11-21 14:35:48
  * @LastEditors  : 黄震 huangzhen@yfpharmacy.com
- * @LastEditTime : 2025-12-04 14:30:00
+ * @LastEditTime : 2025-12-04 22:00:00
  * @Description  : 传输适配器 - Beacon、像素图和微信小程序方式
  * Copyright (c) 2025 by 益丰大药房连锁股份有限公司, All Rights Reserved.
  */
 
-import { safeStringify, isBrowser, isWeChatMiniProgram, now } from "./utils";
+import { safeStringify, isBrowser, isWeChatMiniProgram, now, gzipCompress } from "./utils";
 
 /** 传输选项接口 */
 
@@ -40,22 +40,34 @@ export var beaconTransport = {
   },
   send: function send(payload, opts) {
     return _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
-      var body, endpoint, blob, success;
+      var body, endpoint, contentType, blob, success;
       return _regeneratorRuntime().wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             body = typeof payload === 'string' ? payload : safeStringify(payload);
-            endpoint = getEndpoint(opts); // sendBeacon 使用 Blob 确保正确的 Content-Type
+            endpoint = getEndpoint(opts); // 如果启用 gzip 压缩
+            contentType = 'application/json';
+            if (!(opts !== null && opts !== void 0 && opts.enableGzip)) {
+              _context.next = 8;
+              break;
+            }
+            _context.next = 6;
+            return gzipCompress(body);
+          case 6:
+            body = _context.sent;
+            contentType = 'application/json; charset=utf-8';
+          case 8:
+            // sendBeacon 使用 Blob 确保正确的 Content-Type
             blob = new Blob([body], {
-              type: 'application/json'
+              type: contentType
             });
             success = navigator.sendBeacon(endpoint, blob);
             if (success) {
-              _context.next = 6;
+              _context.next = 12;
               break;
             }
             throw new Error('sendBeacon failed (queue full or other error)');
-          case 6:
+          case 12:
           case "end":
             return _context.stop();
         }
@@ -79,13 +91,25 @@ export var wechatTransport = {
   },
   send: function send(payload, opts) {
     return _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
-      var body, endpoint, timeout;
+      var body, endpoint, timeout, contentType;
       return _regeneratorRuntime().wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
             body = typeof payload === 'string' ? payload : safeStringify(payload);
             endpoint = getEndpoint(opts);
             timeout = 10000; // 10秒超时
+            // 如果启用 gzip 压缩
+            contentType = 'application/json';
+            if (!(opts !== null && opts !== void 0 && opts.enableGzip)) {
+              _context2.next = 9;
+              break;
+            }
+            _context2.next = 7;
+            return gzipCompress(body);
+          case 7:
+            body = _context2.sent;
+            contentType = 'application/json; charset=utf-8';
+          case 9:
             return _context2.abrupt("return", new Promise(function (resolve, reject) {
               var timeoutId = null;
               var settled = false;
@@ -104,7 +128,7 @@ export var wechatTransport = {
                 method: 'POST',
                 data: body,
                 header: {
-                  'Content-Type': 'application/json'
+                  'Content-Type': contentType
                 },
                 success: function success(res) {
                   if (timeoutId) clearTimeout(timeoutId);
@@ -126,7 +150,7 @@ export var wechatTransport = {
                 }
               });
             }));
-          case 4:
+          case 10:
           case "end":
             return _context2.stop();
         }

package/dist/{esm/types.d.ts → types.d.ts}

@@ -9,7 +9,7 @@ export interface SDKOptions {
     /** 上报端点 URL */
     endpoint: string;
     /** 应用 ID */
-    appId?: string;
+    appId: string;
     /** 环境标识 */
     env?: Env;
     /** 是否开启调试模式 */
@@ -18,9 +18,13 @@ export interface SDKOptions {
     pixelParam?: string;
     /** 像素上报 URL 最大长度，默认 1900 */
     maxPixelUrlLen?: number;
+    /** 是否启用 gzip 压缩，默认 false */
+    enableGzip?: boolean;
 }
 /** 标准化日志上报格式 */
 export interface LogEvent {
+    logId: string;
+    traceId?: string;
     /** 事件类型：error/crash/pageview/custom */
     eventType: LogEventType;
     /** 毫秒时间戳 */

package/dist/{esm/utils.d.ts → utils.d.ts}

@@ -1,7 +1,24 @@
 export declare const now: () => number;
+/**
+ * 生成 UUID v4
+ * 符合 RFC 4122 标准
+ * 格式: xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx
+ * 其中 x 是 0-f 的十六进制数字,y 是 8/9/a/b 之一
+ */
+export declare function generateUUID(): string;
 export declare function isBrowser(): boolean;
 export declare function isWeChatMiniProgram(): boolean;
 export declare function safeStringify(obj: any): string;
+/**
+ * gzip 压缩字符串
+ * @param data - 需要压缩的字符串
+ * @returns 压缩后的 Base64 字符串
+ */
+export declare function gzipCompress(data: string): Promise<string>;
+/**
+ * 检查是否支持 gzip 压缩
+ */
+export declare function isGzipSupported(): boolean;
 export declare function getSessionId(): string;
 export declare function getCurrentUrl(): string;
 /** 平台类型 */