@wu529778790/open-im 1.11.2-beta.0 → 1.11.2-beta.1

package/dist/index.js

@@ -183,7 +183,7 @@ export async function main() {
             logLevel: config.logLevel,
             telemetry: config.telemetry,
         });
-        initSentry();
+        initSentry(config.telemetry.enabled);
         applyOpenImGitCoauthorToProcessEnv();
     }
     catch (err) {

package/dist/shared/sentry.d.ts

@@ -1,21 +1,20 @@
 /**
  * Sentry 错误追踪集成
  *
- * 仅捕获错误，不开启性能监控（免费版 5K errors/月 够用）。
- * 通过 OPEN_IM_SENTRY_DSN 环境变量启用。
+ * - 默认启用，收集错误用于改进产品质量
+ * - 用户可通过 OPEN_IM_TELEMETRY=false 或 config.json opt-out
+ * - 只收集错误类型和堆栈，不收集用户数据（PII）
  */
 /**
- * 初始化 Sentry。无 DSN 则静默跳过。
+ * 初始化 Sentry
+ * - 默认启用（收集错误改进产品）
+ * - 用户可通过 OPEN_IM_TELEMETRY=false 或 telemetry.enabled=false opt-out
  */
-export declare function initSentry(): void;
+export declare function initSentry(telemetryEnabled?: boolean): void;
 /**
- * 上报错误到 Sentry
+ * 上报错误到 Sentry（自动清理 PII）
  */
 export declare function captureError(error: Error | unknown, context?: Record<string, unknown>): void;
-/**
- * 添加面包屑（错误发生前的上下文）
- */
-export declare function addBreadcrumb(category: string, message: string, data?: Record<string, unknown>): void;
 /**
  * 刷新并关闭 Sentry（优雅关闭时调用）
  */

package/dist/shared/sentry.js

@@ -1,38 +1,81 @@
 /**
  * Sentry 错误追踪集成
  *
- * 仅捕获错误，不开启性能监控（免费版 5K errors/月 够用）。
- * 通过 OPEN_IM_SENTRY_DSN 环境变量启用。
+ * - 默认启用，收集错误用于改进产品质量
+ * - 用户可通过 OPEN_IM_TELEMETRY=false 或 config.json opt-out
+ * - 只收集错误类型和堆栈，不收集用户数据（PII）
  */
 import * as Sentry from '@sentry/node';
 import { createLogger } from '../logger.js';
 const log = createLogger('Sentry');
+// 开发者的 Sentry DSN（所有 open-im 实例共享）
+const DEFAULT_DSN = 'https://cc5ad094c1229b2a2ff23ab54b0fd807@o4508612762861568.ingest.us.sentry.io/4511583989727232';
 let initialized = false;
 /**
- * 初始化 Sentry。无 DSN 则静默跳过。
+ * 清理 PII（用户数据）
+ * 只保留错误信息，移除敏感内容
  */
-export function initSentry() {
-    const dsn = process.env.OPEN_IM_SENTRY_DSN;
-    if (!dsn) {
-        log.debug('Sentry disabled (no OPEN_IM_SENTRY_DSN)');
+function sanitizeContext(context) {
+    const clean = {};
+    for (const [key, value] of Object.entries(context)) {
+        // 跳过敏感字段
+        if (/token|secret|password|key|api_key|apikey|auth/i.test(key))
+            continue;
+        // 跳过用户 ID（只保留平台信息）
+        if (/userId|user_id|userKey|user_key/i.test(key)) {
+            clean[key] = '[redacted]';
+            continue;
+        }
+        // 截断长字符串
+        if (typeof value === 'string' && value.length > 200) {
+            clean[key] = value.substring(0, 200) + '...';
+        }
+        else {
+            clean[key] = value;
+        }
+    }
+    return clean;
+}
+/**
+ * 初始化 Sentry
+ * - 默认启用（收集错误改进产品）
+ * - 用户可通过 OPEN_IM_TELEMETRY=false 或 telemetry.enabled=false opt-out
+ */
+export function initSentry(telemetryEnabled = true) {
+    // 检查 opt-out
+    const envOptOut = process.env.OPEN_IM_TELEMETRY?.trim().toLowerCase();
+    if (envOptOut === 'false' || envOptOut === '0' || envOptOut === 'no' || !telemetryEnabled) {
+        log.debug('Sentry disabled (user opt-out)');
         return;
     }
+    // 优先使用用户自定义 DSN，否则用默认 DSN
+    const dsn = process.env.OPEN_IM_SENTRY_DSN || DEFAULT_DSN;
     try {
         Sentry.init({
             dsn,
-            // 只捕获 error 级别，不捕获 warning/info
+            // 只捕获 error 级别
             beforeSend(event) {
                 if (event.level !== 'error' && event.level !== 'fatal')
                     return null;
+                // 清理 PII
+                if (event.extra) {
+                    event.extra = sanitizeContext(event.extra);
+                }
+                if (event.contexts) {
+                    for (const [key, value] of Object.entries(event.contexts)) {
+                        if (typeof value === 'object' && value !== null) {
+                            event.contexts[key] = sanitizeContext(value);
+                        }
+                    }
+                }
                 return event;
             },
             // 不开启 performance monitoring
             tracesSampleRate: 0,
             // 环境标识
             environment: process.env.NODE_ENV ?? 'production',
-            // 附加面包屑（错误发生前的日志）
+            // 附加面包屑
             beforeBreadcrumb(breadcrumb) {
-                // 只保留关键 breadcrumb
                 if (breadcrumb.category === 'console' || breadcrumb.category === 'http') {
                     return breadcrumb;
                 }
@@ -40,14 +83,14 @@ export function initSentry() {
             },
         });
         initialized = true;
-        log.info('Sentry initialized');
+        log.info('Sentry initialized (error tracking enabled)');
     }
     catch (err) {
         log.warn('Sentry init failed:', err);
     }
 }
 /**
- * 上报错误到 Sentry
+ * 上报错误到 Sentry（自动清理 PII）
  */
 export function captureError(error, context) {
     if (!initialized)
@@ -55,7 +98,7 @@ export function captureError(error, context) {
     try {
         Sentry.withScope((scope) => {
             if (context) {
-                scope.setExtras(context);
+                scope.setExtras(sanitizeContext(context));
             }
             if (error instanceof Error) {
                 scope.setTag('error.name', error.name);
@@ -68,24 +111,6 @@ export function captureError(error, context) {
         // Sentry 本身不应影响业务
     }
 }
-/**
- * 添加面包屑（错误发生前的上下文）
- */
-export function addBreadcrumb(category, message, data) {
-    if (!initialized)
-        return;
-    try {
-        Sentry.addBreadcrumb({
-            category,
-            message: message.substring(0, 200),
-            data,
-            level: 'info',
-        });
-    }
-    catch {
-        // ignore
-    }
-}
 /**
  * 刷新并关闭 Sentry（优雅关闭时调用）
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wu529778790/open-im",
-  "version": "1.11.2-beta.0",
+  "version": "1.11.2-beta.1",
   "description": "Your AI coding assistant, in every chat app. Multi-platform IM bridge for Claude Code, Codex, and CodeBuddy.",
   "type": "module",
   "main": "dist/index.js",