@blueking/open-telemetry 0.0.29 → 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 +349 -397
- package/dist/index.js.map +1 -1
- package/dist/plugins/blank-screen.d.ts +0 -2
- package/dist/plugins/device.d.ts +0 -1
- package/dist/plugins/web-vitals.d.ts +0 -7
- package/dist/schema/attributes.d.ts +3 -8
- package/dist/schema/span.d.ts +1 -3
- package/package.json +1 -1
- package/skills/bk-rum-otele/SKILL.md +2 -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 +667 -0
- package/skills/bk-rum-otele/references/telemetry-reference.md +7 -6
- package/skills/bk-rum-otele/references/views-routing.md +4 -3
|
@@ -0,0 +1,667 @@
|
|
|
1
|
+
<!-- 本文件由 packages/open-telemetry/scripts/gen-skill-references.mjs 从 wikis 自动生成，请勿手改。 -->
|
|
2
|
+
|
|
3
|
+
# RUM 语义约定
|
|
4
|
+
|
|
5
|
+
两份文档不重复维护同一套字段规范：一个记录实现现状，一个定义稳定承诺。
|
|
6
|
+
|
|
7
|
+
「[遥测字段字典](./telemetry-reference.md)」是由代码自动生成的事实清单，完整反映当前 SDK 实际产出的 Span 字段。它回答当前实际上报了哪些字段，其中可以包含新增、灰度和待废弃字段，不代表这些字段都已形成稳定承诺。
|
|
8
|
+
|
|
9
|
+
「RUM 语义约定」是前后端共同遵循的语义契约，围绕 RUM 核心字段定义含义、使用方式、约束和生命周期。字段经过评审并标记为 Stable 后，才成为对外稳定承诺；新增、灰度和废弃状态也在这里管理。
|
|
10
|
+
|
|
11
|
+
如果两份文档对不上，先查「遥测字段字典」确认 SDK 现在上报了什么，再查「RUM 语义约定」确认这是尚未完成的改动，还是实现偏差。代码中出现了某个字段，并不表示它已经稳定；只有在「RUM 语义约定」中标记为 Stable，前后端才需要长期兼容这个字段。
|
|
12
|
+
|
|
13
|
+
| 状态 | 描述 |
|
|
14
|
+
| -------------------------------------------------------------- | -------------- |
|
|
15
|
+
|  | 已上报，保持现状。 |
|
|
16
|
+
|  | 已上报，但需要废弃。 |
|
|
17
|
+
|  | 新补充或字段位置变更。 |
|
|
18
|
+
|  | 由后端生成，前端不直接上报。 |
|
|
19
|
+
|
|
20
|
+
原则：
|
|
21
|
+
* Aegis、DataDog 后续统一转成 Otel Span 协议，同领域字段尽量对齐前两个 SDK，需控制字段数量，避免出现需转换 150+ 字段的情况。
|
|
22
|
+
* 控制字段规模：输出可覆盖 Otel & Aegis & DataDog SDK 最简协议，其他不必要字段统一省略，减少初始技术负债（字段一旦放出但没有真正使用，稳定后一旦有需求变更，就有兼容风险）。
|
|
23
|
+
* 指标：Web Vitals 指标由接收端派生，SDK 无需埋点。
|
|
24
|
+
|
|
25
|
+
## 0x01 用户真实监控模型
|
|
26
|
+
|
|
27
|
+
```text
|
|
28
|
+
Session
|
|
29
|
+
└── View
|
|
30
|
+
├── Vital：FCP / LCP / CLS / INP / TTFB
|
|
31
|
+
├── Action
|
|
32
|
+
├── Resource
|
|
33
|
+
├── Error
|
|
34
|
+
└── Long Task
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## 0x02 公共字段
|
|
38
|
+
|
|
39
|
+
### a. 顶层字段
|
|
40
|
+
|
|
41
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
42
|
+
| ---------------- | -------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------- |
|
|
43
|
+
| `time` |  | str | 数据上报时间（毫秒时间戳字符串） | -- |
|
|
44
|
+
| `app_name` |  | str | 应用名称 | -- |
|
|
45
|
+
| `bk_biz_id` |  | str | 业务 ID | -- |
|
|
46
|
+
| `trace_id` |  | str | Trace ID | -- |
|
|
47
|
+
| `trace_state` |  | str | Trace 状态 | -- |
|
|
48
|
+
| `span_name` |  | str | Span 名称 | -- |
|
|
49
|
+
| `span_id` |  | str | Span ID | -- |
|
|
50
|
+
| `parent_span_id` |  | str | 父 Span ID | -- |
|
|
51
|
+
| `status` |  | Status | Span 执行状态 | 包含 `code` 和 `message`。 |
|
|
52
|
+
| `kind` |  | enum | [Span 类型](https://opentelemetry.io/zh/docs/concepts/signals/traces/#span-kind) | 枚举值：<br>- 未定义：0<br>- 内部调用：1<br>- 同步被调：2<br>- 同步主调：3<br>- 异步主调：4<br>- 异步被调：5 |
|
|
53
|
+
| `resource` |  | object | 资源信息 | 服务、环境、SDK 等描述信息。 |
|
|
54
|
+
| `events` |  | Event[] | 事件列表 | 异常详情和 Long Task 脚本明细通过 Span Event 承载。 |
|
|
55
|
+
| `links` |  | Link[] | [Span 链接](https://opentelemetry.io/docs/concepts/signals/traces/#span-links) | 链接的存在是为了 Span 同其他 Span 建立关联，从而表明存在因果关系。 |
|
|
56
|
+
| `attributes` |  | object | 属性 | 浏览器、设备、网络、异常等各类语义标签和度量。 |
|
|
57
|
+
| `start_time` |  | int | 开始时间（微秒） | -- |
|
|
58
|
+
| `end_time` |  | int | 结束时间（微秒） | -- |
|
|
59
|
+
| `elapsed_time` |  | int | 耗时（微秒） | -- |
|
|
60
|
+
|
|
61
|
+
### b. Resource
|
|
62
|
+
|
|
63
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
64
|
+
| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ------ | ----------- | ---------------------------------------------- |
|
|
65
|
+
| `resource.service.name` |  | str | 服务名 | -- |
|
|
66
|
+
| `resource.service.version` |  | str | 版本 | -- |
|
|
67
|
+
| [`resource.deployment.environment.name`](https://opentelemetry.io/docs/specs/semconv/resource/deployment-environment/) |  | str | 环境 | 如 `development`、`production`、`staging`、`test`。 |
|
|
68
|
+
| `resource.session.sample_rate` |  | number | Session 采样率 | 取值范围为 `0`～`1`。 |
|
|
69
|
+
| `resource.telemetry.sdk.version` |  | str | SDK 版本 | -- |
|
|
70
|
+
| [`resource.telemetry.sdk.language`](https://opentelemetry.io/docs/specs/semconv/resource/#telemetry-sdk) |  | enum | 语言 | `webjs`。 |
|
|
71
|
+
| `resource.telemetry.sdk.name` *[1]* |  | str | SDK 名称 | -- |
|
|
72
|
+
| `resource.device.type` |  | enum | 设备类型 | `desktop`、`mobile`、`tablet`、`other`。 |
|
|
73
|
+
| `resource.user_agent.name` |  | str | 代理名称 | 通常指的是浏览器的名称，如 `Chrome`、`Edge`。 |
|
|
74
|
+
| `resource.user_agent.version` |  | str | 代理版本 | 通常指的是浏览器的名称，如 `149`、`151`。 |
|
|
75
|
+
| `resource.user_agent.os.name` |  | str | 操作系统名 | 如 `macOS`、`Windows`、`Android`。 |
|
|
76
|
+
|
|
77
|
+
**[1] `resource.telemetry.sdk.name`**：`blueking`（蓝鲸 Otel SDK，当前值为 @blueking/open-telemetry，需修改。）｜aegis（Aegis SDK）。
|
|
78
|
+
|
|
79
|
+
### c. Status
|
|
80
|
+
|
|
81
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
82
|
+
| ---------------- | ---------------------------------------------------------- | --- | ---- | ---------------------------- |
|
|
83
|
+
| `status.code` |  | int | 状态码 | 0（未设置）<br />1（正常）<br />2（异常） |
|
|
84
|
+
| `status.message` |  | str | 状态描述 | 如 `Failed to fetch` |
|
|
85
|
+
|
|
86
|
+
### d. Event
|
|
87
|
+
|
|
88
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
89
|
+
| ----------------------------------------------------------------------- | ---------------------------------------------------------- | ------ | ------------- | -------------------- |
|
|
90
|
+
| `events[].name` *[1]* |  | str | 事件名 | |
|
|
91
|
+
| `events[].timestamp` |  | int | 事件发生时间（微秒） | |
|
|
92
|
+
| `events[].attributes.exception.type` |  | str | 异常类型 | 如 `TypeError`。 |
|
|
93
|
+
| `events[].attributes.exception.message` |  | str | 异常消息 | 如 `Failed to fetch`。 |
|
|
94
|
+
| `events[].attributes.exception.stacktrace` |  | str | 异常堆栈 | |
|
|
95
|
+
| `events[].attributes.long_task.script.duration` |  | number | 脚本耗时（ms） | |
|
|
96
|
+
| `events[].attributes.long_task.script.execution_start` |  | number | 脚本执行开始时间（ms） | |
|
|
97
|
+
| `events[].attributes.long_task.script.forced_style_and_layout_duration` |  | number | 强制样式与布局耗时（ms） | |
|
|
98
|
+
| `events[].attributes.long_task.script.pause_duration` |  | number | 暂停耗时（ms） | |
|
|
99
|
+
| `events[].attributes.long_task.script.source_char_position` |  | number | 源码字符位置 | |
|
|
100
|
+
| `events[].attributes.long_task.script.start_time` |  | number | 脚本开始时间（ms） | |
|
|
101
|
+
| `events[].attributes.long_task.script.invoker` |  | str | 调用方 | |
|
|
102
|
+
| `events[].attributes.long_task.script.invoker_type` |  | str | 调用方类型 | |
|
|
103
|
+
| `events[].attributes.long_task.script.source_function_name` |  | str | 源函数名 | |
|
|
104
|
+
| `events[].attributes.long_task.script.source_url` |  | str | 已脱敏的脚本 URL | |
|
|
105
|
+
| `events[].attributes.long_task.script.window_attribution` |  | str | Window 归因 | |
|
|
106
|
+
|
|
107
|
+
**[1] `events[].name`**：「异常」需将事件名固定为 `exception`。
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
### f. Link
|
|
112
|
+
|
|
113
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
114
|
+
| ------------------ | -------------------------------------------------------------- | --- | ---------- | --- |
|
|
115
|
+
| `links[].trace_id` |  | str | 关联 TraceID | |
|
|
116
|
+
| `links[].span_id` |  | str | 关联 SpanID | |
|
|
117
|
+
|
|
118
|
+
**[1] `links[].trace_id`**：满足 `attributesspan_type=resource, attributes.resource.type=xhr or fetch` 时，需将前端生成的 TraceID 记录到该字段。
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
## 0x03 Attributes
|
|
122
|
+
|
|
123
|
+
### a. 基础字段
|
|
124
|
+
|
|
125
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
126
|
+
| ---------------------------- | ---------------------------------------------------------- | ---- | ------- | ---------------------------------------------- |
|
|
127
|
+
| `attributes.user.id` |  | str | 用户 ID | -- |
|
|
128
|
+
| `attributes.span_type` *[1]* |  | enum | Span 类型 | -- |
|
|
129
|
+
| `attributes.outcome.type` |  | enum | 执行结果 | `success`、`warning`、`error`、`timeout`、`abort`。 |
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
**[1] `attributes.span_type`**：
|
|
133
|
+
|
|
134
|
+
| 值 | 描述 |
|
|
135
|
+
| ----------- | -------------------- |
|
|
136
|
+
| `session` | Session 创建、轮换或结束。 |
|
|
137
|
+
| `view` | 页面首次加载或路由视图生命周期。 |
|
|
138
|
+
| `resource` | 静态资源、Fetch 或 XHR 请求。 |
|
|
139
|
+
| `error` | 浏览器错误、白屏或 CSP 违规。 |
|
|
140
|
+
| `vital` | Web Vitals 指标。 |
|
|
141
|
+
| `long_task` | Long Task 或长动画帧。 |
|
|
142
|
+
| `action` | 用户交互或主动上报的 Action。 |
|
|
143
|
+
| `websocket` | WebSocket 生命周期事件。 |
|
|
144
|
+
| `custom` | 主动上报的自定义事件。 |
|
|
145
|
+
|
|
146
|
+
### b. [error](https://opentelemetry.io/docs/specs/semconv/registry/attributes/error/)
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
150
|
+
| ------------------------------- | ----------------------------------------------------------- | ------- | ---------- | -------------------------------------------------------------------- |
|
|
151
|
+
| `attributes.error.message` |  | str | 错误信息 | -- |
|
|
152
|
+
| `attributes.error.handled` |  | boolean | 错误是否被捕获 | -- |
|
|
153
|
+
| `attributes.error.source` |  | str | 错误来源 | 枚举值：<br/>- window.error（固定值）<br/>- resource<br/>- unhandledrejection |
|
|
154
|
+
| `attributes.code.column` |  | int | 代码列号 | |
|
|
155
|
+
| `attributes.code.filepath` |  | str | 代码文件路径 | |
|
|
156
|
+
| `attributes.code.lineno` |  | int | 代码行号 | |
|
|
157
|
+
|
|
158
|
+
### c. [browser](https://opentelemetry.io/docs/specs/semconv/registry/attributes/browser/)
|
|
159
|
+
|
|
160
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
161
|
+
| ------------------------------------ | ---------------------------------------------------------- | --- | ------- | ---------------------------- |
|
|
162
|
+
| `attributes.browser.screen.height` |  | int | 屏幕尺寸的高度 | Aegis 使用 `sr = 1728 * 1117`。 |
|
|
163
|
+
| `attributes.browser.screen.width` |  | int | 屏幕尺寸的宽度 | -- |
|
|
164
|
+
| `attributes.browser.viewport.height` |  | int | 视口尺寸的高度 | Aegis 使用 `vp = 576 * 918`。 |
|
|
165
|
+
| `attributes.browser.viewport.width` |  | int | 视口尺寸的宽度 | -- |
|
|
166
|
+
|
|
167
|
+
### d. [device](https://opentelemetry.io/docs/specs/semconv/registry/attributes/device/)
|
|
168
|
+
|
|
169
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
170
|
+
| ---------------------- | ---------------------------------------------------------- | --- | ---- | ----------------------------------------- |
|
|
171
|
+
| `attributes.device.id` |  | str | 设备标识 | 如 `fd136680-a37b-45ea-80ee-365bfdc7f82e`。 |
|
|
172
|
+
|
|
173
|
+
### e. [network](https://opentelemetry.io/docs/specs/semconv/registry/attributes/network/)
|
|
174
|
+
|
|
175
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
176
|
+
| ------------------------------------ | -------------------------------------------------------------- | ---- | ------- | ----------------------------------------------------------- |
|
|
177
|
+
| `attributes.network.connection.type` |  | enum | 连接类型 | 直接使用浏览器 `navigator.connection.type` 的原始值；字段不存在时不上报。 |
|
|
178
|
+
| `attributes.network.effective_type` |  | str | 有效网络质量 | -- |
|
|
179
|
+
| `attributes.network.status` |  | enum | 网络连接状态 | `connected`、`not_connected`。 |
|
|
180
|
+
| `attributes.network.protocol.name` |  | enum | 应用层网络协议 | 仅 WebSocket Span 上报，固定为 `websocket`；HTTP Resource Span 不上报。 |
|
|
181
|
+
|
|
182
|
+
**[1] `attributes.network.connection.type`**：表示设备当前使用的物理网络连接方式。SDK 直接上报
|
|
183
|
+
[`navigator.connection.type`](https://wicg.github.io/netinfo/#connectiontype-enum)；浏览器不支持该 API
|
|
184
|
+
或没有返回 `type` 时不携带该字段。该字段对应 DataDog 的 `connectivity.interfaces` 和 Aegis 的 `netType`。
|
|
185
|
+
|
|
186
|
+
Aegis 将「连接类型」「网络质量」整合成 `netType`（`wifi`、`wired`、`2G`、`3G`、`5G`、`6G`），不推荐这种做法。
|
|
187
|
+
转换 Aegis 数据时，`wifi` 保持不变，`wired` 映射为 `ethernet`，移动网络代际映射为 `cellular`。
|
|
188
|
+
|
|
189
|
+
| 值 | 描述 | 备注 |
|
|
190
|
+
| ---------- | -------- | --------------------------------------- |
|
|
191
|
+
| `bluetooth` | 蓝牙网络 | 通过蓝牙网络连接。 |
|
|
192
|
+
| `cellular` | 蜂窝移动网络 | 不表示具体移动网络代际。 |
|
|
193
|
+
| `ethernet` | 以太网 | Aegis 的 `wired` 映射为该值。 |
|
|
194
|
+
| `mixed` | 混合连接 | 浏览器同时使用多种连接方式。 |
|
|
195
|
+
| `none` | 无网络连接 | 通常与 `network.status=not_connected` 同时出现。 |
|
|
196
|
+
| `other` | 其他连接方式 | 浏览器知道连接类型，但不属于已列出的类型。 |
|
|
197
|
+
| `unknown` | 未知连接方式 | 已建立网络连接，但浏览器无法或不愿提供连接类型。 |
|
|
198
|
+
| `wifi` | Wi-Fi 网络 | 仅表示通过 Wi-Fi 连接，不代表网络一定快。 |
|
|
199
|
+
| `wimax` | WiMAX 网络 | 通过 WiMAX 连接。 |
|
|
200
|
+
|
|
201
|
+
**[2] `attributes.network.effective_type`**：表示浏览器根据延迟和下载速度估算出的实际网络质量，等同与 DataDog（`connectivity.effective_type`）、Aegis（`netType`）。
|
|
202
|
+
|
|
203
|
+
| 值 | 描述 | 备注 |
|
|
204
|
+
| --------- | ---- | -------------------------- |
|
|
205
|
+
| `slow-2g` | 极慢网络 | 页面和图片加载非常慢，通常只能满足少量文本传输。 |
|
|
206
|
+
| `2g` | 较慢网络 | 简单页面可以打开，图片、脚本和接口请求可能明显缓慢。 |
|
|
207
|
+
| `3g` | 中等网络 | 普通网页基本可用，但大资源和复杂页面仍可能等待。 |
|
|
208
|
+
| `4g` | 较快网络 | 延迟和带宽表现较好，适合大多数 Web 应用。 |
|
|
209
|
+
|
|
210
|
+
### f. session
|
|
211
|
+
|
|
212
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
213
|
+
| ------------------------------------- | ----------------------------------------------------------- | ------- | -------- | ----------------------------------------------- |
|
|
214
|
+
| `attributes.session.has_replay` |  | boolean | 是否回放 | -- |
|
|
215
|
+
| `attributes.session.id` |  | str | 会话 ID | -- |
|
|
216
|
+
| `attributes.session.type` |  | enum | 会话类型 | 当前固定为 `user`。 |
|
|
217
|
+
| `attributes.session.phase` *[1]* |  | enum | 会话生命周期阶段 | -- |
|
|
218
|
+
|
|
219
|
+
**[1] `attributes.session.phase`**：
|
|
220
|
+
|
|
221
|
+
| 值 | 描述 |
|
|
222
|
+
| ------- | ---------------------- |
|
|
223
|
+
| `start` | 创建首个 Session。 |
|
|
224
|
+
| `rotate` | 旧 Session 到期后创建新 Session。 |
|
|
225
|
+
| `end` | 当前 Session 结束。 |
|
|
226
|
+
|
|
227
|
+
### g. view
|
|
228
|
+
|
|
229
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
230
|
+
| ------------------------------------- | -------------------------------------------------------------- | ------ | ----------------------- | --------------------------------------------- |
|
|
231
|
+
| `attributes.view.id` |  | str | 视图 ID | |
|
|
232
|
+
| `attributes.view.name` *[1]* |  | str | 视图名称 | 如 `/apm/home`。 |
|
|
233
|
+
| `attributes.view.loading_type` *[2]* |  | str | 视图加载类型 | -- |
|
|
234
|
+
| `attributes.view.url` |  | str | 视图 URL | 如 `https://example.com/cur`。 |
|
|
235
|
+
| `attributes.view.previous` |  | str | 视图 URL（前一个） | 如 `https://example.com/pre`。 |
|
|
236
|
+
| `attributes.view.previous_url_template` |  | str | 前序视图路径模板 | 与 `view.url_template` 使用同一规则；初始 View 为空字符串。 |
|
|
237
|
+
| `attributes.view.referrer` |  | str | 初始来源页面 URL | 仅首次加载且值非空时上报，需进行 URL 脱敏。 |
|
|
238
|
+
| `attributes.view.url_template` *[3]* |  | str | 视图路径分组 | 如 `/apm/home`。 |
|
|
239
|
+
| `attributes.view.loading_time` |  | number | 视图加载耗时（ms） | 加载时间计算完成后上报。 |
|
|
240
|
+
| `attributes.view.loading_time_source` |  | enum | 视图加载耗时来源 | `auto`、`manual`。 |
|
|
241
|
+
| `attributes.view.first_byte` |  | number | 首字节时间（ms） | 仅初始导航存在。 |
|
|
242
|
+
| `attributes.view.dom_interactive` |  | number | DOM 可交互时间（ms） | 仅初始导航存在。 |
|
|
243
|
+
| `attributes.view.dom_content_loaded` |  | number | DOMContentLoaded 时间（ms） | 仅初始导航存在。 |
|
|
244
|
+
| `attributes.view.dom_complete` |  | number | DOM Complete 时间（ms） | 仅初始导航存在。 |
|
|
245
|
+
| `attributes.view.load_event` |  | number | Load Event 时间（ms） | 仅初始导航存在。 |
|
|
246
|
+
| `attributes.view.phase` *[4]* |  | enum | 视图生命周期阶段 | 枚举值：<br>- start<br>- update<br>- end |
|
|
247
|
+
| `attributes.view.started_at` |  | number | 视图开始时间（ms） | 取 `performance.timeOrigin`。 |
|
|
248
|
+
| `attributes.view.version` |  | int | 视图事件版本号 | 同一 `attributes.view.id` 从 `1` 开始递增，用于排序和幂等合并。 |
|
|
249
|
+
| `attributes.view.end_reason` |  | str | 结束原因 | -- |
|
|
250
|
+
|
|
251
|
+
**[1] `attributes.view.name`**：仅由 `startView({ name })` 或 `setViewName` 显式设置；未设置时，展示层可回退到 `view.url_template`。
|
|
252
|
+
|
|
253
|
+
**[2] `attributes.view.loading_type`**：
|
|
254
|
+
|
|
255
|
+
| 值 | 描述 |
|
|
256
|
+
| ----------------- | --------------- |
|
|
257
|
+
| `initial_load` | 首次页面加载（初始导航） |
|
|
258
|
+
| `route_change` | SPA 路由切换 |
|
|
259
|
+
| `session_renewal` | 会话续期后重建 |
|
|
260
|
+
| `bf_cache` | 从浏览器 BFCache 恢复 |
|
|
261
|
+
|
|
262
|
+
**[3] `attributes.view.url_template`**：用于聚合的页面路径。默认把数字 ID、UUID 和长十六进制段替换为 `:id`，也可由 `tracking.view.getUrlTemplate` 自定义。
|
|
263
|
+
|
|
264
|
+
**[4] `attributes.view.phase`**：当前 View Span 的生命周期阶段，Schema v3 不再用一条长 Span 表达整个 View，而是发送多条瞬时生命周期 Span。
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
```text
|
|
268
|
+
逻辑 View：view.id=view-A
|
|
269
|
+
│
|
|
270
|
+
├── Span #1：version=1，phase=start
|
|
271
|
+
│ │
|
|
272
|
+
│ ├── 上报时机：View 创建
|
|
273
|
+
│ ├── view.loading_time = 不存在
|
|
274
|
+
│ ├── view.first_byte = 120 ← 创建时已可读取
|
|
275
|
+
│ ├── view.dom_interactive = 不存在 ← 此时还是 0
|
|
276
|
+
│ ├── view.dom_content_loaded = 不存在
|
|
277
|
+
│ ├── view.dom_complete = 不存在
|
|
278
|
+
│ └── view.load_event = 不存在
|
|
279
|
+
│
|
|
280
|
+
│ SDK 创建 View 时读取一次 PerformanceNavigationTiming。
|
|
281
|
+
│ 只写入当时已经大于 0 的字段。
|
|
282
|
+
│
|
|
283
|
+
├── Span #2：version=2，phase=update
|
|
284
|
+
│ │
|
|
285
|
+
│ ├── 上报时机：Loading Time 计算完成
|
|
286
|
+
│ ├── view.loading_time = 820
|
|
287
|
+
│ ├── view.first_byte = 120
|
|
288
|
+
│ ├── view.dom_interactive = 350
|
|
289
|
+
│ ├── view.dom_content_loaded = 420
|
|
290
|
+
│ ├── view.dom_complete = 680
|
|
291
|
+
│ └── view.load_event = 700
|
|
292
|
+
│
|
|
293
|
+
│ SDK 等待以下两个条件完成：
|
|
294
|
+
│ ├── loadEventEnd 已产生
|
|
295
|
+
│ └── 页面请求、资源和 DOM 活动结束
|
|
296
|
+
│
|
|
297
|
+
│ 然后重新读取 PerformanceNavigationTiming，
|
|
298
|
+
│ 将六个字段一起放入 update Span。
|
|
299
|
+
│
|
|
300
|
+
└── Span #3：version=3，phase=end
|
|
301
|
+
│
|
|
302
|
+
├── 上报时机：路由切换或页面离开
|
|
303
|
+
├── view.loading_time = 820
|
|
304
|
+
├── view.first_byte = 120
|
|
305
|
+
├── view.dom_interactive = 350
|
|
306
|
+
├── view.dom_content_loaded = 420
|
|
307
|
+
├── view.dom_complete = 680
|
|
308
|
+
└── view.load_event = 700
|
|
309
|
+
|
|
310
|
+
end Span 不会重新计算这些字段，
|
|
311
|
+
只是携带 View 当前的最终属性快照。
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
```text
|
|
316
|
+
时间 ───────────────────────────────────────────────────────────>
|
|
317
|
+
|
|
318
|
+
View A ███████████████████████████████│
|
|
319
|
+
├─ 查询订单 Action
|
|
320
|
+
└──── GET /api/orders ─────────┘
|
|
321
|
+
│ 路由切换
|
|
322
|
+
View B ███████████████████████│
|
|
323
|
+
├─ 查询用户 Action
|
|
324
|
+
└── GET /api/users ────┘
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
### h. resource
|
|
328
|
+
|
|
329
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
330
|
+
| -------------------------------------------- | ---------------------------------------------------------- | ------- | ------------------- | ----------------------------------------------------------------------- |
|
|
331
|
+
| `attributes.resource.type` |  | enum | 资源类型 | -- |
|
|
332
|
+
| `attributes.resource.size` |  | int | 资源大小 | -- |
|
|
333
|
+
| `attributes.resource.transfer_size` |  | int | 传输大小 | -- |
|
|
334
|
+
| `attributes.resource.decoded_body_size` |  | int | 解码后正文大小 | -- |
|
|
335
|
+
| `attributes.resource.encoded_body_size` |  | int | 编码后正文大小 | -- |
|
|
336
|
+
| `attributes.resource.protocol` |  | str | 传输协议 | 浏览器提供下一跳协议时存在，如 `h2`、`h3`、`http/1.1`。 |
|
|
337
|
+
| `attributes.resource.cache.hit` |  | boolean | 是否缓存命中 | -- |
|
|
338
|
+
| `attributes.resource.delivery_type` |  | str | 交付类型 | 浏览器提供交付类型时存在，如 `cache`、`navigational-prefetch`、`cache-storage`、`other`。 |
|
|
339
|
+
| `attributes.resource.render_blocking_status` |  | enum | 渲染阻塞状态 | 浏览器提供渲染阻塞状态时存在，枚举值为 `blocking`、`non-blocking` |
|
|
340
|
+
| `attributes.resource.redirect.start` |  | number | 重定向开始时间 | -- |
|
|
341
|
+
| `attributes.resource.redirect.duration` |  | number | 重定向耗时 | -- |
|
|
342
|
+
| `attributes.resource.worker.start` |  | number | Service Worker 开始时间 | -- |
|
|
343
|
+
| `attributes.resource.worker.duration` |  | number | Service Worker 耗时 | -- |
|
|
344
|
+
| `attributes.resource.dns.start` |  | number | DNS 查询开始时间 | -- |
|
|
345
|
+
| `attributes.resource.dns.duration` |  | number | DNS 查询耗时 | -- |
|
|
346
|
+
| `attributes.resource.connect.start` |  | number | 传输连接开始时间 | -- |
|
|
347
|
+
| `attributes.resource.connect.duration` |  | number | 传输连接耗时 | -- |
|
|
348
|
+
| `attributes.resource.ssl.start` |  | number | TLS 握手开始时间 | -- |
|
|
349
|
+
| `attributes.resource.ssl.duration` |  | number | TLS 握手耗时 | -- |
|
|
350
|
+
| `attributes.resource.first_byte.start` |  | number | 首字节阶段开始时间 | -- |
|
|
351
|
+
| `attributes.resource.first_byte.duration` |  | number | 首字节耗时 | -- |
|
|
352
|
+
| `attributes.resource.download.start` |  | number | 下载开始时间 | -- |
|
|
353
|
+
| `attributes.resource.download.duration` |  | number | 下载耗时 | -- |
|
|
354
|
+
|
|
355
|
+
**[1] `attributes.resource.type`**：
|
|
356
|
+
|
|
357
|
+
| 值 | 描述 |
|
|
358
|
+
| ------------------ | -------------------------------------------- |
|
|
359
|
+
| `fetch` | Fetch API 请求。 |
|
|
360
|
+
| `xhr` | XMLHttpRequest 请求。 |
|
|
361
|
+
| `script` | `<script>`、模块或 Worker 加载的脚本资源。 |
|
|
362
|
+
| `link` | `<link>` 加载的资源，如样式表、预加载和预取资源。 |
|
|
363
|
+
| `img` / `image` | HTML 或 SVG 图片元素加载的资源。 |
|
|
364
|
+
| `css` | CSS `url()`、`@import` 等规则加载的资源，不表示 CSS 文件本身。 |
|
|
365
|
+
| `iframe` / `frame` | 内嵌页面加载的文档资源。 |
|
|
366
|
+
| `other` | 浏览器未识别发起方式、`initiatorType` 为空或未单列的其他类型。 |
|
|
367
|
+
| ... | .. |
|
|
368
|
+
|
|
369
|
+
**[2] 单位**：`xx_size` 为 bytes，`duration` & `start` 为毫秒。
|
|
370
|
+
|
|
371
|
+
**[3] 阶段图**：产品阶段划分见 [0x04 资源加载时序](#0x04-资源加载时序)。
|
|
372
|
+
|
|
373
|
+
### i. action
|
|
374
|
+
|
|
375
|
+
| 字段 | 状态 | 类型 | 描述 |
|
|
376
|
+
| ------------------------------------------ | ---------------------------------------------------------- | ----- | ------ |
|
|
377
|
+
| `attributes.action.id` |  | str | -- |
|
|
378
|
+
| `attributes.action.type` *[2]* |  | str | 动作类型 |
|
|
379
|
+
| `attributes.action.target.name` |  | str | 目标元素名称 |
|
|
380
|
+
| `attributes.action.target.tag` |  | str | 目标元素标签 |
|
|
381
|
+
| `attributes.action.frustration.type` *[3]* |  | str[] | 挫败类型 |
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
**[1] `attributes.action.loading_time`**：`loading_time` 可直接使用外层 `elapsed_time`。
|
|
385
|
+
|
|
386
|
+
**[2] `attributes.action.type`**：
|
|
387
|
+
|
|
388
|
+
| 常见值 | 描述 |
|
|
389
|
+
| -------------------- | ---------------------------------- |
|
|
390
|
+
| `click` | 鼠标或指针设备触发的点击，蓝鲸 Web 自动 Action 当前使用该值。 |
|
|
391
|
+
| `custom` | 通过 SDK API 主动上报的自定义 Action。 |
|
|
392
|
+
| `tap` | 触屏设备上的单次轻触。 |
|
|
393
|
+
| `scroll` | 页面或滚动容器的滚动操作。 |
|
|
394
|
+
| `swipe` | 触屏设备上的滑动手势。 |
|
|
395
|
+
| `application_start` | 应用启动，常用于移动端或桌面端。 |
|
|
396
|
+
| `back` | 返回上一页面或上一导航状态，常用于移动端。 |
|
|
397
|
+
|
|
398
|
+
以上是跨端常见值，不是封闭枚举。蓝鲸 Web 当前产生 `click` 和 `custom`。转换 Aegis 数据时，还可能保留接入方配置的 DOM 事件名。
|
|
399
|
+
|
|
400
|
+
**[3] `attributes.action.frustration.type`**：
|
|
401
|
+
|
|
402
|
+
| 值 | 描述 |
|
|
403
|
+
| ------------- | ------------------------------------------------------------------------------------ |
|
|
404
|
+
| `rage_click` | [a] `1 s` 内对同一 DOM 元素连续点击至少 `3` 次，且相邻点击距离不超过 `100 px`。<br />[b] 滚动或文本选择会中断或撤销判定。 |
|
|
405
|
+
| `dead_click` | [a] 点击后未检测到请求、资源加载、长任务、DOM 变化、打开窗口或错误，也没有输入、滚动或文本选择。<br />[b] 链接、文本输入框等难以可靠判断的目标会排除。 |
|
|
406
|
+
| `error_click` | Action 生命周期内检测到前端错误。 |
|
|
407
|
+
|
|
408
|
+
该字段为数组，同一个 Action 可以同时命中多个值；未命中时不写入。消费端应按集合处理，不依赖数组顺序。这些信号是 SDK 的启发式判断，不等同于业务操作失败。
|
|
409
|
+
|
|
410
|
+
### j. http & [url](https://opentelemetry.io/docs/specs/semconv/registry/attributes/url/) & server
|
|
411
|
+
|
|
412
|
+
| 字段 | 状态 | 类型 | 描述 | |
|
|
413
|
+
| -------------------------------------- | ---------------------------------------------------------- | --- | ------ | ---------------------------- |
|
|
414
|
+
| `attributes.url.full` |  | str | 完整 URL | 如 `https://example.com/apm`。 |
|
|
415
|
+
| `attributes.url.scheme` |  | str | 协议 | 如 `ws`、`wss`。 |
|
|
416
|
+
| `attributes.url.template` |  | str | 请求路径 | 如 `/api/users/`。 |
|
|
417
|
+
| `attributes.http.request.method` |  | str | 请求方法 | 如 `GET`、`POST`。 |
|
|
418
|
+
| `attributes.http.response.status_code` |  | int | 返回码 | 如 `200`、`404`。 |
|
|
419
|
+
| `attributes.server.address` |  | str | 地址 | 如 `example.com`。 |
|
|
420
|
+
| `attributes.server.port` |  | int | 端口 | -- |
|
|
421
|
+
|
|
422
|
+
### k. vital
|
|
423
|
+
|
|
424
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
425
|
+
| --------------------------------------------- | ---------------------------------------------------------- | ------ | -------------------- | ------------------------------------ |
|
|
426
|
+
| `attributes.vital.id` |  | str | Vital 唯一标识 | |
|
|
427
|
+
| `attributes.vital.metric` |  | enum | 指标名 | |
|
|
428
|
+
| `attributes.vital.value` |  | number | 指标测量值 | |
|
|
429
|
+
| `attributes.vital.inp.input_delay` |  | number | 输入延迟（ms） | 用户发起交互（如点击）到事件处理器开始执行的等待时间，反映主线程繁忙程度 |
|
|
430
|
+
| `attributes.vital.inp.interaction_target` |  | str | 交互目标元素标识 | 如 `div`。 |
|
|
431
|
+
| `attributes.vital.inp.interaction_type` |  | str | 交互类型 | -- |
|
|
432
|
+
| `attributes.vital.inp.processing_duration` |  | number | 处理耗时（ms） | -- |
|
|
433
|
+
| `attributes.vital.inp.presentation_delay` |  | number | 呈现延迟（ms） | -- |
|
|
434
|
+
| `attributes.vital.lcp.target` |  | str | DOM 选择器 | 如 `div`。 |
|
|
435
|
+
| `attributes.vital.lcp.url` |  | str | 元素对应资源 URL（已脱敏） | -- |
|
|
436
|
+
| `attributes.vital.lcp.resource_load_duration` |  | number | 资源加载耗时（ms） | -- |
|
|
437
|
+
| `attributes.vital.lcp.element_render_delay` |  | number | 元素渲染延迟（ms） | -- |
|
|
438
|
+
| `attributes.vital.ttfb.waiting_duration` |  | number | 请求就绪后的等待耗时（ms） | -- |
|
|
439
|
+
| `attributes.vital.ttfb.dns_duration` |  | number | DNS 解析耗时（ms） | -- |
|
|
440
|
+
| `attributes.vital.ttfb.connection_duration` |  | number | TCP + TLS 连接建立耗时（ms） | -- |
|
|
441
|
+
| `attributes.vital.ttfb.request_duration` |  | number | 请求发送后等待首字节耗时（ms） | -- |
|
|
442
|
+
|
|
443
|
+
**[1] `attributes.vital.metric`**：
|
|
444
|
+
|
|
445
|
+
| 值 | 描述 | 备注 |
|
|
446
|
+
| ---- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
|
447
|
+
| cls | [累积布局偏移（Cumulative Layout Shift）](https://web.dev/articles/cls) | 在整个页面生命周期中，每次出现的意外布局变化所导致的最大布局变化得分的累积值，为了提供良好的用户体验，网站的 CLS 得分应控制在 0.1 或更低。 |
|
|
448
|
+
| inp | [交互到下一次绘制（Interaction to Next Paint）](https://web.dev/articles/inp) | 记录用户与页面进行的所有交互的延迟情况，并给出一个综合评分（通常是 P98，忽略极端值），较低的 INP 值意味着页面能够快速响应所有或绝大多数用户交互，INP 值在用户离开页面时会被计算出来。 |
|
|
449
|
+
| lcp | [最大内容绘制（Largest Contentful Paint, LCP）](https://web.dev/articles/lcp) | Core Web Vital 中的一个重要且稳定的指标，测量从页面开始加载，到视窗中可见的最大图像、文本块或视频的渲染时间，用于衡量页面加载的速度（用户感受：页面主要内容出来了）。 |
|
|
450
|
+
| fcp | [首次内容绘制（First Contentful Paint）](https://web.dev/articles/fcp) | 从用户首次访问页面，到页面第一次显示出任何内容的耗时（用户感受：不是白屏了）。 |
|
|
451
|
+
| ttfb | [首字节时间（Time to First Byte）](https://web.dev/articles/ttfb) | 从用户开始导航到页面到响应首字节开始传输之间所经历的时间。 |
|
|
452
|
+
|
|
453
|
+
**[2] `attributes.vital.value`**：CLS 单位为 `1`，FCP、INP、LCP、TTFB 单位为 `ms`。
|
|
454
|
+
|
|
455
|
+
**[3] `attributes.vital.cls.largest_shift_value` & `attributes.vital.cls.largest_shift_target`**：Aegis & DataDog 无采集，废弃。
|
|
456
|
+
|
|
457
|
+
**[4] `attributes.vital.inp.interaction_type`**：交互类型。
|
|
458
|
+
|
|
459
|
+
| 值 | 描述 |
|
|
460
|
+
| ------------- | ------------- |
|
|
461
|
+
| `keyup` | 松开按键 |
|
|
462
|
+
| `keydown` | 按下按键 |
|
|
463
|
+
| `pointerdown` | 点击（鼠标、触屏、触控笔） |
|
|
464
|
+
| `pointerup` | 松开 |
|
|
465
|
+
|
|
466
|
+
**[5] `attributes.vital.inp.processing_duration`**：事件处理回调（如 click handler）本身的执行时间，JS 逻辑过重时这个值会变大。
|
|
467
|
+
|
|
468
|
+
**[6] `attributes.vital.inp.presentation_delay`**：回调操作完成之后到该帧最终显示在用户屏幕上所需的时间。
|
|
469
|
+
|
|
470
|
+
**[7] `attributes.vital.lcp.element_render_delay`**：LCP 元素资源加载完成后，到浏览器真正渲染该元素之间的等待时间（主要由主线程阻塞（长任务/JS 执行）导致）。
|
|
471
|
+
|
|
472
|
+
**[8] `attributes.vital.lcp.resource_load_duration`**：LCP 元素依赖的外部资源（图片/字体等）从请求到下载完成的时间（如果 LCP 是纯文本节点，此项可能缺失），用于排查 CDN/网络/资源体积问题。
|
|
473
|
+
|
|
474
|
+
**[9] `attributes.vital.lcp.time_to_first_byte`**：从导航开始到收到首字节的耗时（LCP ≈ `time_to_first_byte` + `resource_load_duration` + `element_render_delay`）。
|
|
475
|
+
|
|
476
|
+
**[10] `attributes.vital.ttfb.waiting_duration`**：页面激活到浏览器开始 Fetch，或开始启动 Service Worker 前的时间（包含重定向及浏览器前置处理）。
|
|
477
|
+
|
|
478
|
+
**[11] `attributes.vital.ttfb.dns_duration`**：解析慢通常由 DNS 服务器延迟、复杂 CNAME 链或本地 DNS 缓存失效导致（多国/多地域部署时此值可能偏高）。
|
|
479
|
+
|
|
480
|
+
**[12] `attributes.vital.ttfb.connection_duration`**：TCP / QUIC 建连及 TLS 协商，连接复用时通常为 `0`。
|
|
481
|
+
|
|
482
|
+
**[13] `attributes.vital.ttfb.request_duration`**：建连结束到收到首字节，包含调度空档、请求发送、网络 RTT 和服务端处理。
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
### l. blank_screen
|
|
486
|
+
> _**白屏（Blank Screen）**：非 Web 标准指标。页面可见且活动稳定后，SDK 对指定根元素范围内的视口进行采样；排除加载态样本后，如果空白样本占有效样本的比例达到阈值，并在二次检测中仍然成立，则判定为白屏。_
|
|
487
|
+
|
|
488
|
+
| 字段 | 状态 | 类型 | 描述 | 备注 |
|
|
489
|
+
| ---------------------------------------------- | --------------------------------------------------------------- | ------- | ---------------- | ------------------ |
|
|
490
|
+
| `attributes.blank_screen.reason` *[1]* |  | str | 白屏判定原因 | |
|
|
491
|
+
| `attributes.blank_screen.empty_ratio` |  | number | 有效样本中的空白比例 | |
|
|
492
|
+
| `attributes.blank_screen.empty_sample_count` |  | int | 空白采样数 | |
|
|
493
|
+
|
|
494
|
+
**[1] `attributes.blank_screen.reason`**：
|
|
495
|
+
|
|
496
|
+
| 值 | 描述 |
|
|
497
|
+
| ---------------- | --------------------------------------------------------------------------------------- |
|
|
498
|
+
| `empty_viewport` | 配置的采样根元素存在，有效采样点的空白比例达到白屏阈值。 |
|
|
499
|
+
| `missing_root` | 未找到 `root_selector` 指定的根元素，SDK 回退到 `body`（不可用时使用 `documentElement`）检测，且回退检测仍达到白屏阈值。 |
|
|
500
|
+
|
|
501
|
+
### m. longtask
|
|
502
|
+
|
|
503
|
+
| 字段 | 状态 | 类型 | 描述 |
|
|
504
|
+
| ----------------------------------------------- | --------------------------------------------------------------- | ------ | -------------------- |
|
|
505
|
+
| `attributes.long_task.id` |  | str | 长任务或长动画帧 ID |
|
|
506
|
+
| `attributes.long_task.name` |  | str | Performance Entry 名称 |
|
|
507
|
+
| `attributes.long_task.entry_type` *[1]* |  | str | 采集条目类型 |
|
|
508
|
+
| `attributes.long_task.blocking_duration` |  | number | 主线程阻塞耗时（ms） |
|
|
509
|
+
| `attributes.long_task.first_ui_event_timestamp` |  | number | 首个 UI 事件时间（ms） |
|
|
510
|
+
| `attributes.long_task.render_start` |  | number | 渲染阶段开始时间（ms） |
|
|
511
|
+
| `attributes.long_task.style_and_layout_start` |  | number | 样式与布局阶段开始时间（ms） |
|
|
512
|
+
|
|
513
|
+
**[1] `attributes.long_task.entry_type`**：
|
|
514
|
+
|
|
515
|
+
| 值 | 描述 |
|
|
516
|
+
| ------------------------ | ------------------------------------------------------------------- |
|
|
517
|
+
| `long-animation-frame` | 通过 Long Animation Frame API 采集，包含主线程阻塞、渲染、样式与布局阶段以及脚本归因信息。 |
|
|
518
|
+
| `long-task` | 通过 Long Tasks API 采集，用于不支持 Long Animation Frame API 的浏览器，只提供长任务基础信息。 |
|
|
519
|
+
|
|
520
|
+
### n. custom
|
|
521
|
+
|
|
522
|
+
`reportCustomEvent()` 产生 `custom.<name>` Span。
|
|
523
|
+
|
|
524
|
+
## 0x04 资源加载时序
|
|
525
|
+
|
|
526
|
+
本文对照 W3C Resource Timing、Chrome Timing 和 web.dev，并给出 Resource Span 请求时序的产品划分。适用范围是单次 `resource` Span 的阶段图，不含 View 导航瀑布。
|
|
527
|
+
|
|
528
|
+
阶段名称靠近 Chrome Timing。每段时长用已上报的 `attributes.resource.*.duration` 计算，起点用对应的 `start`，单位为毫秒，相对该资源 `startTime`。
|
|
529
|
+
|
|
530
|
+
产品按 `attributes.view.id` 关联 View 生命周期快照后，可用 `attributes.view.previous_url_template` 展示资源所属页面的前序路由。该字段与 `attributes.view.url_template` 使用同一模板规则，初始 View 为空字符串；它不参与 Resource Timing 阶段计算，也不直接写入 `resource` Span。
|
|
531
|
+
|
|
532
|
+
### a. W3C Resource Timing
|
|
533
|
+
|
|
534
|
+
规范记录的是时间点，不是产品上的色块。浏览器按发生顺序打点，产品上的每一段是相邻两点相减。来源：[Resource Timing](https://www.w3.org/TR/resource-timing/)。
|
|
535
|
+
|
|
536
|
+
| 顺序 | 时间点 | 含义 |
|
|
537
|
+
| --- | --- | --- |
|
|
538
|
+
| 1 | `startTime` | 这次取资源开始 |
|
|
539
|
+
| 2 | `redirectStart` | 第一次重定向开始 |
|
|
540
|
+
| 3 | `redirectEnd` | 最后一次重定向的响应收完 |
|
|
541
|
+
| 4 | `workerStart` | Service Worker 开始处理这次请求；未拦截时为 `0` |
|
|
542
|
+
| 5 | `fetchStart` | 重定向结束后，开始取最终资源 |
|
|
543
|
+
| 6 | `domainLookupStart` | DNS 查询开始 |
|
|
544
|
+
| 7 | `domainLookupEnd` | DNS 查询结束 |
|
|
545
|
+
| 8 | `connectStart` | 开始建立到服务器的连接 |
|
|
546
|
+
| 9 | `secureConnectionStart` | TLS 握手开始；非 HTTPS 时为 `0` |
|
|
547
|
+
| 10 | `connectEnd` | 连接建立完成，TLS 包含在内 |
|
|
548
|
+
| 11 | `requestStart` | 开始向服务器发请求 |
|
|
549
|
+
| 12 | `firstInterimResponseStart` | 中间响应，例如 `103` |
|
|
550
|
+
| 13 | `responseStart` | 收到响应首字节 |
|
|
551
|
+
| 14 | `finalResponseHeadersStart` | 最终响应头开始，通常是 `200` |
|
|
552
|
+
| 15 | `responseEnd` | 最后一字节到达，或连接先关闭 |
|
|
553
|
+
|
|
554
|
+
用上面的时间点可以算出这些耗时：
|
|
555
|
+
|
|
556
|
+
| 顺序 | 耗时 | 计算 |
|
|
557
|
+
| --- | --- | --- |
|
|
558
|
+
| 1 | 重定向 | `redirectEnd − redirectStart` |
|
|
559
|
+
| 2 | Service Worker | `fetchStart − workerStart` |
|
|
560
|
+
| 3 | DNS | `domainLookupEnd − domainLookupStart` |
|
|
561
|
+
| 4 | 建立连接（含 TLS） | `connectEnd − connectStart` |
|
|
562
|
+
| 5 | TLS 握手 | `connectEnd − secureConnectionStart` |
|
|
563
|
+
| 6 | 发出请求后等到首字节 | `responseStart − requestStart` |
|
|
564
|
+
| 7 | 接收响应体 | `responseEnd − responseStart` |
|
|
565
|
+
|
|
566
|
+
规范没有排队时间点。跨源资源未通过 Timing-Allow-Origin 检查时，重定向到 `responseStart` 之间的点会变成 `0`，只保留 `startTime`、`fetchStart`、总时长和 `responseEnd`。
|
|
567
|
+
|
|
568
|
+
`workerStart` 是重定向链最终请求上的 Service Worker 开始时间。`fetchStart` 是 post-redirect start。产品上的「后台脚本处理」发生在重定向之后。
|
|
569
|
+
|
|
570
|
+
### b. Chrome Timing
|
|
571
|
+
|
|
572
|
+
Chrome 开发者工具中，点开一条请求的 Timing。一次请求不会出现全部标签。来源：[Chrome 网络面板说明](https://developer.chrome.com/docs/devtools/network/reference)。
|
|
573
|
+
|
|
574
|
+
| 顺序 | Timing 标签 | 含义 |
|
|
575
|
+
| --- | --- | --- |
|
|
576
|
+
| 1 | Queueing | 连接开始前排队：存在更高优先级请求，或同一源连接数已满 |
|
|
577
|
+
| 2 | Stalled | 连接开始后仍可能因 Queueing 同类原因停滞 |
|
|
578
|
+
| 3 | DNS Lookup | 解析域名对应的 IP |
|
|
579
|
+
| 4 | Initial connection | 建立连接，包含 TCP 握手和 TLS，不单列 TLS |
|
|
580
|
+
| 5 | Proxy negotiation | 与代理协商，仅走代理时出现 |
|
|
581
|
+
| 6 | Request sent | 正在发送 HTTP 请求 |
|
|
582
|
+
| 7 | ServiceWorker Preparation | 正在启动 Service Worker |
|
|
583
|
+
| 8 | Request to ServiceWorker | 请求交给 Service Worker |
|
|
584
|
+
| 9 | Waiting (TTFB) | 请求已发出，等待响应首字节。包含一趟网络往返和服务器准备时间 |
|
|
585
|
+
| 10 | Content Download | 读取响应体 |
|
|
586
|
+
|
|
587
|
+
常见可见：Queueing、DNS Lookup、Initial connection、Waiting (TTFB)、Content Download。连接已建立时，DNS Lookup 和 Initial connection 经常为 `0`。
|
|
588
|
+
|
|
589
|
+
Chrome 不单独上报 Queueing / Stalled / Request sent 到 RUM 字段，产品阶段图无法画出这三行。
|
|
590
|
+
|
|
591
|
+
### c. Google web.dev
|
|
592
|
+
|
|
593
|
+
web.dev 讲解同一组时间点，并单独定义页面导航的 Time to First Byte（TTFB，首字节时间）。来源：[Navigation and Resource Timing](https://web.dev/articles/navigation-and-resource-timing)、[TTFB](https://web.dev/articles/ttfb)。
|
|
594
|
+
|
|
595
|
+
| 顺序 | 阶段 | 时间点 | 含义 |
|
|
596
|
+
| --- | --- | --- | --- |
|
|
597
|
+
| 1 | Redirects | `redirectStart` / `redirectEnd` | HTTP 重定向 |
|
|
598
|
+
| 2 | DNS lookup | `domainLookupStart` / `domainLookupEnd` | DNS 解析 |
|
|
599
|
+
| 3 | Connection | `connectStart` → `secureConnectionStart` → `connectEnd` | 建连，HTTPS 时包含 TLS，TLS 耗时 = `connectEnd − secureConnectionStart` |
|
|
600
|
+
| 4 | Fetch | `fetchStart` | 开始取资源，会先查缓存 |
|
|
601
|
+
| 5 | Service worker | `workerStart` | 未拦截时为 `0` |
|
|
602
|
+
| 6 | Request | `requestStart` → `responseStart` | 发出请求到收到首字节 |
|
|
603
|
+
| 7 | Response | `responseStart` → `responseEnd` | 接收响应体 |
|
|
604
|
+
|
|
605
|
+
web.dev 的页面 TTFB 从导航开始算到 `responseStart`，包含：
|
|
606
|
+
|
|
607
|
+
1. 重定向
|
|
608
|
+
2. Service Worker 启动（如有）
|
|
609
|
+
3. DNS
|
|
610
|
+
4. 建连和 TLS
|
|
611
|
+
5. 发出请求直到首字节到达
|
|
612
|
+
|
|
613
|
+
Chrome Timing 的 Waiting (TTFB) 只等于第 `5` 项。Resource Span 的「等待首字节」跟 Chrome 这一行走，对应 `resource.first_byte.duration`。
|
|
614
|
+
|
|
615
|
+
### d. 产品建议
|
|
616
|
+
|
|
617
|
+
始终展示查找服务器、建立连接、加密连接、等待首字节、下载内容。上报了重定向或 Service Worker 时，再增加对应行。
|
|
618
|
+
|
|
619
|
+
时长用 `resource.*.duration`。建立连接需要减去 TLS：W3C 的 `connectEnd − connectStart` 已包含加密，直接展示完整 `connect.duration` 会和下一行重复。无 `ssl` 时使用完整 `connect.duration`。
|
|
620
|
+
|
|
621
|
+
#### 阶段与计算
|
|
622
|
+
|
|
623
|
+
| 顺序 | 产品名 | 出现条件 | 时长 |
|
|
624
|
+
| --- | --- | --- | --- |
|
|
625
|
+
| 1 | 重定向 | 上报了 `redirect.start` 和 `redirect.duration` | `attributes.resource.redirect.duration` |
|
|
626
|
+
| 2 | 后台脚本处理 | 上报了 `worker.start` 和 `worker.duration` | `attributes.resource.worker.duration` |
|
|
627
|
+
| 3 | 查找服务器 | 始终占一行 | `attributes.resource.dns.duration` |
|
|
628
|
+
| 4 | 建立连接 | 始终占一行 | 有 `ssl` 时：`connect.duration − ssl.duration`<br />无 `ssl` 时：`connect.duration` |
|
|
629
|
+
| 5 | 加密连接 | 始终占一行 | `attributes.resource.ssl.duration` |
|
|
630
|
+
| 6 | 等待首字节 | 始终占一行 | `attributes.resource.first_byte.duration` |
|
|
631
|
+
| 7 | 下载内容 | 始终占一行 | `attributes.resource.download.duration` |
|
|
632
|
+
|
|
633
|
+
时间轴上，建立连接画到 `ssl.start`，加密连接从 `ssl.start` 画到 `connect` 结束。
|
|
634
|
+
|
|
635
|
+
#### 说明与用户感受
|
|
636
|
+
|
|
637
|
+
| 阶段 | 说明 | 用户感受 |
|
|
638
|
+
| --- | --- | --- |
|
|
639
|
+
| 重定向 | [a] 浏览器跟随 HTTP 重定向，直到拿到最终 URL，对应 `redirectEnd − redirectStart`<br />[b] 未发生重定向时不上报 | [a] 目标内容还没开始出现<br />[b] 文档请求会延长白屏，接口请求会延长 loading |
|
|
640
|
+
| 后台脚本处理 | [a] Service Worker 拦截并处理该请求的时间，对应 `fetchStart − workerStart`<br />[b] 记录的是重定向之后、最终请求上的处理<br />[c] 未拦截时不上报 | [a] 界面没有单独提示<br />[b] 用户只会感到这次加载更慢，无法分辨是后台脚本在处理 |
|
|
641
|
+
| 查找服务器 | [a] DNS 解析耗时，对应 `domainLookupEnd − domainLookupStart`<br />[b] 解析结果已缓存、或未发起新查询时，可能为 `0` 或不上报 | [a] 内容尚未出现<br />[b] 用户无法感知「正在解析域名」，体验上仍是点了之后没有反应 |
|
|
642
|
+
| 建立连接 | [a] 传输连接中扣除 TLS 后的部分<br />[b] W3C 的 `connectEnd − connectStart` 包含加密，产品用 `connect.duration − ssl.duration`，避免与下一行重复 | [a] 内容尚未出现<br />[b] 用户无法感知「正在建连」，体验上仍是在等待 |
|
|
643
|
+
| 加密连接 | [a] TLS 握手，对应 `connectEnd − secureConnectionStart`<br />[b] 非 HTTPS、或未发生新握手时不上报 | [a] 内容尚未出现<br />[b] 用户无法感知「正在握手」，体验上仍是在等待 |
|
|
644
|
+
| 等待首字节 | [a] 从发出请求到收到响应首字节，对应 `responseStart − requestStart`<br />[b] 包含网络往返和服务端处理，浏览器时序无法拆分<br />[c] 对齐 Chrome Waiting (TTFB)，范围小于 web.dev 的页面 TTFB | [a] 本次请求的内容仍不可见：页面持续白屏或停留在旧画面，接口持续 loading<br />[b] 过慢时会感觉页面没有反应 |
|
|
645
|
+
| 下载内容 | [a] 从收到首字节到响应体接收完毕，对应 `responseEnd − responseStart`<br />[b] 耗时主要随体积和带宽变化 | [a] 内容开始出现并逐渐完整，图片、脚本会陆续可见<br />[b] 接口数据会从空状态填到页面上<br />[c] 体积大时，用户能感到「出来了但还在加载」 |
|
|
646
|
+
|
|
647
|
+
等待首字节拆不开服务端处理与网络往返。要判断服务端是否慢，需要结合 Trace 或 [Server Timing](https://www.w3.org/TR/server-timing/)。
|
|
648
|
+
|
|
649
|
+
#### 缺数字段
|
|
650
|
+
|
|
651
|
+
| 上报情况 | 页面展示 |
|
|
652
|
+
| --- | --- |
|
|
653
|
+
| `start` 与 `duration` 都在，且 `duration > 0` | 显示毫秒数，画出色块 |
|
|
654
|
+
| `start` 与 `duration` 都在，且 `duration = 0` | 写 `0` 毫秒。该步骤没有额外耗时 |
|
|
655
|
+
| 缺少 `start` 或 `duration` | 写「没有上报」，不画色块。可能该步骤未发生，也可能跨源不允许查看细分时间 |
|
|
656
|
+
|
|
657
|
+
查找服务器、建立连接、加密连接都没有上报时，写「没有上报」。跨源资源未暴露细分时间时表现相同，不能据此判断连接复用。
|
|
658
|
+
|
|
659
|
+
### e. 参考资料
|
|
660
|
+
|
|
661
|
+
| 来源 | 文档 |
|
|
662
|
+
| --- | --- |
|
|
663
|
+
| W3C | [Resource Timing](https://www.w3.org/TR/resource-timing/) |
|
|
664
|
+
| W3C | [Server Timing](https://www.w3.org/TR/server-timing/) |
|
|
665
|
+
| Chrome | [网络面板 · Timing](https://developer.chrome.com/docs/devtools/network/reference) |
|
|
666
|
+
| web.dev | [Navigation and Resource Timing](https://web.dev/articles/navigation-and-resource-timing) |
|
|
667
|
+
| web.dev | [Time to First Byte](https://web.dev/articles/ttfb) |
|