sobey-monitor-sdk 1.0.8 → 1.1.0

package/README.md

@@ -17,6 +17,27 @@ npm install sobey-monitor-sdk --save
 
 ## 快速开始
 
+### 方式一：使用远程配置（推荐）
+
+通过 `configUrl` 从服务端获取配置，无需手动维护 `appId` 和 `dsn`：
+
+```javascript
+import { monitor } from 'sobey-monitor-sdk';
+
+// 只需提供 configUrl，其他配置从远程获取
+monitor.init({
+  configUrl: '/monitor/api/config/your-app-id'
+});
+
+// 也可以覆盖部分远程配置
+monitor.init({
+  configUrl: '/monitor/api/config/your-app-id',
+  debug: true  // 本地配置优先级高于远程配置
+});
+```
+
+### 方式二：传统配置
+
 ```javascript
 import { monitor } from 'sobey-monitor-sdk';
 
@@ -113,8 +134,9 @@ ReactDOM.render(
 
 | 配置项 | 类型 | 默认值 | 说明 |
 |--------|------|--------|------|
-| `appId` | string | 必填 | 应用唯一标识 |
-| `dsn` | string | 必填 | 数据上报地址 |
+| `configUrl` | string | - | 远程配置接口地址，填写后可从远程获取 `appId`、`dsn` 等配置（仅初始化时获取一次） |
+| `appId` | string | 必填* | 应用唯一标识（使用 `configUrl` 时可不填） |
+| `dsn` | string | 必填* | 数据上报地址（使用 `configUrl` 时可不填） |
 | `enabled` | boolean | true | **全局开关**，设为 false 则完全禁用所有监控上报 |
 | `debug` | boolean | false | 调试模式，开启后会在控制台输出日志 |
 | `sampling.error` | number | 1 | 错误采样率 (0-1) |

package/dist/core/config.d.ts

@@ -9,8 +9,9 @@ declare class ConfigManager {
     private config;
     /**
      * 初始化配置
+     * @param skipValidation 是否跳过必填校验（用于远程配置已获取 appId/dsn 的场景）
      */
-    init(userConfig: MonitorConfig): void;
+    init(userConfig: MonitorConfig, skipValidation?: boolean): void;
     /**
      * 获取配置
      */

package/dist/index.cjs.js

@@ -49,13 +49,28 @@ class ConfigManager {
     }
     /**
      * 初始化配置
+     * @param skipValidation 是否跳过必填校验（用于远程配置已获取 appId/dsn 的场景）
      */
-    init(userConfig) {
-        if (!userConfig.appId) {
-            throw new Error('[Monitor] appId is required');
+    init(userConfig, skipValidation = false) {
+        if (!skipValidation) {
+            // 如果没有 configUrl，则 appId 和 dsn 是必填的
+            if (!userConfig.configUrl) {
+                if (!userConfig.appId) {
+                    throw new Error('[Monitor] appId is required when configUrl is not provided');
+                }
+                if (!userConfig.dsn) {
+                    throw new Error('[Monitor] dsn is required when configUrl is not provided');
+                }
+            }
         }
-        if (!userConfig.dsn) {
-            throw new Error('[Monitor] dsn is required');
+        else {
+            // 远程配置模式下，校验合并后的配置
+            if (!userConfig.appId) {
+                throw new Error('[Monitor] appId is required (not found in remote config)');
+            }
+            if (!userConfig.dsn) {
+                throw new Error('[Monitor] dsn is required (not found in remote config)');
+            }
         }
         this.config = this.mergeConfig(DEFAULT_CONFIG, userConfig);
     }
@@ -1632,24 +1647,56 @@ const SDK_VERSION = '1.0.0';
 class MonitorSDK {
     constructor() {
         this.initialized = false;
+        this.initializing = false;
     }
     /**
      * 初始化 SDK
+     * 如果配置了 configUrl，将先从远程获取配置（仅获取一次）
+     * 无需 await，SDK 内部会自动处理异步逻辑
      */
     init(userConfig) {
-        if (this.initialized) {
-            console.warn('[Monitor] SDK already initialized');
+        if (this.initialized || this.initializing) {
+            if (this.initialized) {
+                console.warn('[Monitor] SDK already initialized');
+            }
             return;
         }
+        // 如果配置了 configUrl，异步获取远程配置后再初始化
+        if (userConfig.configUrl) {
+            this.initializing = true;
+            this.fetchRemoteConfig(userConfig.configUrl)
+                .then((remoteConfig) => {
+                // 远程配置作为基础，用户本地配置覆盖远程配置
+                const finalConfig = this.mergeUserConfig(remoteConfig, userConfig);
+                if (userConfig.debug) {
+                    console.log('[Monitor] Remote config loaded:', remoteConfig);
+                }
+                this.doInit(finalConfig, true);
+            })
+                .catch((error) => {
+                this.initializing = false;
+                console.error('[Monitor] Failed to fetch remote config:', error);
+            });
+        }
+        else {
+            // 没有 configUrl，直接同步初始化
+            this.doInit(userConfig, false);
+        }
+    }
+    /**
+     * 执行实际的初始化逻辑
+     */
+    doInit(finalConfig, isRemoteConfig) {
         // 初始化配置
         config.init({
-            ...userConfig,
-            version: userConfig.version || SDK_VERSION,
-        });
+            ...finalConfig,
+            version: finalConfig.version || SDK_VERSION,
+        }, isRemoteConfig);
         // 初始化上下文
         const maxBreadcrumbs = config.get().behavior?.maxBreadcrumbs || 20;
         context.init(maxBreadcrumbs);
         this.initialized = true;
+        this.initializing = false;
         if (config.get().debug) {
             console.log('[Monitor] SDK initialized', config.get());
         }
@@ -1658,6 +1705,50 @@ class MonitorSDK {
         installPerformanceMonitor();
         installBehaviorMonitor();
     }
+    /**
+     * 从远程获取配置
+     */
+    async fetchRemoteConfig(configUrl) {
+        const response = await fetch(configUrl, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        });
+        if (!response.ok) {
+            throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+        }
+        return response.json();
+    }
+    /**
+     * 合并配置：远程配置为基础，用户本地配置优先
+     */
+    mergeUserConfig(remote, local) {
+        const result = { ...remote };
+        for (const key in local) {
+            if (Object.prototype.hasOwnProperty.call(local, key)) {
+                const localValue = local[key];
+                const remoteValue = remote[key];
+                // 跳过 configUrl，不需要传递给最终配置
+                if (key === 'configUrl')
+                    continue;
+                if (localValue !== null &&
+                    localValue !== undefined &&
+                    typeof localValue === 'object' &&
+                    !Array.isArray(localValue) &&
+                    remoteValue !== null &&
+                    remoteValue !== undefined &&
+                    typeof remoteValue === 'object' &&
+                    !Array.isArray(remoteValue)) {
+                    result[key] = { ...remoteValue, ...localValue };
+                }
+                else if (localValue !== undefined) {
+                    result[key] = localValue;
+                }
+            }
+        }
+        return result;
+    }
     /**
      * 设置用户信息
      */