@blueking/open-telemetry 0.0.17 → 0.0.19

package/dist/plugins/resource.d.ts

@@ -14,7 +14,6 @@ export declare const getResourcePerformanceAttributes: (entry: ResourceTimingWit
     'resource.decoded_body_size': number;
     'resource.render_blocking_status'?: string | undefined;
     'resource.delivery_type'?: string | undefined;
-    transfer_size: number;
     "resource.cache.hit": boolean | undefined;
     "resource.protocol": string;
 };

package/dist/plugins/web-vitals.d.ts

@@ -37,6 +37,15 @@ interface EventTimingEntry extends PerformanceEntry {
     processingStart?: number;
     target?: EventTarget | null;
 }
+interface InpCandidate {
+    duration: number;
+    inputDelay: number;
+    interactionId: number;
+    interactionTarget?: string;
+    interactionType: string;
+    presentationDelay: number;
+    processingDuration: number;
+}
 interface LayoutShiftEntry extends PerformanceEntry {
     hadRecentInput?: boolean;
     sources?: Array<{
@@ -51,25 +60,16 @@ interface ViewVitalState {
     clsWindowLargestShiftValue: number;
     clsWindowStart?: number;
     clsWindowValue: number;
+    id: string;
+    inpCandidates: InpCandidate[];
     interactionCountAtStart?: number;
     interactionIdMax: number;
     interactionIdMin: number;
-    inpCandidates: InpCandidate[];
-    id: string;
     largestShiftTarget?: string;
     largestShiftValue: number;
     runtimeAttributes: Attributes;
     startedAt: number;
 }
-interface InpCandidate {
-    duration: number;
-    inputDelay: number;
-    interactionId: number;
-    interactionTarget?: string;
-    interactionType: string;
-    presentationDelay: number;
-    processingDuration: number;
-}
 export declare const isSameViewId: (currentViewId: string | undefined, nextViewId: string | undefined) => boolean;
 export declare const updateViewCls: (view: ViewVitalState, entry: LayoutShiftEntry) => void;
 export declare const updateViewInp: (view: ViewVitalState, entry: EventTimingEntry) => void;

package/dist/schema/attributes.d.ts

@@ -20,9 +20,7 @@ export declare const RUM_ATTRIBUTES: {
     readonly browserVersion: "browser.version";
     readonly cacheHit: "resource.cache.hit";
     readonly deviceType: "device.type";
-    readonly durationBucket: "duration_bucket";
     readonly errorType: "error_type";
-    readonly eventLabel: "event_label";
     readonly exceptionFingerprint: "exception.fingerprint";
     readonly exceptionMessageShort: "exception.message_short";
     readonly exceptionStackTopFrame: "exception.stack_top_frame";
@@ -45,13 +43,6 @@ export declare const RUM_ATTRIBUTES: {
     readonly sessionStartTime: "session.start_time";
     readonly spanSubtype: "span_subtype";
     readonly spanType: "span_type";
-    readonly statusClass: "status_class";
-    readonly targetDomain: "target_domain";
-    readonly targetLabel: "target_label";
-    readonly targetPathTemplate: "target_path_template";
-    readonly targetValue: "target_value";
-    readonly traceScene: "trace_scene";
-    readonly transferSize: "transfer_size";
     readonly userId: "user.id";
     readonly vitalMetric: "vital.metric";
     readonly vitalRating: "vital.rating";

package/dist/schema/span.d.ts

@@ -17,38 +17,28 @@ export declare const RUM_SPAN_TYPE: {
     readonly vital: "vital";
 };
 export interface RumResourceSpanInput {
-    duration?: number;
     initiatorType?: string;
     method?: string;
     networkError?: boolean;
     responseStatus?: number;
     transferSize?: number;
     url: string;
-    urlPathTemplate?: string;
 }
 export interface RumSpanClassification {
-    duration?: number;
     errorType?: string;
-    eventLabel?: string;
     result?: RumSpanResult;
     spanSubtype: string;
     spanType: RumSpanType;
-    targetLabel?: string;
-    targetValue?: boolean | number | string;
-    traceScene?: string;
 }
 export type RumSpanResult = (typeof RUM_SPAN_RESULT)[keyof typeof RUM_SPAN_RESULT];
 export type RumSpanType = (typeof RUM_SPAN_TYPE)[keyof typeof RUM_SPAN_TYPE];
 export interface RumUrlTarget {
-    domain?: string;
-    label?: string;
-    pathTemplate?: string;
+    serverAddress?: string;
+    serverPort?: number;
 }
-export declare const getDurationBucket: (duration: number) => "<100ms" | "100~500ms" | "500ms~2s" | ">2s";
-export declare const getStatusClass: (statusCode: number) => string;
 export declare const getHttpResult: (statusCode: number | undefined) => RumSpanResult;
 export declare const getHttpErrorType: (statusCode: number | undefined) => "none" | "network_timeout" | "http_5xx" | "http_4xx";
 export declare const getVitalResult: (rating: string | undefined) => RumSpanResult;
-export declare const getUrlTarget: (url: string | undefined, pathTemplate?: string) => RumUrlTarget;
-export declare const buildRumSpanAttributes: ({ duration, errorType, eventLabel, result, spanSubtype, spanType, targetLabel, targetValue, traceScene, }: RumSpanClassification) => Attributes;
-export declare const buildRumResourceSpanAttributes: ({ duration, initiatorType, method, networkError, responseStatus, transferSize, url, urlPathTemplate, }: RumResourceSpanInput) => Attributes;
+export declare const getUrlTarget: (url: string | undefined) => RumUrlTarget;
+export declare const buildRumSpanAttributes: ({ errorType, result, spanSubtype, spanType, }: RumSpanClassification) => Attributes;
+export declare const buildRumResourceSpanAttributes: ({ initiatorType, method, networkError, responseStatus, transferSize, url, }: RumResourceSpanInput) => Attributes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueking/open-telemetry",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "description": "OpenTelemetry browser SDK for BK RUM",
   "author": "TencentCloud Real User Monitoring",
   "main": "dist/index.js",

package/skills/bk-rum-otele/SKILL.md

@@ -32,7 +32,7 @@ description: 帮助业务方在前端应用里接入、使用和配置蓝鲸 RUM
 | 查公开 API（start/flush/shutdown/setUser/setView/reportAction/reportCustomEvent 等）        | `references/api.md`                   |
 | Vue / React / Vue Router / 微前端 集成                                                      | `references/framework-integration.md` |
 | URL 脱敏、属性脱敏、公共属性、低基数路由、user.id 处理                                      | `references/privacy.md`               |
-| 了解上报字段、span_type/result/duration_bucket、哪些字段是后端派生                          | `references/data-model.md`            |
+| 了解上报字段、span_type/result、哪些字段是后端派生                                          | `references/data-model.md`            |
 | 查具体的 span 名 / metric 名 / log 事件名、完整属性字典                                     | `references/telemetry-reference.md`   |
 | 本地看不到数据、手动事件没上报、白屏误报、接口 span 太多等排障                              | `references/troubleshooting.md`       |
 
@@ -63,7 +63,7 @@ SDK 维护公共上下文并自动挂到后续 span/log 上：`user.id`（业务
 
 ### 数据归一
 
-SDK 为 span 补充归一字段便于统一检索：`span_type`（document/resource/vital/error/longtask/action/route/custom）、`result`（success/warning/error/timeout/abort）、`duration_bucket`、`target_label` 等。Fetch/XHR 与静态资源统一为 resource，通过 `resource.type` 区分。
+SDK 为 span 补充归一字段便于统一检索：`span_type`（document/resource/vital/error/longtask/action/route/custom）、`span_subtype`、`result`（success/warning/error/timeout/abort）、`error_type`。Fetch/XHR 与静态资源统一为 resource，通过 `resource.type` 区分。
 
 ## 最小接入速查
 

package/skills/bk-rum-otele/references/api.md

@@ -261,10 +261,7 @@ const plugin = createPlugin({
 归一字段 key 常量。
 
 ```ts
-bkOT.reportCustomEvent({
-  name: 'biz_event',
-  attributes: { [RUM_ATTRIBUTES.targetLabel]: 'submit-order' },
-});
+const spanTypeKey = RUM_ATTRIBUTES.spanType; // 'span_type'
 ```
 
 ### RUM_SPAN_TYPE / RUM_SPAN_RESULT
@@ -278,18 +275,11 @@ const span = bkOT.startSpan('custom.cache_hit', {
   ...buildRumSpanAttributes({
     spanType: RUM_SPAN_TYPE.custom,
     spanSubtype: 'cache',
-    eventLabel: '业务缓存',
-    targetLabel: 'homepage',
-    targetValue: true,
   }),
 });
 span.end();
 ```
 
-### getDurationBucket(duration)
-
-返回 `<100ms`、`100~500ms`、`500ms~2s`、`>2s` 之一。
-
 ### buildRumSpanAttributes 相关类型
 
 公开 `RumSpanClassification`、`RumSpanType`、`RumSpanResult`，用于扩展插件保持同一归一模型。

package/skills/bk-rum-otele/references/capabilities.md

@@ -33,7 +33,7 @@
 
 - 创建和轮换 Session，划分初始加载、SPA、BFCache、手动和 Session 续期 View。
 - 统一 patch Fetch/XHR；请求 span、活动计数、Trace Header、Resource Timing 和 Body 采集共用同一生命周期。
-- 把浏览器事件归一为 `span_type`、`result`、`error_type`、`duration_bucket`、`target_*` 等字段。
+- 把浏览器事件归一为 `span_type`、`span_subtype`、`result`、`error_type` 等字段。
 - 自动为 Span/Log 关联 `session.id`、`view.id`，为 Metric 保留低基数 `view.url_path_group`。
 - 在 exporter 前执行采样、有效上下文、自上报请求和 `tracking.beforeSend` 过滤。
 

package/skills/bk-rum-otele/references/concepts.md

@@ -103,8 +103,6 @@ SDK 会为 span 补充 RUM 归一字段，例如：
 
 - `span_type`：`document`、`resource`、`vital`、`error`、`longtask`、`action`、`route`、`custom`
 - `result`：`success`、`warning`、`error`、`timeout`、`abort`
-- `duration_bucket`：`<100ms`、`100~500ms`、`500ms~2s`、`>2s`
-- `target_label`：跨类型的主标签，用于统一检索
 
 示例：自定义 span 也可以复用归一字段构造器。
 
@@ -115,8 +113,6 @@ const span = bkOT.startSpan('custom.cache_warmup', {
   ...buildRumSpanAttributes({
     spanType: RUM_SPAN_TYPE.custom,
     spanSubtype: 'cache_warmup',
-    eventLabel: '缓存预热',
-    targetLabel: 'homepage',
   }),
 });
 

package/skills/bk-rum-otele/references/data-model.md

@@ -7,7 +7,7 @@ SDK 的数据模型遵循“浏览器 SDK 负责低成本原始数据和单事
 ## 分层模型
 
 1. OpenTelemetry 原生字段：trace、span、resource、metric、log 的标准字段。
-2. RUM 归一字段：`span_type`、`span_subtype`、`result`、`error_type`、`duration_bucket`、`target_label` 等。
+2. RUM 归一字段：`span_type`、`span_subtype`、`result`、`error_type` 等。
 3. 运行时上下文：`user.id`、`session.id`、`view.id`、`view.url`、`view.url_path_group` 等。
 4. 后端派生字段：session/view duration、count、地理信息、影响用户数、trace tree 分析等。
 
@@ -35,8 +35,6 @@ const span = bkOT.startSpan('custom.search', {
   ...buildRumSpanAttributes({
     spanType: RUM_SPAN_TYPE.custom,
     spanSubtype: 'search',
-    eventLabel: '业务搜索',
-    targetLabel: 'alarm',
   }),
   'biz.keyword_length': 6,
 });
@@ -68,22 +66,6 @@ bkOT.reportCustomEvent({
 });
 ```
 
-## Duration Bucket
-
-有耗时的事件会写入 `duration_bucket`：
-
-- `<100ms`
-- `100~500ms`
-- `500ms~2s`
-- `>2s`
-
-```ts
-import { getDurationBucket } from '@blueking/open-telemetry';
-
-console.log(getDurationBucket(80)); // <100ms
-console.log(getDurationBucket(1200)); // 500ms~2s
-```
-
 ## SDK 直接采集
 
 以下字段由浏览器 API、接入方配置或 SDK 运行期上下文直接提供：
@@ -92,7 +74,7 @@ console.log(getDurationBucket(1200)); // 500ms~2s
 - 用户与会话：`user.id`、`session.id`
 - View：`view.id`、`view.name`、`view.url`、`view.url_path_group`、`view.loading_type`
 - 终端信息：`device.type`、`browser.name`、`browser.version`、`os.name`、`network.effective_type`
-- HTTP / Resource：`http.request.method`、`http.response.status_code`、`url.full`、`transfer_size`
+- HTTP / Resource：`http.request.method`、`http.response.status_code`、`url.full`、`resource.size`
 - Web Vitals：`vital.metric`、`vital.value`、`vital.rating`
 - Error Span 属性：`exception.message_short`、`exception.stack_top_frame`、`exception.fingerprint`；完整异常位于标准 `exception` Span Event
 

package/skills/bk-rum-otele/references/plugins.md

@@ -213,7 +213,7 @@ new BkOpenTelemetry({
 });
 ```
 
-常见字段包括 `initiator_type`、`transfer_size`、`resource.protocol`、`target_domain`、`target_path_template`。当 Resource Timing 数据可用时，还会上报：
+常见字段包括 `resource.type`、`resource.size`、`resource.protocol`、`url.full`、`server.address`。当 Resource Timing 数据可用时，还会上报：
 
 - `resource.redirect.*`、`resource.dns.*`、`resource.connect.*`、`resource.ssl.*`
 - `resource.first_byte.*`、`resource.download.*`、`resource.worker.*`
@@ -426,7 +426,7 @@ new BkOpenTelemetry({
 6. 等待最多 200ms 匹配 Resource Timing，把网络阶段补回同一 Span。
 7. 如已配置 Body 且 Log 开启，异步生成关联原 `trace.id` / `span.id` 的诊断 Log。
 
-**产出遥测**：Span `browser.resource`，`span_type=resource`、`resource.type=fetch|xhr`，常用属性包括 `resource.url`、`resource.method`、`resource.status_code`、`http.*`、`url.full`、网络阶段与响应体积。
+**产出遥测**：Span `browser.resource`，`span_type=resource`、`resource.type=fetch|xhr`，常用属性包括 `http.request.method`、`http.response.status_code`、`url.full`、`server.address`、网络阶段与响应体积。
 
 ```ts
 new BkOpenTelemetry({

package/skills/bk-rum-otele/references/telemetry-reference.md

@@ -9,7 +9,7 @@
 ## 命名规则
 
 - **信号名**：`browser.*` 表示内置浏览器事件（如 `browser.web_vital`）；`action.<type>`、`custom.<name>` 是运行期动态拼接；`csp.violation`、`websocket.*` 使用领域前缀。
-- **属性 key**：沿用 OpenTelemetry 语义约定的字段用点号（如 `http.request.method`、`exception.type`、`view.id`、`session.id`、`browser.name`）；跨类型检索字段使用下划线（如 `span_type`、`result`、`target_label`）。字段常量集中定义在 `src/schema/attributes.ts`。
+- **属性 key**：沿用 OpenTelemetry 语义约定的字段用点号（如 `http.request.method`、`exception.type`、`view.id`、`session.id`、`browser.name`）；跨类型检索字段使用下划线（如 `span_type`、`span_subtype`、`result`）。字段常量集中定义在 `src/schema/attributes.ts`。
 
 ## 公共上下文属性
 
@@ -35,23 +35,23 @@
 | `os.name` | string | 操作系统 | 是 |
 | `network.effective_type` | string | 网络质量（`4g` 等） | 是 |
 
-> span 还会带上 `span_type` / `span_subtype` / `result` / `error_type` / `event_label` / `target_label` 等归一字段（见下方[归一字段](#归一字段)）。接入方可通过 `context.attributes.page` 注入额外的页面属性。
+> span 还会带上 `span_type` / `span_subtype` / `result` / `error_type` 等归一字段（见下方[归一字段](#归一字段)）。接入方可通过 `context.attributes.page` 注入额外的页面属性。
 
 ## Span 清单
 
 | span 名 | span_type | 来源 | 关键属性 | 备注 |
 | --- | --- | --- | --- | --- |
 | `browser.view` | `document` / `route` | View 管理器 | `view.name`、`view.loading_time`、`view.loading_time.source`、`url.previous`、`event.source`、`view.end_reason` | 有持续时间，下一次 View 或 pagehide 时结束 |
-| `browser.resource` | `resource` | Fetch/XHR request 采集 | `resource.type=fetch\|xhr`、`resource.url`、`resource.method`、`resource.status_code`、网络阶段属性 | span kind 为 CLIENT；Fetch/XHR 共用同一实现 |
-| `browser.resource` | `resource` | resource 插件 | `resource.type`、`resource.url`、`resource.duration`、网络阶段、`resource.render_blocking_status`、`resource.protocol`、`resource.cache.hit` | 仅静态资源，跳过 Fetch/XHR |
+| `browser.resource` | `resource` | Fetch/XHR request 采集 | `resource.type=fetch\|xhr`、`url.full`、`http.request.method`、`http.response.status_code`、网络阶段属性 | span kind 为 CLIENT；Fetch/XHR 共用同一实现 |
+| `browser.resource` | `resource` | resource 插件 | `resource.type`、`url.full`、`resource.size`、网络阶段、`resource.render_blocking_status`、`resource.protocol`、`resource.cache.hit` | 仅静态资源，跳过 Fetch/XHR |
 | `browser.web_vital` | `vital` | webVitals 插件 | `vital.metric`、`vital.value`、`vital.rating`、`vital.id`、`rum.navigation.type`、`vital.<lcp\|cls\|inp\|fcp\|ttfb>.*` | 每个指标一条 |
 | `browser.blank_screen` | `error` | blankScreen 插件（二次确认白屏时） | `blank_screen.empty_ratio`、`blank_screen.reason`、`blank_screen.root_selector`、`blank_screen.root_found`、`blank_screen.*_sample_count`、`blank_screen.center_element` | 每个 View 最多一条 |
 | `browser.error` | `error` | error 插件（`window.error`） | `exception.fingerprint`、`exception.message_short`、`exception.stack_top_frame`、`error.source=window.error`、`error.window_occurrence_index`、`code.filepath`、`code.lineno`、`code.column`、`error.cross_origin` | 完整异常写入标准 `exception` Span Event |
 | `browser.unhandledrejection` | `error` | error 插件（Promise 异常） | `exception.fingerprint`、`error.source=unhandledrejection` | 完整异常写入标准 `exception` Span Event |
 | `browser.resource_error` | `error` | error 插件（资源加载失败） | `exception.fingerprint`、`error.source=resource`、`url.full`、`html.tag` | 完整异常写入标准 `exception` Span Event |
-| `browser.long_task` | `longtask` | longTask 插件 | `long_task.id`、`long_task.entry_type`、`long_task.start_time`、`long_task.duration`、`long_task.blocking_duration`、`long_task.culprit`、`long_task.script.count`、`target_value` | LoAF 脚本详情写入 `long_task.script` Span Event |
+| `browser.long_task` | `longtask` | longTask 插件 | `long_task.id`、`long_task.entry_type`、`long_task.start_time`、`long_task.duration`、`long_task.blocking_duration`、`long_task.culprit`、`long_task.script.count` | LoAF 脚本详情写入 `long_task.script` Span Event |
 | `csp.violation` | `error` | cspViolation 插件 | `csp.blocked_uri`、`csp.violated_directive`、`csp.effective_directive`、`csp.source_file`、`csp.line_number`、`csp.status_code`、`csp.fingerprint`、`csp.window_occurrence_index`、`csp.original_policy`（窗口首条） | |
-| `websocket.connect` | `custom` | websocket 插件（仅建连阶段） | `url.full`、`url.scheme`、`server.address`、`network.protocol.name=websocket`、`target_domain` | 长连接生命周期不绑定 span |
+| `websocket.connect` | `custom` | websocket 插件（仅建连阶段） | `url.full`、`url.scheme`、`server.address`、`network.protocol.name=websocket` | 长连接生命周期不绑定 span |
 | `action.click` / `action.custom` | `action` | action 插件 / `reportAction()` | `action.id/name/type/target.*`、`action.loading_time`、`action.frustration.*`、`action.*.count` | 自动点击或手动动作；挫败信号仅自动点击 |
 | `custom.<name>` | `custom` | `reportCustomEvent()` / 自定义插件 | `rum.custom.name`、业务自定义属性 | 带 `error` 时记录 exception、设置错误 Status/Result，`span_type` 仍为 `custom` |
 
@@ -100,14 +100,6 @@
 | `span_subtype` | string | 子类型，如 `fetch`/`xhr`/`js`/`promise`/`lcp` | 是 |
 | `result` | string | `success`/`warning`/`error`/`timeout`/`abort` | 是 |
 | `error_type` | string | 错误细分，如 `http_5xx`/`network_timeout`/`slow`/`none` | 是 |
-| `duration_bucket` | string | `<100ms`/`100~500ms`/`500ms~2s`/`>2s` | 是 |
-| `event_label` | string | 中文事件标签，如 `API 调用`/`错误` | 是 |
-| `target_label` | string | 跨类型主标签，用于统一检索 | 中 |
-| `target_value` | number/string/bool | 主数值（状态码、耗时、字节数等） | 否 |
-| `target_domain` | string | 目标域名 | 中 |
-| `target_path_template` | string | 目标低基数路径模板 | 是 |
-| `status_class` | string | HTTP 状态段，如 `2xx`/`5xx` | 是 |
-| `trace_scene` | string | `page_load` / `route_change` | 是 |
 
 ### HTTP / Resource
 
@@ -116,11 +108,9 @@
 | `http.request.method` | string | 请求方法（大写） |
 | `http.response.status_code` | number | 响应状态码 |
 | `url.full` | string | 完整 URL（已脱敏） |
+| `server.address` | string | 目标主机名 |
+| `server.port` | number | 目标显式端口（存在时） |
 | `resource.type` | string | `fetch`/`xhr` 或静态资源 initiator type |
-| `resource.url` | string | 资源 URL（已脱敏） |
-| `resource.method` | string | 请求方法（Fetch/XHR） |
-| `resource.status_code` | number | 请求状态码（Fetch/XHR） |
-| `resource.duration` | number | 静态资源耗时（ms）；请求耗时使用 Span 原生 duration |
 | `resource.redirect.start/duration` | number | 重定向阶段相对开始时间 / 耗时（ms） |
 | `resource.dns.start/duration` | number | DNS 阶段相对开始时间 / 耗时（ms） |
 | `resource.connect.start/duration` | number | TCP 建连阶段相对开始时间 / 耗时（ms） |
@@ -132,10 +122,8 @@
 | `resource.render_blocking_status` | string | `blocking` / `non-blocking` |
 | `resource.size` | number | 传输字节数 |
 | `url.previous` | string | 跳转前 URL |
-| `transfer_size` | number | 传输字节数 |
 | `resource.cache.hit` | boolean | 是否命中缓存 |
 | `resource.protocol` | string | 协议，如 `h2` |
-| `initiator_type` | string | 资源发起类型 |
 | `resource.encoded_body_size` / `resource.decoded_body_size` | number | 资源体积 |
 | `request.body` / `response.body` | string | 仅 `browser.request.body` Log；经过接入方 `redact` 且受长度限制 |
 | `request.body.content_type` / `response.body.content_type` | string | body Content-Type（可获取时） |