@pluve/logger-sdk 0.0.26 → 0.0.28

package/README.md

@@ -1,10 +1,10 @@
-# Logger SDK v2 说明文档
+# @pluve/logger-sdk 说明文档
 
 ## 概览
 
-- 跨环境支持：浏览器与微信小程序
+- 环境支持：浏览器
 - 采集与采样：开关、日志等级白名单、分级/来源/路径采样率
-- 传输适配：Beacon、像素图 Image、微信 `wx.request`
+- 传输适配：Beacon、像素图 Image
 - 批量与队列：批量阈值与定时器、队列持久化（localforage）
 - 重试策略：可配置最大次数与指数退避
 - 压缩能力：可选 gzip 压缩，优先使用浏览器 CompressionStream，回退 fflate.gzipSync
@@ -12,7 +12,7 @@
 ## 快速开始
 
 ```ts
-import { LoggerSDK } from '@pluve/logger-sdk';
+import { LoggerSDK, SecurityType } from '@pluve/logger-sdk';
 
 const sdk = LoggerSDK.getInstance();
 
@@ -29,16 +29,17 @@ sdk.init({
   userId: 'u-001',
   storeCode: 's-001',
   token: '<token>',
+  securityType: SecurityType.BASE,
   sampleRate: 1,
   enableAutoCapture: true,
-  autoCapture: { js: true, promise: true, resource: true, wechat: true },
+  autoCapture: { js: true, promise: true, resource: true },
 });
 
 // 业务日志
 sdk.track({
   message: '用户点击了购买按钮',
   traceId: 'trace-xyz',
-  logLevel: 'INFO',
+  logLevel: 'ERROR',
 });
 
 // 动态设置
@@ -51,14 +52,20 @@ sdk.setStage('testing');
 
 - enableGzip：是否启用 gzip 压缩（默认 true）
 - enableBatch：是否启用批量上报（默认需显式开启）
-- batchSize：批量阈值（默认 10）
+- batchSize：批量阈值（默认 20）
 - batchInterval：批量定时器间隔（默认 15000ms）
 - maxPixelUrlLen：像素图 URL 最大长度（默认 8192）
 - enableStorage：队列持久化开关（默认 true）
-- enableRetry/maxRetries/retryDelay/retryBackoff：重试相关配置
+- storeCode：店铺编码（可选）
+- securityType：安全类型（默认 SecurityType.BASE / 'BASE'）
+  - SecurityType.ACCOUNT_CENTER / '2B'：账号中心
+  - SecurityType.EHP / 'EHP'：EHP 医疗
+  - SecurityType.CUSTOMER / 'CUSTOMER'：C 端会员（预留）
+  - SecurityType.BASE / 'BASE'：兜底 MD5
+- token：鉴权 Token
 - sampleRate/levelSampleRate/sourceSampleRate/pathSampleRate：采样配置
 - enableAutoCapture：自动采集总开关（默认开启）
-- autoCapture：细粒度开关 { js, promise, resource, wechat }
+- autoCapture：细粒度开关 { js, promise, resource }
 
 说明：
 
@@ -80,11 +87,7 @@ sdk.setStage('testing');
 ## 传输适配
 
 - TransportAdapter 根据环境选择传输器：
-  - 微信：WechatTransport（wx.request POST，支持 gzip）
   - 浏览器：优先 BeaconTransport（sendBeacon Blob），否则 PixelImageTransport（Image GET）
-- WechatTransport
-  - 请求体字符串化 safeStringify
-  - enableGzip 时使用 gzipCompress 生成 Base64，Content-Type 设为 `application/json; charset=utf-8`
 - PixelImageTransport
   - 字符串化 items，enableGzip 时压缩为 Base64；非 gzip 情况下优先使用全局 Base64，其次 btoa，再次 encodeURIComponent；URL 参数附带 `gzip=1`
   - 构造像素上报 URL（含 appId、appStage、items、cacheBuster）
@@ -95,7 +98,6 @@ sdk.setStage('testing');
 代码参考：
 
 - 适配器选择：[transportAdapter.ts](./src/transport/transportAdapter.ts)
-- WeChat：[wechatTransport.ts](./src/transport/wechatTransport.ts)
 - Pixel Image：[pixelImageTransport.ts](./src/transport/pixelImageTransport.ts)
 - Beacon：[beaconTransport.ts](./src/transport/beaconTransport.ts)
 
@@ -145,8 +147,8 @@ sdk.setStage('testing');
 ## 流程图
 
 - 完整 Mermaid 流程图见文件：
-  - [logger-sdk.mermaid](./src/logger-sdk.mermaid)
-  - [logger-sdk.svg](./src/logger-sdk.svg)
+  - [logger-sdk.mermaid](./docs/logger-sdk.mermaid)
+  - [logger-sdk.svg](./docs/logger-sdk.svg)
 
 ## 类型与打包
 
@@ -173,17 +175,6 @@ sdk.setStage('testing');
 
 ## 编码细节（传输 × 压缩）
 
-- WechatTransport（POST）
-  - 未压缩
-    - Body：JSON（safeStringify(payload)）
-    - Header：Content-Type: application/json；token: <opts.token>
-    - items：字符串化后的数组（message/throwable 等为字符串）
-    - Endpoint：[config.getReportApi](.src/config/index.ts)
-  - 启用压缩
-    - items：safeStringify(items) 后使用 [gzipCompress](.src/compress/compression.ts) 生成 Base64
-    - Body：JSON（...payload, items: Base64）
-    - Header：Content-Type: application/json; charset=utf-8；token: <opts.token>
-
 - BeaconTransport（sendBeacon）
   - 未压缩
     - Body：JSON（safeStringify(payload)）

package/dist/esm/core/loggerSDK.js

@@ -21,6 +21,7 @@ var LoggerSDK = class {
     this.closed = false;
     /** 预收集的环境信息 tags（仅用于初始化上报） */
     this.envTags = {};
+    this.envTagsStr = "";
     /** 是否已初始化 */
     this.initialized = false;
     /** 是否正在上报 */
@@ -46,6 +47,8 @@ var LoggerSDK = class {
       // endpoint: options.endpoint,
       appId: `${options.appId}`,
       // 统一与 zadig 部署应用 APPID 保持一致
+      /** 应用版本 */
+      appVersion: options.appVersion || "unknown",
       env: options.env || "develop",
       /** 日志环境 */
       logStage: options.logStage,
@@ -64,7 +67,7 @@ var LoggerSDK = class {
       // 持久化存储配置
       enableStorage: options.enableBatch === true || options.enableStorage !== false,
       // 默认启用
-      storagePrefix: options.storagePrefix || "logger_sdk",
+      storagePrefix: options.storagePrefix || `${options.appId}_logger_sdk`,
       // 重试配置
       enableRetry: options.enableRetry !== false,
       // 默认启用
@@ -79,19 +82,19 @@ var LoggerSDK = class {
       token: options.token,
       sampleRate: typeof options.sampleRate === "number" ? options.sampleRate : 1,
       levelSampleRate: options.levelSampleRate || {
-        ERROR: 0.8,
-        WARN: 0.5,
-        INFO: 0.1,
-        FATAL: 1
+        ERROR: 80,
+        WARN: 50,
+        INFO: 10,
+        FATAL: 100
       },
       sourceSampleRate: options.sourceSampleRate || {
-        js: 0.8,
-        promise: 0.5,
-        resource: 0.2,
-        custom: 1
+        js: 80,
+        promise: 50,
+        resource: 20,
+        custom: 100
       },
       pathSampleRate: options.pathSampleRate || {
-        "/": 1
+        "/": 100
       },
       enableAutoCapture: options.enableAutoCapture !== false,
       // 默认启用
@@ -120,6 +123,7 @@ var LoggerSDK = class {
     this.transporter = void 0;
     this.sessionId = getSessionId();
     this.envTags = collectEnvironmentTags();
+    this.envTagsStr = this.flattenEnvTags();
     this.initSDK(this.opts, (data) => {
       var _a, _b, _c, _d, _e, _f;
       this.collectSwitch = data.collectSwitch;
@@ -136,16 +140,10 @@ var LoggerSDK = class {
         this.offJs = registerJsErrorCapture(!!((_d = this.opts) == null ? void 0 : _d.debug), this.trackInner.bind(this));
       }
       if (enableAuto && ac.promise !== false) {
-        this.offPromise = registerPromiseErrorCapture(
-          !!((_e = this.opts) == null ? void 0 : _e.debug),
-          this.trackInner.bind(this)
-        );
+        this.offPromise = registerPromiseErrorCapture(!!((_e = this.opts) == null ? void 0 : _e.debug), this.trackInner.bind(this));
       }
       if (enableAuto && ac.resource !== false) {
-        this.offResource = registerResourceErrorCapture(
-          !!((_f = this.opts) == null ? void 0 : _f.debug),
-          this.trackInner.bind(this)
-        );
+        this.offResource = registerResourceErrorCapture(!!((_f = this.opts) == null ? void 0 : _f.debug), this.trackInner.bind(this));
       }
     });
   }
@@ -190,6 +188,10 @@ var LoggerSDK = class {
   flattenEnvTags() {
     return Object.entries(this.envTags || {}).map(([k, v]) => `${k}=${v}`).join(",");
   }
+  buildLogMessage(logType, message) {
+    var _a, _b, _c;
+    return `[logType]: ${logType}; [appVersion]: ${((_a = this.opts) == null ? void 0 : _a.appVersion) || "unknown"}; [userId]: ${((_b = this.opts) == null ? void 0 : _b.userId) || "unknown"}; [storeCode]: ${((_c = this.opts) == null ? void 0 : _c.storeCode) || "unknown"}; [message]: ${message}; [envTags]: ${this.envTagsStr}; [t]: ${now()}`;
+  }
   async track({ message, error, traceId, logLevel = "INFO" }) {
     var _a, _b, _c;
     logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "track", { message, error, traceId, logLevel });
@@ -236,7 +238,7 @@ var LoggerSDK = class {
       url: getCurrentUrl(),
       location: errorLocation,
       /** 异常信息 */
-      message: `[message]: ${message}; [envTags]: ${this.flattenEnvTags()}; [t]: ${now()}`,
+      message: this.buildLogMessage("custom", message),
       /** 可选：堆栈信息（长字符串） */
       throwable: throwableStack,
       /** 可选：用户 ID（脱敏） */
@@ -292,7 +294,7 @@ var LoggerSDK = class {
       url: getCurrentUrl(),
       location: errorLocation,
       /** 异常信息 */
-      message: `[message]: ${error.message}; [envTags]: ${this.flattenEnvTags()}; [t]: ${now()}`,
+      message: this.buildLogMessage(error.type, error.message),
       /** 可选：堆栈信息（长字符串） */
       throwable: throwableStack,
       /** 可选：用户 ID（脱敏） */
@@ -304,11 +306,24 @@ var LoggerSDK = class {
     };
     this.doTrack(logEvent);
   }
+  getBaseRate(source) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    switch (source) {
+      case "js":
+        return ((_a = this.opts) == null ? void 0 : _a.sourceSampleRate.js) || ((_b = this.opts) == null ? void 0 : _b.sampleRate) || 100;
+      case "promise":
+        return ((_c = this.opts) == null ? void 0 : _c.sourceSampleRate.promise) || ((_d = this.opts) == null ? void 0 : _d.sampleRate) || 100;
+      case "resource":
+        return ((_e = this.opts) == null ? void 0 : _e.sourceSampleRate.resource) || ((_f = this.opts) == null ? void 0 : _f.sampleRate) || 100;
+      case "custom":
+        return ((_g = this.opts) == null ? void 0 : _g.sampleRate) || ((_h = this.opts) == null ? void 0 : _h.sourceSampleRate.custom) || 100;
+    }
+  }
   /**
    * 判断是否应该发送事件
    */
   shouldSend(level, source, url, traceId, message) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e;
     if (level === "FATAL")
       return true;
     if (this.collectSwitch === 0) {
@@ -319,37 +334,14 @@ var LoggerSDK = class {
       logDebug(!!((_b = this.opts) == null ? void 0 : _b.debug), `Log level(${level}) not in collect log level, skip track`);
       return false;
     }
-    const levelRate = (_d = (_c = this.opts) == null ? void 0 : _c.levelSampleRate) == null ? void 0 : _d[level];
-    const sourceRate = (_f = (_e = this.opts) == null ? void 0 : _e.sourceSampleRate) == null ? void 0 : _f[source];
-    let pathRate;
-    const pathMap = ((_g = this.opts) == null ? void 0 : _g.pathSampleRate) || {};
-    const prefixes = Object.keys(pathMap);
-    if (prefixes.length) {
-      let best = "";
-      for (let i = 0; i < prefixes.length; i += 1) {
-        const p2 = prefixes[i];
-        if (url.startsWith(p2) && p2.length >= best.length)
-          best = p2;
-      }
-      if (best)
-        pathRate = pathMap[best];
-    }
-    const baseRate = (() => {
-      var _a2;
-      if (typeof levelRate === "number")
-        return levelRate;
-      if (typeof sourceRate === "number")
-        return sourceRate;
-      if (typeof pathRate === "number")
-        return pathRate;
-      const sr = (_a2 = this.opts) == null ? void 0 : _a2.sampleRate;
-      return typeof sr === "number" ? sr : 1;
-    })();
-    const rate = Math.max(0, Math.min(1, baseRate));
-    if (rate >= 1)
+    const rate = Math.max(0, Math.min(100, this.getBaseRate(source)));
+    logDebug(!!((_c = this.opts) == null ? void 0 : _c.debug), "shouldSend rate: ", rate);
+    if (rate >= 100)
       return true;
-    const seed = `${String(traceId || "")}|${String(message || "")}|${String(this.sessionId || "")}|${String(level)}|${String(source)}|${String(url)}`;
-    const p = hashToProb(seed);
+    const seed = normalizeMessage(`${url}${traceId || ""}${message || ""}`);
+    logDebug(!!((_d = this.opts) == null ? void 0 : _d.debug), "shouldSend seed: ", seed);
+    const p = hashToProb(seed) * 100;
+    logDebug(!!((_e = this.opts) == null ? void 0 : _e.debug), "shouldSend p: ", p);
     return p < rate;
   }
   /**

package/dist/esm/index.js

@@ -1,5 +1,7 @@
 // src/index.ts
 import { LoggerSDK } from "./core/loggerSDK";
+import { SecurityType } from "./types/securityType";
 export {
-  LoggerSDK
+  LoggerSDK,
+  SecurityType
 };

package/dist/types/core/loggerSDK.d.ts

@@ -11,6 +11,7 @@ export declare class LoggerSDK {
     private closed;
     /** 预收集的环境信息 tags（仅用于初始化上报） */
     private envTags;
+    private envTagsStr;
     /** 是否已初始化 */
     private initialized;
     /** 初始化时生成并锁定的会话标识 */
@@ -50,8 +51,10 @@ export declare class LoggerSDK {
     /** 设置日志 stage（env） */
     setStage(stage: Env): void;
     private flattenEnvTags;
+    private buildLogMessage;
     track({ message, error, traceId, logLevel }: TrackOptions): Promise<void>;
     private trackInner;
+    private getBaseRate;
     /**
      * 判断是否应该发送事件
      */

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export { LoggerSDK } from './core/loggerSDK';
 export type { Env, Stage } from './types/env';
-export type { SecurityType } from './types/securityType';
+export { SecurityType } from './types/securityType';
 export type { TrackOptions } from './types/trackOptions';

package/dist/types/types/sdkOptions.d.ts

@@ -14,13 +14,13 @@ export interface SDKOptions {
     debug?: boolean;
     /** 是否启用批量上报，默认 true */
     enableBatch?: boolean;
-    /** 批量上报最大数量，默认 10 */
+    /** 批量上报最大数量，默认 20 */
     batchSize?: number;
     /** 是否启用 gzip 压缩，默认 true (仅在批量模式下有效) */
     enableGzip?: boolean;
-    /** 最大像素图 URL 长度，默认 1900 */
+    /** 最大像素图 URL 长度，默认 8192 */
     maxPixelUrlLen?: number;
-    /** 批量上报时间间隔（毫秒），默认 5000 */
+    /** 批量上报时间间隔（毫秒），默认 15000 */
     batchInterval?: number;
     /** 队列最大长度，默认 100 */
     maxQueueSize?: number;
@@ -46,11 +46,11 @@ export interface SDKOptions {
     token: string;
     /** 全局采样率 0.0-1.0，默认 1.0（全量） */
     sampleRate?: number;
-    /** 分级采样率，优先于全局采样率 */
+    /** 分级采样率，优先于全局采样率。默认 { ERROR: 0.8, WARN: 0.5, INFO: 0.1, FATAL: 1 } */
     levelSampleRate?: Partial<Record<LogEventLevel, number>>;
-    /** 事件来源采样率（js/promise/resource/custom），优先于全局采样率 */
+    /** 事件来源采样率（js/promise/resource/custom），优先于全局采样率。默认 { js: 0.8, promise: 0.5, resource: 0.2, custom: 1 } */
     sourceSampleRate?: Partial<Record<'js' | 'promise' | 'resource' | 'custom', number>>;
-    /** 页面路径采样率，key 为路径前缀，优先于全局采样率 */
+    /** 页面路径采样率，key 为路径前缀，优先于全局采样率。默认 { '/': 1 } */
     pathSampleRate?: Record<string, number>;
     autoCapture?: {
         js?: boolean;
@@ -58,4 +58,5 @@ export interface SDKOptions {
         resource?: boolean;
     };
     enableAutoCapture?: boolean;
+    appVersion?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluve/logger-sdk",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "logger sdk",
   "keywords": [
     "logger"