@blueking/open-telemetry 0.0.5 → 0.0.6

package/dist/plugins/csp-violation.d.ts

@@ -1,6 +1,19 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
 /**
- * 监听 CSP 违规事件并以 log 形式上报，便于排查脚本/资源被 CSP 拦截的问题。
+ * CSP 违规事件采集插件，通过监听 `securitypolicyviolation` 事件捕获被 CSP 策略拦截的脚本/资源，
+ * 以 WARN 级别 log 上报，便于排查 CSP 配置错误或潜在的注入攻击信号。
+ *
+ * 节流策略：
+ * - 同 fingerprint（`violatedDirective + blockedURI + sourceFile + lineNumber`）
+ *   在 60s 窗口内最多上报 5 条，避免风暴打爆 collector（如某段被拦截的 inline 脚本被反复渲染）。
+ * - 每条 attribute 带 `csp.window_count`，反映当前窗口内同 fingerprint 的总触发次数（含被丢弃的）。
+ *
+ * 体积优化：
+ * - `csp.original_policy`（完整 CSP 策略，可能数 KB）仅在窗口首条上报，后续同 fingerprint 不再重复携带。
+ *
+ * URL 处理：
+ * - `blockedURI` / `sourceFile` 中的 URL 类值会经 `redactUrl` 脱敏。
+ * - `blockedURI` 是 'inline' / 'eval' 等 CSP 关键字时直接保留，不调用 redactUrl。
  */
-export declare const createCspViolationPlugin: (enabled: BkOTRumConfig["cspViolation"]) => BkOTPlugin;
+export declare const createCspViolationPlugin: (option: BkOTRumConfig["cspViolation"]) => BkOTPlugin;

package/dist/plugins/device.d.ts

@@ -1,7 +1,23 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
 /**
- * 设备级永久标识 + 视口 / 网络元数据。
- * 与 session 插件区分：device 跨会话持久，session 有过期与续期。
+ * 设备元数据采集插件，把"设备级"信息写入 SDK 的 runtimeAttributes，
+ * 让所有 log/span 都自动带上这些维度。
+ *
+ * 上报字段：
+ * - `device.id`：设备级永久标识，存于 localStorage（默认 key 复用旧 session 插件以保留现网用户）。
+ * - `device.memory` / `device.cpu_cores` / `device.platform` / `device.mobile`：硬件能力快照（运行期不变）。
+ * - `browser.viewport.*` / `browser.screen.*`：视口与屏幕尺寸。
+ * - `network.effective_type` / `network.connection_type` / `network.downlink` / `network.rtt` / `network.save_data`：
+ *   网络信息。
+ *
+ * 实时更新：
+ * - viewport 监听 `resize` / `orientationchange`，并经 250ms debounce 合并，避免拖窗口时高频触发；
+ *   静默期结束后用最终值刷新 runtimeAttributes。
+ * - network 监听 `connection.change`（本身低频，不需要 throttle）。
+ * - 二者只更新 in-memory 的 runtimeAttributes，不会主动产生新的 span/log，cardinality 安全；
+ *   但更新后续生成的 log/span 会带最新值。
+ *
+ * 与 session 插件的关系：device 跨会话持久（终身），session 有过期与续期（连续访问语义）。
  */
 export declare const createDevicePlugin: (option: BkOTRumConfig["device"]) => BkOTPlugin;

package/dist/plugins/http-body.d.ts

@@ -1,20 +1,3 @@
 import type { BkOTHttpBodyConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-interface BodySnapshot {
-    body: string;
-    contentType?: string;
-    truncated: boolean;
-}
 export declare const createHttpBodyPlugin: (option: false | Required<BkOTHttpBodyConfig>) => BkOTPlugin;
-declare global {
-    interface XMLHttpRequest {
-        __bkOtHttpBodyRequest__?: BodySnapshot;
-        __bkOtHttpBodyRequestHeaders__?: Record<string, string>;
-        __bkOtHttpBodyMeta__?: {
-            method: string;
-            startTime: number;
-            url: string;
-        };
-    }
-}
-export {};

package/dist/plugins/long-task.d.ts

@@ -1,7 +1,15 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
 /**
- * Long Task 监控：通过 PerformanceObserver type=longtask 捕获 >= threshold 的主线程长任务。
- * 默认关闭，建议在性能敏感模块按需开启。
+ * Long Task 监控插件，通过 PerformanceObserver 捕获主线程上 >= threshold（默认 50ms）的长任务，
+ * 上报为 metric（counter + duration histogram），用于评估页面卡顿趋势。
+ *
+ * 使用建议：
+ * - 默认关闭，建议在性能敏感模块按需开启。
+ * - PerformanceObserver 使用 `buffered: true`，能拿到 observer 创建之前已发生的 longtask，避免漏掉早期阶段。
+ *
+ * 兼容性：
+ * - 仅在 PerformanceObserver 与 `supportedEntryTypes` 包含 `longtask` 的浏览器上启用，否则 init 直接 return；
+ *   Firefox 当前不支持 longtask，会自动跳过。
  */
 export declare const createLongTaskPlugin: (option: BkOTRumConfig["longTask"]) => BkOTPlugin;

package/dist/plugins/page-view.d.ts

@@ -1,3 +1,3 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createPageViewPlugin: (enabled: BkOTRumConfig["pageView"]) => BkOTPlugin;
+export declare const createPageViewPlugin: (option: BkOTRumConfig["pageView"]) => BkOTPlugin;

package/dist/plugins/route-timing.d.ts

@@ -1,7 +1,3 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-/**
- * 估算 SPA 路由切换耗时：路由变更 → 双 raf + 一个宏任务后视为"渲染完成"。
- * 不依赖具体框架，但仅是粗粒度估算；如需精确，业务可走自定义 plugin 在框架钩子内 startSpan/end。
- */
-export declare const createRouteTimingPlugin: (enabled: BkOTRumConfig["routeTiming"]) => BkOTPlugin;
+export declare const createRouteTimingPlugin: (option: BkOTRumConfig["routeTiming"]) => BkOTPlugin;

package/dist/plugins/session.d.ts

@@ -1,7 +1,3 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-/**
- * 会话级标识：带不活跃过期时间，超过 inactivityMs 视为新会话。
- * 与 device 插件互补：device 是设备终身标识，session 反映"用户连续访问"语义。
- */
 export declare const createSessionPlugin: (option: BkOTRumConfig["session"]) => BkOTPlugin;

package/dist/plugins/web-vitals.d.ts

@@ -1,3 +1,3 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createWebVitalsPlugin: (enabled: BkOTRumConfig["webVitals"]) => BkOTPlugin;
+export declare const createWebVitalsPlugin: (option: BkOTRumConfig["webVitals"]) => BkOTPlugin;

package/dist/plugins/websocket.d.ts

@@ -1,3 +1,3 @@
 import type { BkOTRumConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createWebSocketPlugin: (enabled: BkOTRumConfig["websocket"]) => BkOTPlugin;
+export declare const createWebSocketPlugin: (option: BkOTRumConfig["websocket"]) => BkOTPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueking/open-telemetry",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "OpenTelemetry browser SDK for BK RUM",
   "author": "TencentCloud Real User Monitoring",
   "main": "dist/index.js",
@@ -47,7 +47,7 @@
     "vite": "^8.0.2",
     "vite-bundle-analyzer": "^1.3.2",
     "vue": "^3.5.34",
-    "vue-router": "^4.5.0",
+    "vue-router": "^5.0.6",
     "vue-tsc": "^3.1.4"
   }
 }