@blueking/open-telemetry 0.0.21 → 0.0.22

package/README.md

@@ -1,6 +1,6 @@
 # @blueking/open-telemetry
 
-面向浏览器真实用户监控（RUM）的 OpenTelemetry SDK。它把 Session、View、Fetch/XHR、静态资源、错误、Web Vitals、用户操作、白屏、Long Task、WebSocket、CSP 和设备信息统一为 Trace、Metric、Log，并通过 OTLP HTTP 上报。
+面向浏览器真实用户监控（RUM）的 OpenTelemetry SDK。它把 Session、View、Fetch/XHR、静态资源、错误、Web Vitals、用户操作、白屏、Long Task、WebSocket、CSP 和设备信息统一为原始 RUM Span，并通过 OTLP HTTP 上报。计数、分位数、错误分组等聚合全部由服务端完成。
 
 ## 快速接入
 
@@ -32,15 +32,7 @@ export const bkOT = new BkOpenTelemetry({
 });
 ```
 
-`application.name` 与 `transport` 必填。根 `transport.endpoint` 会生成三个上报地址：
-
-| 信号 | 默认地址 | 主要用途 |
-| --- | --- | --- |
-| Trace | `<endpoint>/v1/rum` | View、请求、资源、错误、性能、Action |
-| Metric | `<endpoint>/v1/metrics` | Web Vitals、View Loading、白屏、Long Task、WebSocket 聚合 |
-| Log | `<endpoint>/v1/logs` | Session 生命周期、View Snapshot、请求 Body、WebSocket 事件 |
-
-也可以为 `transport.signals.traces|metrics|logs.endpoint` 分别提供完整 URL，或把不需要的信号设为 `false`。至少要启用一种信号。
+`application.name` 与 `transport.endpoint` 必填。SDK 只有一个上报地址：`<endpoint>/v1/rum`。不创建 OpenTelemetry Metric/Log Provider，也不采集请求/响应 Body。
 
 ## 默认能力
 
@@ -48,13 +40,13 @@ export const bkOT = new BkOpenTelemetry({
 
 | 能力 | 默认 | 产出 |
 | --- | --- | --- |
-| Session / View | 开启且不可关闭 | `session.*` Log、`browser.view` Span/Log/Metric、运行时关联字段 |
-| Fetch / XHR | 开启 | `browser.resource` CLIENT Span，可选 `traceparent` 与 Body Log |
+| Session / View | 开启且不可关闭 | `browser.session`、`browser.view` 生命周期 Span 与运行时关联字段 |
+| Fetch / XHR | 开启 | `browser.resource` CLIENT Span，可选 `traceparent` |
 | 静态资源 | 开启 | `browser.resource` Span、网络阶段属性 |
 | Error | 开启 | JS、Promise、资源加载错误 Span |
-| Web Vitals | 开启 | CLS/FCP/INP/LCP/TTFB Span 与 Metric |
-| Action | 开启 | 点击活动、耗时、关联计数和挫败信号 Span |
-| Blank Screen | 开启 | 白屏 Span 与 Counter |
+| Web Vitals | 开启 | CLS/FCP/INP/LCP/TTFB 原始 Span |
+| Action | 开启 | 点击耗时和挫败信号 Span，不上报关联计数 |
+| Blank Screen | 开启 | 白屏 Span |
 | Device | 开启 | 浏览器、OS、硬件 Resource 属性，以及设备 ID、屏幕、网络运行时属性 |
 | Long Task / WebSocket / CSP | 关闭 | 按需通过 `tracking` 开启 |
 
@@ -72,13 +64,8 @@ const bkOT = new BkOpenTelemetry({
   transport: {
     endpoint: 'https://rum-collector.example.com',
     token: 'report-token',
-    signals: {
-      traces: {
-        processor: 'batch',
-        batch: { maxQueueSize: 2048, maxExportBatchSize: 512 },
-      },
-      metrics: { intervalMillis: 60_000 },
-    },
+    processor: 'batch',
+    batch: { maxQueueSize: 2048, maxExportBatchSize: 512 },
   },
   session: { sampleRate: 0.2 },
   tracking: {
@@ -96,7 +83,6 @@ const bkOT = new BkOpenTelemetry({
     user: { id: window.USER_ID },
     attributes: {
       page: () => ({ 'biz.module': 'order' }),
-      metric: () => ({ 'biz.app': 'order-center' }),
     },
   },
   privacy: {
@@ -113,7 +99,7 @@ const bkOT = new BkOpenTelemetry({
 
 1. `getPathGroup` 已把动态 ID 转成低基数路由模板。
 2. 跨域 Trace Header 白名单足够精确，服务端 CORS 已放行 `traceparent`。
-3. `user.id`、URL、错误和业务属性满足隐私要求；HTTP Body 默认保持关闭。
+3. `user.id`、URL、错误和业务属性满足隐私要求；SDK 不采集 HTTP Body。
 4. SPA 的 `blankScreen.rootSelector` 指向真实挂载节点。
 5. 同一页面只运行一个实例，避免重复 patch Fetch/XHR/WebSocket。
 
@@ -158,7 +144,7 @@ bkOT.startView({ name: '订单详情', url: location.href });
 | 理解初始化、插件顺序、上下文、过滤和上报数据流 | [架构与数据流](./wikis/architecture.md) |
 | 查完整配置、默认值和约束 | [配置参考](./wikis/configuration.md) |
 | 查公开方法与导出符号 | [API 参考](./wikis/api.md) |
-| 查精确 Span / Metric / Log 名和字段 | [遥测参考](./wikis/telemetry-reference.md) |
+| 查精确 RUM Span 名和字段 | [遥测参考](./wikis/telemetry-reference.md) |
 | 隐私、Consent 和低基数字段 | [隐私与公共属性](./wikis/privacy-attributes.md) |
 | 没有数据或数据异常 | [调试与排障](./wikis/troubleshooting.md) |