@guomain/monitor-core 0.1.0

package/README.md

@@ -0,0 +1,27 @@
+# @gm Monitor SDK
+
+前端错误监控：运行时错误、Promise、资源加载、接口异常、Vue/React、手动上报、catch 自动采集（需 Vite 插件）。
+
+## 安装
+
+```sh
+pnpm add @guomain/monitor-web
+pnpm add -D @guomain/monitor-plugins @guomain/monitor-types
+```
+
+## 快速开始
+
+```ts
+import { createWebMonitor } from '@guomain/monitor-web'
+
+const monitor = createWebMonitor({
+  appId: 'your-app',
+  dsn: '/api/monitor',
+  vue: { app }
+})
+
+globalThis.__GM_MONITOR__ = monitor
+monitor.start()
+```
+
+完整说明见仓库内 `SDK.md` 与 `PUBLISH.md`。

package/index.d.ts

@@ -0,0 +1,18 @@
+import type { MonitorConfig, MonitorEvent, MonitorEventMeta, MonitorInstance, MonitorLimits } from '@guomain/monitor-types';
+/**
+ * 默认采集与发送阈值。
+ */
+export declare const defaultLimits: MonitorLimits;
+/**
+ * 创建通用监控实例。
+ * @param config SDK 初始化配置，包含应用标识、上报地址、自定义发送函数、上下文和阈值。
+ */
+export declare function createMonitor(config: MonitorConfig): MonitorInstance;
+/**
+ * 把任意错误值归一化为 SDK 事件。
+ * @param type 事件类型，用于标识错误来源。
+ * @param error 原始错误，可以是 Error、字符串或其他未知值。
+ * @param meta 附加 tags 和 extra。
+ */
+export declare function toErrorEvent(type: MonitorEvent['type'], error: unknown, meta?: MonitorEventMeta): MonitorEvent;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,aAAa,EAGd,MAAM,wBAAwB,CAAA;AAE/B;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,aAE3B,CAAA;AAID;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,eAAe,CA4LpE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,EAC1B,KAAK,EAAE,OAAO,EACd,IAAI,CAAC,EAAE,gBAAgB,GACtB,YAAY,CA8Bd"}

package/index.js

