跳到主要内容

API日志

核心概念:基础设施 | API日志 | 概览

API日志用于记录系统所有API接口的调用记录,包括请求参数、响应结果、执行时长等信息。


核心概念:基础设施 | API日志 | 快速访问 (API日志)

快速访问 (API日志)

在API日志模块中,您可以快速访问日志查询页面。

访问日志入口打开访问日志

错误日志入口打开错误日志


核心概念:基础设施 | API日志 | 功能说明 (API日志)

功能说明 (API日志)

API日志模块主要用于:

  • 记录API接口调用详情
  • 监控接口性能和执行时长
  • 追踪接口异常和错误
  • 分析接口使用情况

核心概念:基础设施 | API日志 | 1. 访问日志 (API日志)

1. 访问日志 (API日志)

访问日志记录了系统所有API接口的正常调用信息。

查看访问日志

在基础设施菜单下,选择"API日志" → "访问日志",可以查看所有API调用记录。

访问日志列表

搜索条件 (访问日志)

在访问日志列表中,支持按以下条件搜索:

  • 用户:选择特定用户
  • 用户类型:选择用户类型
  • 应用名:选择应用名称
  • 请求时间:选择时间范围
  • 执行时长:输入执行时长
  • 结果码:输入结果代码

列表字段说明 (访问日志)

访问日志列表显示以下信息:

  • 日志编号:日志的唯一标识
  • 用户名称:调用接口的用户账号
  • 用户昵称:用户的昵称
  • 用户类型:用户的类型标识
  • 应用名:所属微服务应用名称
  • 请求方法:HTTP请求方法(GET/POST等)
  • 请求地址:API接口的URL路径
  • 请求时间:接口调用的具体时间
  • 执行时长:接口处理耗时(毫秒)
  • 操作结果:调用是否成功
  • 操作模块:所属功能模块
  • 操作名:具体操作名称
  • 操作类型:操作的分类

核心概念:基础设施 | API日志 | 查看访问日志详情 (API日志)

查看访问日志详情 (API日志)

在访问日志模块中,您可以查看单条日志的详细信息。

  1. 在列表中找到要查看的日志记录
  2. 点击"详细"按钮
  3. 查看完整的请求和响应信息

访问日志详情

详情字段说明

  • 日志主键:日志ID
  • 链路追踪:Trace ID,用于链路追踪
  • 应用名:应用名称
  • 用户信息:用户昵称及类型
  • 用户 IP:客户端IP地址
  • 用户 UA:User Agent信息
  • 请求信息:Method + URL
  • 请求参数:接口请求的具体参数
  • 请求结果:接口返回的响应数据
  • 请求时间:开始时间和结束时间
  • 请求耗时:执行时长
  • 操作结果:成功或失败信息
  • 操作模块:所属模块
  • 操作名:操作名称
  • 操作类型:操作分类

核心概念:基础设施 | API日志 | 2. 错误日志 (API日志)

2. 错误日志 (API日志)

错误日志记录了系统API调用过程中发生的异常信息。

查看错误日志

在基础设施菜单下,选择"API日志" → "错误日志",可以查看接口错误记录。

错误日志列表

搜索条件 (错误日志)

在错误日志列表中,支持按以下条件搜索:

  • 用户:选择特定用户
  • 用户类型:选择用户类型
  • 应用名:选择应用名称
  • 异常时间:选择时间范围
  • 处理状态:选择处理状态(未处理/已处理/已忽略)

列表字段说明 (错误日志)

错误日志列表显示以下信息:

  • 日志编号:日志ID
  • 用户名称:用户账号
  • 用户昵称:用户昵称
  • 用户类型:用户类型
  • 应用名:应用名称
  • 请求方法:HTTP方法
  • 请求地址:接口URL
  • 异常发生时间:异常发生的时间点
  • 异常名:异常类的名称
  • 处理状态:当前日志的处理状态

核心概念:基础设施 | API日志 | 查看错误日志详情 (API日志)

查看错误日志详情 (API日志)

在错误日志模块中,您可以查看异常的详细堆栈信息。

  1. 在列表中找到要查看的日志记录
  2. 点击"详细"按钮
  3. 查看完整的异常堆栈信息

错误详细信息

详情字段说明

  • 日志主键:日志ID
  • 链路追踪:Trace ID
  • 应用名:应用名称
  • 用户编号:用户ID及类型
  • 用户 IP:客户端IP
  • 用户 UA:客户端User Agent
  • 请求信息:Method + URL
  • 请求参数:请求参数内容
  • 异常时间:异常发生时间
  • 异常名:异常类名称
  • 异常堆栈:详细的异常堆栈跟踪信息
  • 处理状态:当前状态
  • 处理人:处理该异常的用户ID
  • 处理时间:处理时间

核心概念:基础设施 | API日志 | 处理错误日志 (API日志)

处理错误日志 (API日志)

针对未处理的错误日志,您可以进行以下操作:

  • 已处理:标记该异常已经处理修复
  • 已忽略:标记该异常无需处理

核心概念:基础设施 | API日志 | 导出日志 (API日志)

导出日志 (API日志)

在API日志模块中,您可以导出日志数据。

  1. 设置筛选条件(可选)
  2. 点击"导出"按钮
  3. 下载Excel文件

核心概念:基础设施 | API日志 | 注意事项 (API日志)

注意事项 (API日志)

  • API日志数据量较大,建议定期清理
  • 错误日志应及时查看并处理,以保证系统稳定性
AI 问答