操作场景
云原生 API 网关提供开箱即用的 CLS 日志大盘,如您开启了 CLS 日志投递,即可使用日志分析仪表盘对投递到 CLS 的访问日志和错误日志进行快速分析。(仅专业版支持)
日志大盘支持的场景包括:
状态码分析
请求量分析
请求耗时分析
错误日志分析
用户行为分析
业务分析
本文为您介绍云原生 API 网关日志大盘功能的使用说明。
前提条件
1. 已创建云原生 API 网关实例,具体操作请参见 新建云原生 API 网关。
2. 已开通 CLS 日志服务。
3. 已开启 CLS 日志投递,具体操作请参见 日志投递至 CLS。
4. 日志格式为 JSON 格式,如当前格式为单行文本,请修改日志格式为 JSON 格式,具体操作请参见 编辑 CLS 日志规则。
5. 由于大盘依赖部分日志字段进行展示,请将以下字段添加至日志规则:
字段名 | 字段值 |
status | $status |
ups_status | $upstream_status |
client | $remote_addr |
req_time | $request_time |
ups_rsp_time | $upstream_response_time |
referer | $http_referer |
method | $request_method |
host | $host |
uri | $uri |
ups_ip | $upstream_addr |
操作步骤
1. 登录 微服务引擎控制台 ,在左侧导航栏单击云原生 API 网关 > 实例列表。
2. 在左侧导航栏单击云原生 API 网关 > 可观测性,在页面上方选择好网关实例,单击日志大盘页签。
支持指标及含义
状态码分析
指标名 | 指标含义 |
客户端状态码分布 | 网关返回到客户端的状态码分布 |
2xx次数 | 客户端收到的状态码为 2xx 的请求次数 |
5xx次数 | 客户端收到的状态码为 5xx 的请求次数 |
请求失败率趋势 | 网关请求失败率的趋势 |
2xx占比 | 客户端收到的状态码为 2xx 的请求占比 |
5xx占比 | 客户端收到的状态码为 5xx 的请求占比 |
后端服务状态码分布 | 后端服务返回网关的状态码分布 |
后端服务失败数 | 后端服务失败(4xx和5xx)的请求次数 |
后端服务失败率趋势 | 后端服务收到失败请求(4xx和5xx)的次数 |
请求量分析
指标名 | 指标含义 |
总请求数 | 总请求数。按照所选择的时间粒度统计求和 |
请求次数趋势 | 请求次数趋势 |
请求地域分布 | 客户端 IP 所在地域分布 |
请求耗时分析
指标名 | 指标含义 |
请求总耗时趋势 | 请求总耗时趋势 |
后端响应耗时趋势 | 后端服务响应的耗时趋势 |
错误日志分析
指标名 | 指标含义 |
Error日志数 | 在所选择的时间范围内出现的错误日志总数 |
Error日志趋势 | 在所选择的时间范围内出现的错误日志总数趋势 |
Error日志 | 在所选择的时间范围内出现的错误日志详情 |
用户行为分析
指标名 | 指标含义 |
HTTP Referer 分布 | HTTP Referer 分布 |
请求方法分布 | 请求方法分布 |
Host 分布 | Host 分布 |
业务分析
指标名 | 指标含义 |
TOP10 调用量 API | 在所选择的时间范围内调用量前 10 的 API |
TOP10 失败率 API | 在所选择的时间范围内失败率前 10 的 API |
TOP10 调用量服务 | 在所选择的时间范围内调用量前 10 的 后端服务 |
TOP10 失败率服务 | 在所选择的时间范围内失败率前 10 的 后端服务 |
TOP10 请求 Host | 在所选择的时间范围内数量前 10 的 请求 Host |