@blueking/open-telemetry 0.0.28 → 0.0.29
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 +25 -29
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/skills/bk-rum-otele/references/api.md +1 -1
- package/skills/bk-rum-otele/references/architecture.md +1 -1
- package/skills/bk-rum-otele/references/telemetry-reference.md +2 -2
- package/skills/bk-rum-otele/references/transport-sampling.md +1 -1
- package/skills/bk-rum-otele/references/views-routing.md +5 -3
package/package.json
CHANGED
|
@@ -108,7 +108,7 @@ SDK 只创建 OpenTelemetry Trace Provider。Session、View、请求、资源、
|
|
|
108
108
|
|
|
109
109
|
- `user.id`
|
|
110
110
|
- `session.id`、`session.start_time`、`session.type`、`session.has_replay`
|
|
111
|
-
- `view.id`、`view.
|
|
111
|
+
- `view.id`、`view.url`、`view.url_template`、`view.loading_type`，以及显式命名后才出现的 `view.name`
|
|
112
112
|
- 活动窗口内的 `action.id`
|
|
113
113
|
- Device 插件产生的视口、屏幕、网络和设备 ID
|
|
114
114
|
- View 自定义属性
|
|
@@ -95,7 +95,7 @@ Resource Attribute 描述产生 Span 的 SDK 实例和运行环境，同一实
|
|
|
95
95
|
| `session.type` | string | Session 有效 | 当前固定为 `user`，为未来区分其他 Session 类型保留。 |
|
|
96
96
|
| `session.has_replay` | boolean | Session 有效 | 当前固定为 `false`，表示 SDK 没有随该 Session 上报 Session Replay 数据。 |
|
|
97
97
|
| `view.id` | string | View 有效 | 当前页面视图的关联 ID。首次加载、有效 SPA 路由变化、BFCache 恢复或 Session 续建都会创建新 View。 |
|
|
98
|
-
| `view.name` | string |
|
|
98
|
+
| `view.name` | string | 显式命名后 | 业务给出的可读名称，仅在 `startView({ name })` 或 `setViewName()` 调用后存在。默认不上报，展示请用 `view.name ?? view.url_template`。 |
|
|
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 到期后续建。 |
|
|
@@ -166,7 +166,7 @@ Session Span 允许没有 `view.id`：SDK 先建立 Session，再创建初始 Vi
|
|
|
166
166
|
| `view.id` | string | 所有阶段 | View 关联 ID。同一 View 的 start/update/end 使用相同值，可与该 View 内其他 Span 关联。 |
|
|
167
167
|
| `view.version` | number | 从 1 递增 | 每次 `emitViewEvent` 递增；用于恢复同一 View 生命周期快照的先后顺序。 |
|
|
168
168
|
| `view.started_at` | number | epoch ms | View 开始时间。初始 View 使用 `performance.timeOrigin`，路由/BFCache/续建 View 使用创建时刻。 |
|
|
169
|
-
| `view.name` | string |
|
|
169
|
+
| `view.name` | string | 显式命名后 | 业务可读名称，仅 `startView({ name })` 或 `setViewName()` 后存在；未命名的 View 不带该字段。 |
|
|
170
170
|
| `view.url` | string | 所有阶段 | 创建 View 时的 URL，经 `redactUrl` 脱敏；在该 View 生命周期内保持不变。 |
|
|
171
171
|
| `view.url_template` | string | 所有阶段 | 低基数路由模板。数字 ID、UUID、长十六进制段默认折叠为 `:id`，用于稳定聚合动态路由。 |
|
|
172
172
|
| `view.loading_type` | string | 所有阶段 | `initial_load`、`route_change`、`bf_cache` 或 `session_renewal`，含义见运行时公共属性。 |
|
|
@@ -60,7 +60,7 @@ https://rum.example.com/collector/v1/rum
|
|
|
60
60
|
{ "key": "session.type", "value": { "stringValue": "user" } },
|
|
61
61
|
{ "key": "session.has_replay", "value": { "boolValue": false } },
|
|
62
62
|
{ "key": "view.id", "value": { "stringValue": "view-01" } },
|
|
63
|
-
{ "key": "view.name", "value": { "stringValue": "
|
|
63
|
+
{ "key": "view.name", "value": { "stringValue": "订单详情" } },
|
|
64
64
|
{ "key": "view.url", "value": { "stringValue": "https://app.example.com/orders/123" } },
|
|
65
65
|
{ "key": "view.url_template", "value": { "stringValue": "/orders/:id" } },
|
|
66
66
|
{ "key": "view.loading_type", "value": { "stringValue": "initial_load" } },
|
|
@@ -13,7 +13,7 @@ View 表示一次可独立分析的页面体验。初始文档加载、SPA 路
|
|
|
13
13
|
| `bf_cache` | 从 Back/Forward Cache 恢复 | `view` |
|
|
14
14
|
| `session_renewal` | Session 过期后新 Session 接管当前页面 | `view` |
|
|
15
15
|
|
|
16
|
-
每个 View 都生成新的 `view.id`。View
|
|
16
|
+
每个 View 都生成新的 `view.id`。View 的 URL、路由模板和自定义属性作为运行时上下文挂到其间发生的普通 Span；名称只在业务显式命名后才带上。
|
|
17
17
|
|
|
18
18
|
## 自动路由模式
|
|
19
19
|
|
|
@@ -54,7 +54,9 @@ 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`。
|
|
58
|
+
|
|
59
|
+
`view.name` 与 `view.url_template` 是两个不同维度：前者是业务给出的可读标签（「订单详情」），后者是路由模板（`/orders/:id`）。**只有显式调用 `startView({ name })` 或 `setViewName()` 时才会上报 `view.name`**，未命名的 View 不带该字段，后端展示时用 `view.name ?? view.url_template` 兜底即可。这样 `view.name` 的存在本身就表示"业务命名过"，也不会在每条 Span 上重复一份模板字符串。
|
|
58
60
|
|
|
59
61
|
```ts
|
|
60
62
|
tracking: {
|
|
@@ -76,7 +78,7 @@ tracking: {
|
|
|
76
78
|
bkOT.setViewName('订单详情-只读');
|
|
77
79
|
```
|
|
78
80
|
|
|
79
|
-
名称变化不会创建新 View，但会更新运行时上下文并发送 `browser.view` update
|
|
81
|
+
名称变化不会创建新 View，但会更新运行时上下文并发送 `browser.view` update。传入与当前相同名称时不发送更新。首次调用会让此后的 Span 开始带上 `view.name`。
|
|
80
82
|
|
|
81
83
|
## URL 与前序页面
|
|
82
84
|
|