@blueking/open-telemetry 0.0.30 → 0.0.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bk-rum.global.js +1 -1
- package/dist/bk-rum.global.js.map +1 -1
- package/dist/index.js +368 -357
- package/dist/index.js.map +1 -1
- package/dist/schema/attributes.d.ts +1 -0
- package/package.json +1 -1
- package/skills/bk-rum-otele/references/actions.md +1 -1
- package/skills/bk-rum-otele/references/data-model.md +3 -1
- package/skills/bk-rum-otele/references/network.md +6 -2
- package/skills/bk-rum-otele/references/privacy.md +1 -1
- package/skills/bk-rum-otele/references/span-protocol.md +247 -83
- package/skills/bk-rum-otele/references/telemetry-reference.md +7 -6
- package/skills/bk-rum-otele/references/views-routing.md +4 -3
|
@@ -99,7 +99,7 @@ Resource Attribute 描述产生 Span 的 SDK 实例和运行环境，同一实
|
|
|
99
99
|
| `view.url` | string | View 有效 | 创建 View 时的完整 URL，经 `redactUrl` 脱敏。与当前实时 `location.href` 不一定相同。 |
|
|
100
100
|
| `view.url_template` | string | View 有效 | 低基数路由模板。默认把数字 ID、UUID 和长十六进制路径段归一为 `:id`，也可由 `getUrlTemplate` 自定义。 |
|
|
101
101
|
| `view.loading_type` | string | View 有效 | View 创建类型：`initial_load` 首次文档加载、`route_change` SPA 路由、`bf_cache` BFCache 恢复、`session_renewal` Session 到期后续建。 |
|
|
102
|
-
| `action.id` | string
|
|
102
|
+
| `action.id` | string | 自动 Action 活动中 | 当前活动的自动 Action ID。多个点击窗口重叠时取最近一次开始的 Action；Action Span 自身的同名字段也是单个 string。 |
|
|
103
103
|
| `device.id` | string | Device 插件开启 | SDK 生成的匿名设备关联 ID。默认仅在本次插件生命周期内稳定；`persistentId: true` 时写入 localStorage，从而跨页面和 Session 保持。 |
|
|
104
104
|
| `browser.viewport.width` | number | 浏览器环境 | 当前 CSS viewport 宽度，单位 CSS px，来源 `window.innerWidth`；窗口 resize/屏幕旋转后更新到后续 Span。 |
|
|
105
105
|
| `browser.viewport.height` | number | 浏览器环境 | 当前 CSS viewport 高度，单位 CSS px，来源 `window.innerHeight`。 |
|
|
@@ -168,13 +168,14 @@ Session Span 允许没有 `view.id`：SDK 先建立 Session，再创建初始 Vi
|
|
|
168
168
|
| `view.started_at` | number | epoch ms | View 开始时间。初始 View 使用 `performance.timeOrigin`，路由/BFCache/续建 View 使用创建时刻。 |
|
|
169
169
|
| `view.name` | string | 显式命名后 | 业务可读名称，仅 `startView({ name })` 或 `setViewName()` 后存在；未命名的 View 不带该字段。 |
|
|
170
170
|
| `view.url` | string | 所有阶段 | 创建 View 时的 URL，经 `redactUrl` 脱敏；在该 View 生命周期内保持不变。 |
|
|
171
|
-
| `view.url_template` | string | 所有阶段 |
|
|
171
|
+
| `view.url_template` | string | 所有阶段 | 当前 URL 的低基数路由模板。数字 ID、UUID、长十六进制段默认折叠为 `:id`，用于稳定聚合动态路由。 |
|
|
172
|
+
| `view.previous_url_template` | string | 所有阶段 | 前序 URL 的低基数路由模板；使用 `tracking.view.getUrlTemplate` 生成，初始 View 为空字符串。 |
|
|
172
173
|
| `view.loading_type` | string | 所有阶段 | `initial_load`、`route_change`、`bf_cache` 或 `session_renewal`，含义见运行时公共属性。 |
|
|
173
174
|
| `view.loading_time` | number | 计算完成后，ms | 从 `view.started_at` 到页面活动稳定的耗时。初始加载同时等待 load event 和页面活动，以较晚者为准；可由 `setViewLoadingTime()` 手动结束。 |
|
|
174
175
|
| `view.loading_time_source` | string | 有 `view.loading_time` 时 | `auto` 表示 SDK 自动观察页面活动；`manual` 表示业务调用 `setViewLoadingTime()`。 |
|
|
175
176
|
| `view.end_reason` | string | 仅 `end` | 结束原因：路由来源值、`manual`、`bfcache`、`pagehide`、`session_expired` 或 `shutdown`。它说明为何关闭旧 View，不是新 View 的加载类型。 |
|
|
176
|
-
| `
|
|
177
|
-
| `
|
|
177
|
+
| `view.previous` | string | 所有阶段 | 创建 View 时记录的前序 URL，经 `redactUrl` 脱敏；初始 View 为空字符串。 |
|
|
178
|
+
| `view.referrer` | string | 仅 `initial_load` 且值非空 | `document.referrer` 经 `redactUrl` 脱敏。 |
|
|
178
179
|
| `view.first_byte` | number | 仅初始 View 且 Navigation Timing 有值，相对 timeOrigin ms | `PerformanceNavigationTiming.responseStart`，表示导航开始到收到响应首字节的时间。 |
|
|
179
180
|
| `view.dom_interactive` | number | 同上 | `domInteractive`，表示 HTML 解析完成、文档进入 interactive 状态的时间点。 |
|
|
180
181
|
| `view.dom_content_loaded` | number | 同上 | `domContentLoadedEventEnd`，表示 DOMContentLoaded 事件处理完成的时间点。 |
|
|
@@ -190,7 +191,7 @@ Session Span 允许没有 `view.id`：SDK 先建立 Session，再创建初始 Vi
|
|
|
190
191
|
| 字段 | 类型 | 条件/单位 | 来源与详细说明 |
|
|
191
192
|
| --------------------------------- | ------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
192
193
|
| `url.full` | string | 有有效请求/资源 URL | 绝对 URL，经 `redactUrl` 脱敏。用于定位请求目标；不要假设 query 中仍保留原始参数。 |
|
|
193
|
-
| `url.template` | string |
|
|
194
|
+
| `url.template` | string | 有有效请求/资源 URL | 低基数 path。Fetch/XHR 和静态资源默认把数字 ID、UUID、长十六进制段折叠为 `:id`，例如 `/api/orders/:id`，可由 `tracking.request.getUrlTemplate` 覆盖。静态资源先通过 `redactUrl` 脱敏，再生成模板。按路径聚合时用它，不要用 `url.full`。 |
|
|
194
195
|
| `server.address` | string | URL 可解析 | URL 的 `hostname`，不含端口。相对 URL 会基于当前页面地址解析。模板不含 host，跨域同路径会聚到一起，需要区分来源时配合该字段。 |
|
|
195
196
|
| `server.port` | number | URL 显式包含端口 | URL 的显式端口号。使用协议默认端口且 URL 未写端口时缺失。 |
|
|
196
197
|
| `resource.type` | string | 必有 | Fetch/XHR 为 `fetch`/`xhr`；静态资源使用 `PerformanceResourceTiming.initiatorType`，为空时为 `other`，常见还有 `script`、`link`、`img`、`css`。 |
|
|
@@ -337,7 +338,7 @@ Attribution 字段受浏览器能力和指标实现影响，缺失不代表指
|
|
|
337
338
|
|
|
338
339
|
| 字段 | 类型 | 自动 Click | 手动 Action | 来源与详细说明 |
|
|
339
340
|
| ------------------------- | -------- | ------------------------ | -------------- | --------------------------------------------------------------------------------------------------------- |
|
|
340
|
-
| `action.id` | string | 必有 | 必有 | 当前 Action 的唯一 ID。自动 Action 活动期间，其他 Span
|
|
341
|
+
| `action.id` | string | 必有 | 必有 | 当前 Action 的唯一 ID。自动 Action 活动期间，其他 Span 上的同名运行时字段也是单个 string。 |
|
|
341
342
|
| `action.type` | string | 固定 `click` | 固定 `custom` | 区分自动点击和 `reportAction` 主动上报。 |
|
|
342
343
|
| `action.name` | string | `Click on <target>` | payload `name` | 可读名称。自动点击目标名默认来自显式 `data-bk-action-name`，启用文本采集后才会回退到可访问名称/DOM 文本。 |
|
|
343
344
|
| `action.target.name` | string | 必有 | 不写 | 自动点击提取的目标名称，最多 100 字符；默认隐私模式下未显式命名时通常为小写 tag 名。 |
|
|
@@ -54,7 +54,7 @@ bkOT.startView({
|
|
|
54
54
|
|
|
55
55
|
## View 名称和路由模板
|
|
56
56
|
|
|
57
|
-
默认 `view.url_template` 取 URL pathname 并把数字 ID、UUID、长十六进制段折叠为 `:id
|
|
57
|
+
默认 `view.url_template` 取 URL pathname 并把数字 ID、UUID、长十六进制段折叠为 `:id`。请求和静态资源 Span 的 `url.template` 复用同一套折叠规则，但走独立的 `tracking.request.getUrlTemplate`。静态资源先通过 `redactUrl` 脱敏，再生成模板。
|
|
58
58
|
|
|
59
59
|
`view.name` 与 `view.url_template` 是两个不同维度：前者是业务给出的可读标签（「订单详情」），后者是路由模板（`/orders/:id`）。**只有显式调用 `startView({ name })` 或 `setViewName()` 时才会上报 `view.name`**，未命名的 View 不带该字段，后端展示时用 `view.name ?? view.url_template` 兜底即可。这样 `view.name` 的存在本身就表示"业务命名过"，也不会在每条 Span 上重复一份模板字符串。
|
|
60
60
|
|
|
@@ -84,8 +84,9 @@ bkOT.setViewName('订单详情-只读');
|
|
|
84
84
|
|
|
85
85
|
- `view.url`：当前 URL，经 `privacy.redactUrl`。
|
|
86
86
|
- `view.url_template`：聚合路由模板。
|
|
87
|
-
- `
|
|
88
|
-
- `
|
|
87
|
+
- `view.previous`：前一个原始 URL 经脱敏；初始加载为空字符串。
|
|
88
|
+
- `view.previous_url_template`：前一个 URL 的聚合路由模板；初始加载为空字符串。
|
|
89
|
+
- `view.referrer`：仅初始自动加载写入并脱敏。
|
|
89
90
|
|
|
90
91
|
用于路由判断的是原始 URL，写入遥测的是脱敏 URL。自定义 `redactUrl` 不会影响是否切换 View。
|
|
91
92
|
|