ApiBoot 文档

链路日志管理界面

ApiBoot Logging Admin提供了管理界面,方便查看请求链路日志的详细信息,当前版本管理界面仅提供了查看上报日志的服务列表上报的链路日志列表等功能,后期会不断地进行完善。

添加依赖

ApiBoot Logging Admin内部已经包含了UI的相关依赖,无需单独添加。 详见ApiBoot Logging Admin 1.添加依赖

打包压缩资源文件

管理界面通过VUE来进行编写,执行vue-cli-service build来进行打包并压缩资源文件,将压缩后的页面JSCSS等资源文件通过maven plugin自动复制到META-INF/api-boot-logging-admin-ui文件夹内, 最后通过ResourceHandler来进行资源映射。

内部封装的组件

ApiBoot2.1.3.RELEASE版本开始陆续会将api-boot-plugins模块下的组件从api-boot项目分离到minbox-projects开源组织内作为独立的项目进行升级维护,ApiBoot Logging内部通过封装minbox-projects/minbox-logging组件的minbox-logging-admin-ui实现。

minbox-logging源码地址:https://gitee.com/minbox-projects/minbox-logging

登录页面

链路日志管理平台内置了登录页面,通过org.minbox.framework.api.boot.autoconfigure.logging.admin.ApiBootLoggingAdminSecurityAutoConfiguration配置类自动添加Spring Security的相关资源文件过滤、 HttpBasic认证开启、登录跳转页面等参数, 因此我们在访问管理平台的任意路径时,会因为没有登录自动跳转到/login页面,在页面输入我们配置的Spring Security的用户名、密码来登录平台。

具体使用Spring Security详见ApiBoot Logging Admin 3.安全配置使用文档。

服务列表

请求日志的采集服务在第一次上报时,会自动创建一条服务记录,服务的唯一性是根据:服务ID + 服务IP + 服务端Port 来进行定义。

在每次上报日志成功后会修改服务的最后一次上报时间。

链路日志列表

链路日志是我们访问的入口服务生成,比如:bff-user -> user-service,链路日志产生的位置则是bff-user服务,链路日志是接口请求的入口也是做出响应的结束位置,因此我们可以在页面上查看接口的请求参数详情头信息以及响应的内容,至于链路日志内的日志单元目前界面还未做展示,可以根据traceId链路日志编号自行去数据库查询。

链路日志详情