@@ -0,0 +1,246 @@
+/**
+ * 默认采集与发送阈值。
+ */
+export const defaultLimits = {
+    maxQueueSize: 50
+};
+/**
+ * 创建通用监控实例。
+ * @param config SDK 初始化配置，包含应用标识、上报地址、自定义发送函数、上下文和阈值。
+ */
+export function createMonitor(config) {
+    if (!config.appId) {
+        throw new Error('appId is required');
+    }
+    if (!(config.dsn || config.transport)) {
+        throw new Error('dsn or transport is required');
+    }
+    const mergedLimits = { ...defaultLimits, ...config.limits };
+    const plugins = [];
+    const pluginTeardowns = [];
+    const queue = [];
+    const queuedKeys = new Set();
+    let draining = false;
+    let idleDrainHandle;
+    let started = false;
+    async function defaultTransport(payloads) {
+        if (!config.dsn) {
+            return;
+        }
+        if (typeof navigator !== 'undefined' && typeof navigator.sendBeacon === 'function') {
+            const sent = navigator.sendBeacon(config.dsn, JSON.stringify(payloads));
+            if (sent) {
+                return;
+            }
+        }
+        // sendBeacon 不可用或返回 false 时回退到 fetch
+        await fetch(config.dsn, {
+            method: 'POST',
+            body: JSON.stringify(payloads),
+            headers: { 'Content-Type': 'application/json' }
+        });
+    }
+    const setupPlugin = (plugin) => {
+        try {
+            const teardown = plugin.setup(monitor);
+            if (typeof teardown === 'function') {
+                pluginTeardowns.push(teardown);
+            }
+        }
+        catch (error) {
+            reportSdkError(monitor, error, {
+                stage: 'plugin',
+                pluginName: plugin.name
+            });
+        }
+    };
+    const monitor = {
+        config,
+        limits: mergedLimits,
+        start() {
+            if (started) {
+                return;
+            }
+            started = true;
+            plugins.forEach(plugin => {
+                setupPlugin(plugin);
+            });
+        },
+        stop() {
+            if (!started) {
+                return;
+            }
+            started = false;
+            const tasks = pluginTeardowns.splice(0).reverse();
+            tasks.forEach(task => {
+                task();
+            });
+        },
+        use(plugin) {
+            plugins.push(plugin);
+            if (started) {
+                setupPlugin(plugin);
+            }
+            return monitor;
+        },
+        capture(event) {
+            if (!started) {
+                return;
+            }
+            const key = stringifyQueueEvent(event);
+            if (queuedKeys.has(key)) {
+                return;
+            }
+            if (queue.length >= mergedLimits.maxQueueSize) {
+                const removed = queue.shift();
+                if (removed) {
+                    queuedKeys.delete(removed.key);
+                }
+            }
+            queuedKeys.add(key);
+            queue.push({ event, key });
+            scheduleIdleDrain();
+        },
+        async flush() {
+            await drainQueue();
+        }
+    };
+    async function drainQueue() {
+        if (draining) {
+            return;
+        }
+        cancelIdleDrain();
+        draining = true;
+        try {
+            const batch = queue.splice(0);
+            if (!batch.length) {
+                return;
+            }
+            batch.forEach(item => {
+                queuedKeys.delete(item.key);
+            });
+            let context;
+            try {
+                if (config.context) {
+                    context = typeof config.context === 'function' ? await config.context() : config.context;
+                }
+            }
+            catch (error) {
+                reportSdkError(monitor, error, { stage: 'context' });
+            }
+            const payloads = batch.map(({ event }) => ({
+                ...event,
+                timestamp: event.timestamp ?? Date.now(),
+                appId: config.appId,
+                release: config.release,
+                context
+            }));
+            try {
+                await (config.transport ?? defaultTransport)(payloads);
+            }
+            catch (error) {
+                // transport 失败直接 console.error，不入队重入（避免 sdk-error 走同一故障通道导致风暴）
+                if (typeof console !== 'undefined' && console.error) {
+                    console.error('[gm-monitor] Transport failed:', error);
+                }
+            }
+        }
+        finally {
+            draining = false;
+        }
+    }
+    function scheduleIdleDrain() {
+        if (idleDrainHandle !== undefined) {
+            return;
+        }
+        if (typeof requestIdleCallback === 'function') {
+            idleDrainHandle = requestIdleCallback(() => {
+                idleDrainHandle = undefined;
+                void drainQueue();
+            });
+            return;
+        }
+        idleDrainHandle = setTimeout(() => {
+            idleDrainHandle = undefined;
+            void drainQueue();
+        }, 16);
+    }
+    function cancelIdleDrain() {
+        if (idleDrainHandle === undefined) {
+            return;
+        }
+        if (typeof cancelIdleCallback === 'function') {
+            cancelIdleCallback(idleDrainHandle);
+        }
+        else {
+            clearTimeout(idleDrainHandle);
+        }
+        idleDrainHandle = undefined;
+    }
+    return monitor;
+}
+/**
+ * 把任意错误值归一化为 SDK 事件。
+ * @param type 事件类型，用于标识错误来源。
+ * @param error 原始错误，可以是 Error、字符串或其他未知值。
+ * @param meta 附加 tags 和 extra。
+ */
+export function toErrorEvent(type, error, meta) {
+    if (error instanceof Error) {
+        return {
+            type,
+            message: error.message,
+            stack: error.stack,
+            timestamp: Date.now(),
+            ...meta
+        };
+    }
+    let message;
+    if (typeof error === 'string') {
+        message = error;
+    }
+    else if (error === undefined) {
+        message = 'undefined';
+    }
+    else {
+        try {
+            message = JSON.stringify(error);
+        }
+        catch {
+            message = String(error);
+        }
+    }
+    return {
+        type,
+        message,
+        timestamp: Date.now(),
+        ...meta
+    };
+}
+function stringifyQueueEvent(event) {
+    return JSON.stringify({
+        type: event.type,
+        message: event.message,
+        url: event.url,
+        stack: event.stack,
+        filename: event.filename,
+        lineno: event.lineno,
+        colno: event.colno,
+        tags: event.tags,
+        extra: event.extra
+    });
+}
+/**
+ * 上报 SDK 自身异常。同名 sdk-error 由 dedup 天然合并，不会风暴。
+ */
+function reportSdkError(monitor, error, extra) {
+    try {
+        monitor.capture(toErrorEvent('sdk-error', error, { extra }));
+    }
+    catch {
+        // SDK 上报通道自身崩溃时静默吞掉，避免递归。
+        if (typeof console !== 'undefined' && console.error) {
+            console.error('[gm-monitor] SDK internal error:', error);
+        }
+    }
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "version": "0.1.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+http://192.168.200.220/GomainFE/stamp.git",
+    "directory": "monitor/packages/monitor-core"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "name": "@guomain/monitor-core",
+  "description": "Runtime-agnostic core for @gm monitor SDK",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "dependencies": {
+    "@guomain/monitor-types": "^0.1.0"
+  },
+  "files": [
+    "**/*"
+  ]
+}