sobey-monitor-sdk 1.0.4 → 1.0.6

package/README.md

@@ -35,6 +35,22 @@ monitor.init({
 ### `monitor.setUser(userInfo)`
 设置当前用户信息，方便追踪。
 
+### `monitor.updateConfig(partialConfig)`
+动态更新 SDK 配置。可以在运行时修改采样率、调试模式等配置。
+
+```javascript
+// 示例：动态开启调试模式
+monitor.updateConfig({ debug: true });
+
+// 示例：动态调整采样率
+monitor.updateConfig({
+  sampling: { error: 0.5, performance: 0.1 }
+});
+```
+
+### `monitor.getConfig()`
+获取当前 SDK 配置。
+
 ### `monitor.captureError(error, extra)`
 手动上报异常或错误。
 
@@ -103,17 +119,14 @@ ReactDOM.render(
 | `sampling.error` | number | 1 | 错误采样率 (0-1) |
 | `sampling.performance` | number | 1 | 性能采样率 (0-1) |
 | `sampling.behavior` | number | 1 | 行为采样率 (0-1) |
+| `behavior.maxBreadcrumbs` | number | 20 | 行为回溯最大记录数 |
+| `behavior.recordRequestBreadcrumb` | 'all' \| 'error' \| 'none' | 'error' | 网络请求记录模式：'all' 记录所有、'error' 记录非 2xx 响应（重定向、4xx、5xx、网络错误）、'none' 不记录 |
 | `report.maxBufferSize` | number | 10 | 缓冲区最大数量 |
 | `report.flushInterval` | number | 5000 | 上报间隔 (ms) |
 
-## 构建
-
-```bash
-npm install
-npm run build
-```
+## 产物清单
 
-构建产物将生成在 `dist` 目录中：
+构建产物生成在 `dist` 目录中：
 - `index.cjs.js`: CommonJS 格式
 - `index.esm.js`: ES Module 格式
 - `index.umd.js`: UMD 格式 (支持 CDN 引入)

package/dist/index.cjs.js

@@ -36,6 +36,7 @@ const DEFAULT_CONFIG = {
         click: true,
         route: true,
         maxBreadcrumbs: 20,
+        recordRequestBreadcrumb: 'error',
     },
 };
 /**
@@ -662,18 +663,26 @@ function interceptXHR() {
                 return;
             const duration = Date.now() - monitorData.startTime;
             const status = this.status;
-            // 添加到面包屑
-            context.addBreadcrumb({
-                type: 'request',
-                category: 'xhr',
-                data: {
-                    method: monitorData.method,
-                    url: monitorData.url,
-                    status,
-                    duration,
-                },
-            });
-            // 只上报错误请求 (4xx, 5xx 或 0)
+            // 根据配置决定是否添加到面包屑
+            const cfg = config.get();
+            const recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+            // 重定向(3xx)始终记录，不受配置控制
+            const isRedirect = status >= 300 && status < 400;
+            // 其他异常情况（0-网络错误、4xx-客户端错误、5xx-服务端错误）根据配置控制
+            const isError = status === 0 || status < 200 || status >= 400;
+            const shouldRecord = isRedirect || recordMode === 'all' || (recordMode === 'error' && isError);
+            if (shouldRecord) {
+                context.addBreadcrumb({
+                    type: 'request',
+                    category: 'xhr',
+                    data: {
+                        method: monitorData.method,
+                        url: monitorData.url,
+                        status,
+                        duration,
+                    },
+                });
+            }
             if (status === 0 || status >= 400) {
                 reportHttpError({
                     method: monitorData.method,
@@ -705,18 +714,26 @@ function interceptFetch() {
             const response = await originalFetch.call(window, input, init);
             const duration = Date.now() - startTime;
             const status = response.status;
-            // 添加到面包屑
-            context.addBreadcrumb({
-                type: 'request',
-                category: 'fetch',
-                data: {
-                    method,
-                    url,
-                    status,
-                    duration,
-                },
-            });
-            // 只上报错误请求
+            // 根据配置决定是否添加到面包屑
+            const cfg = config.get();
+            const recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+            // 重定向(3xx)始终记录，不受配置控制
+            const isRedirect = status >= 300 && status < 400;
+            // 其他异常情况根据配置控制
+            const isError = status < 200 || status >= 400;
+            const shouldRecord = isRedirect || recordMode === 'all' || (recordMode === 'error' && isError);
+            if (shouldRecord) {
+                context.addBreadcrumb({
+                    type: 'request',
+                    category: 'fetch',
+                    data: {
+                        method,
+                        url,
+                        status,
+                        duration,
+                    },
+                });
+            }
             if (!response.ok) {
                 // 克隆响应以读取 body
                 const cloned = response.clone();
@@ -739,18 +756,23 @@ function interceptFetch() {
         }
         catch (error) {
             const duration = Date.now() - startTime;
-            // 网络错误
-            context.addBreadcrumb({
-                type: 'request',
-                category: 'fetch',
-                data: {
-                    method,
-                    url,
-                    status: 0,
-                    duration,
-                    error: error.message,
-                },
-            });
+            // 网络错误时根据配置决定是否添加到面包屑
+            const cfg = config.get();
+            const recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+            // 网络错误属于 error，当模式为 'all' 或 'error' 时都记录
+            if (recordMode !== 'none') {
+                context.addBreadcrumb({
+                    type: 'request',
+                    category: 'fetch',
+                    data: {
+                        method,
+                        url,
+                        status: 0,
+                        duration,
+                        error: error.message,
+                    },
+                });
+            }
             reportHttpError({
                 method,
                 url,
@@ -1627,6 +1649,24 @@ class MonitorSDK {
         this.checkInit();
         config.setUser(user);
     }
+    /**
+     * 动态更新配置
+     * @description 可以在运行时更新 SDK 配置，如 debug、sampling、report 等
+     */
+    updateConfig(partialConfig) {
+        this.checkInit();
+        config.update(partialConfig);
+        if (config.get().debug) {
+            console.log('[Monitor] Config updated', partialConfig);
+        }
+    }
+    /**
+     * 获取当前配置
+     */
+    getConfig() {
+        this.checkInit();
+        return config.get();
+    }
     /**
      * 手动上报错误
      */