概述
创建时间：2024-09-24 最近修改时间：2024-09-24
#1. 概述
管理员页面与租户页面功能一致，详细见【租户页面】说明。
#2. 规格限制
#2.1 数据存储时长
| 项目 | 管理员规格 | 租户规格 | 说明 |
|---|---|---|---|
| 应用-指标（秒级） | 默认：1天 | 默认：1天 | 可在【系统-数据节点-监控数据存储配置】中修改 |
| 应用-指标（分钟级） | 默认：14天 | 默认：14天 | 可在【系统-数据节点-监控数据存储配置】中修改 |
| 应用-调用日志 | 默认：7天 | 默认：7天 | 可在【系统-数据节点-监控数据存储配置】中修改 |
| 文件读写事件保存时长 | 默认：7天 | 默认：7天 | 可在【系统-数据节点-监控数据存储配置】中修改 |
#2.2 应用协议列表
开源版本支持的协议列表见核心特性的描述，企业版在开源版支持的协议列表基础上额外支持：
#2.2.1 Orcale 协议
通过解析 Oracle 协议，将 Orcale Request / Response 的字段映射到 l7_flow_log 对应字段中，映射关系如下表：
Tag 字段映射表格，以下表格只包含存在映射关系的字段
| 类别 | 名称 | 中文 | Request Header | Response Header | 描述 |
|---|---|---|---|---|---|
| Req. | version | 协议版本 | -- | -- | -- |
| request_type | 请求类型 | packet_type | -- | Tns 协议数据包类型[1] | |
| request_domain | 请求域名 | -- | -- | -- | |
| request_resource | 请求资源 | sql | -- | 目前仅解析执行 SQL 的请求 [2] | |
| request_id | 请求 ID | -- | -- | -- | |
| endpoint | 端点 | -- | -- | -- | |
| Resp. | response_code | 响应码 | -- | code | 仅 data_id = 0x04 的消息 [3] |
| response_status | 响应状态 | -- | code | 仅 data_id = 0x04 的消息 [3] | |
| response_exception | 响应异常 | -- | exception | 仅 data_id = 0x04 的消息 [3] | |
| response_result | 响应结果 | -- | -- | -- | |
| Trace | trace_id | TraceID | SQL Comments | -- | -- |
| span_id | SpanID | SQL Comments | -- | -- | |
| x_request_id | X-Request-ID | -- | -- | -- | |
| Misc. | attribute.request_data_id | -- | Data ID | -- | 仅对于 packet_type 为 Data 而言 [4] |
| attribute.request_call_id | -- | Call ID | -- | 仅对于 packet_type 为 Data 而言 | |
| attribute.request_data_flags | -- | Data Flags | -- | 仅对于 packet_type 为 Data 而言 | |
| attribute.response_data_id | -- | -- | Data ID | 仅对于 packet_type 为 Data 而言 | |
| attribute.response_data_flags | -- | -- | Data Flags | 仅对于 packet_type 为 Data 而言 |
- [1] 所有的 packet_type 参考：wireshark packet_type (opens new window)
- [2] 目前分析出来的结果，SQL 请求的 data_id 和 call_id 有 3 种组合，分别是
- 0x11，0x69
- 0x11，0x6b
- 0x03，0x5e
- [3] 如何确定状态码
- data_id = 0x04 的消息，状态码 0 和 1403（no data found）认为是正常（且 1403 会被重写为 0），除此之外都认为是异常，并会提取错误信息
- data_id != 0x04 的消息，都认为是正常
- [4] Data ID、Call ID、Data Flags 仅存在于 packet_type 为 Data 的报文中，Response 报文没有 Data Flags
- 所有的 Data ID 参考：wireshark data_id (opens new window)
- 所有的 Call ID 参考：wireshark call_id (opens new window)
- 所有的 Data Flags 参考：wireshark data_flags (opens new window)，若 Data Flags 包含“End of File”，则该报文不会有 data_id 和 call_id，目前发现只有 Request 报文可能含有 “End of File” 且后续没有 Response 报文与之聚合
Metrics 字段映射表格，以下表格只包含存在映射关系的字段
| 名称 | 中文 | Request | Response | 描述 |
|---|---|---|---|---|
| request | 请求 | -- | -- | Request 个数 |
| response | 响应 | -- | -- | Response 个数 |
| sql_affected_rows | SQL影响行数 | -- | data_id = 0x08 的响应报文后续跟着的 data_id = 0x04 的结构中提取出 Affected Rows | -- |
| log_count | 日志总量 | -- | -- | -- |
| error | 异常 | -- | -- | 客户端异常 + 服务端异常 |
| client_error | 客户端异常 | -- | ERROR CODE | 参考 Tag 字段response_code的说明 |
| server_error | 服务端异常 | -- | -- | -- |
| error_ratio | 异常比例 | -- | -- | 异常 / 响应 |
| client_error_ratio | 客户端异常比例 | -- | -- | 客户端异常 / 响应 |
| server_error_ratio | 服务端异常比例 | -- | -- | 服务端异常 / 响应 |
#2.2.2 TLS 协议
通过解析 TLS (opens new window) 协议，将 TLS Request / Response 的字段映射到 l7_flow_log 对应字段中，映射关系如下 表：
Tag 字段映射表格，以下表格只包含存在映射关系的字段
| 类别 | 名称 | 中文 | Request Header | Response Header | 描述 |
|---|---|---|---|---|---|
| Req. | version | 协议版本 | Version | -- | 来自 Record Layer 或 Handshake |
| request_type | 请求类型 | Content Type + Handshake Type | -- | -- | |
| request_domain | 请求域名 | Server Name | -- | -- | |
| request_resource | 请求资源 | Server Name | -- | -- | |
| request_id | 请求 ID | -- | -- | -- | |
| endpoint | 端点 | -- | -- | -- | |
| Resp. | response_code | 响应码 | -- | -- | -- |
| response_status | 响应状态 | -- | Alert | 仅 Alert 消息认为是异常 | |
| response_exception | 响应异常 | -- | -- | -- | |
| response_result | 响应结果 | -- | Content Type + Handshake Type | -- | |
| Trace | trace_id | TraceID | -- | -- | -- |
| span_id | SpanID | -- | -- | -- | |
| x_request_id | X-Request-ID | -- | -- | -- | |
| Misc. | attribute.cipher_suite | -- | Cipher Suite | -- | 来自 Server Hello |
| attribute.client_cert_not_before | -- | signedCertificate | -- | 来自 Certificate | |
| attribute.client_cert_not_after | -- | signedCertificate | -- | 来自 Certificate | |
| attribute.server_cert_not_before | -- | -- | signedCertificate | 来自 Certificate | |
| attribute.server_cert_not_after | -- | -- | signedCertificate | 来自 Certificate |
Metrics 字段映射表格，以下表格只包含存在映射关系的字段
| 名称 | 中文 | Request | Response | 描述 |
|---|---|---|---|---|
| request | 请求 | -- | -- | Request 个数 |
| response | 响应 | -- | -- | Response 个数 |
| log_count | 日志总量 | -- | -- | Request Log 行数 |
| error | 异常 | -- | -- | 客户端异常 + 服务端异常 |
| client_error | 客户端异常 | -- | -- | -- |
| server_error | 服务端异常 | -- | Alert | 目前Alert全部为服务端错误 |
| error_ratio | 异常比例 | -- | -- | 异常 / 响应 |
| client_error_ratio | 客户端异常比例 | -- | -- | 客户端异常 / 响应 |
| server_error_ratio | 服务端异常比例 | -- | -- | 服务端异常 / 响应 |
| client_cert_valid_days | -- | Certificate | -- | 使用client_cert_not_after减去当前时间(UTC) |
| server_cert_valid_days | -- | -- | Certificate | 使用server_cert_not_after减去当前时间(UTC) |
#2.2.3 SOME/IP 协议
通过解析 SOME/IP (opens new window) 协议，将 SOME/IP Request / Response 的字段映射到 l7_flow_log 对应字段中，映射关系如下
Tag 字段映射表格，以下表格只包含存在映射关系的字段
| 类别 | 名称 | 中文 | Request Header | Response Header | 描述 |
|---|---|---|---|---|---|
| Req. | version | 协议版本 | Protocol Version + Interface Version | -- | -- |
| request_type | 请求类型 | Message Type | -- | -- | |
| request_resource | 请求资源 | Service ID | -- | -- | |
| request_id | 请求 ID | Session ID | -- | -- | |
| endpoint | 端点 | Method ID | -- | -- | |
| Resp. | response_code | 响应码 | Return Code | -- | |
| response_exception | 响应异常 | Return Code | -- | ||
| Misc. | attribute.client_id | -- | Client ID | -- | -- |
Metrics 字段映射表格，以下表格只包含存在映射关系的字段
| 名称 | 中文 | Request | Response | 描述 |
|---|---|---|---|---|
| request | 请求 | -- | -- | Request 个数 |
| response | 响应 | -- | -- | Response 个数 |
| log_count | 日志总量 | -- | -- | Request Log 行数 |
| error | 异常 | -- | -- | 客户端异常 + 服务端异常 |
| client_error | 客户端异常 | -- | -- | -- |
| server_error | 服务端异常 | -- | -- | 目前Alert全部为服务端错误 |
| error_ratio | 异常比例 | -- | -- | 异常 / 响应 |
| client_error_ratio | 客户端异常比例 | -- | -- | 客户端异常 / 响应 |
| server_error_ratio | 服务端异常比例 | -- | -- | 服务端异常 / 响应 |
#2.3 TraceID/SpanID 提取
听云的 trace_id 或 span_id 可能会通过 X-Tingyun 中不同的 key 来传递，例如，存在这样的 header：X-Tingyun: c=123;x=456;e=789;s=abc;g=def，业务方可能会取其中的 c、x、e、s、g 字段的值作为 trace_id 或 span_id。为了适应这种情况，可在采集器组配置的【全景图配置参数】中设置【应用调用日志TraceID】或【应用调用日志SpanID】为X-Tingyun.$后缀，例如，配置【应用调用日志TraceID】为X-Tingyun.c，则取 trac_id 的值为 123。