diff --git a/doc/docs/_sidebar.md b/doc/docs/_sidebar.md index cb253df4..ce5dde51 100644 --- a/doc/docs/_sidebar.md +++ b/doc/docs/_sidebar.md @@ -1,39 +1,39 @@ -* [首页](/?t=1585023560679) +* [首页](/?t=1589794156310) * 开发文档 - * [快速体验](files/10010_快速体验.md?t=1585023560679) - * [项目接入到SOP](files/10011_项目接入到SOP.md?t=1585023560697) - * [新增接口](files/10020_新增接口.md?t=1585023560697) - * [开发流程](files/10021_开发流程.md?t=1585023560697) - * [业务参数校验](files/10030_业务参数校验.md?t=1585023560697) - * [错误处理](files/10040_错误处理.md?t=1585023560697) - * [编写文档](files/10041_编写文档.md?t=1585023560697) - * [接口交互详解](files/10050_接口交互详解.md?t=1585023560697) - * [easyopen支持](files/10070_easyopen支持.md?t=1585023560698) - * [使用签名校验工具](files/10080_使用签名校验工具.md?t=1585023560698) - * [ISV管理](files/10085_ISV管理.md?t=1585023560698) - * [自定义返回结果](files/10087_自定义返回结果.md?t=1585023560698) - * [自定义过滤器](files/10088_自定义过滤器.md?t=1585023560698) - * [自定义校验token](files/10089_自定义校验token.md?t=1585023560698) - * [网关拦截器](files/10090_网关拦截器.md?t=1585023560698) - * [路由授权](files/10090_路由授权.md?t=1585023560698) - * [接口限流](files/10092_接口限流.md?t=1585023560698) - * [监控日志](files/10093_监控日志.md?t=1585023560699) - * [SDK开发](files/10095_SDK开发.md?t=1585023560699) - * [使用SpringCloudGateway](files/10096_使用SpringCloudGateway.md?t=1585023560699) - * [应用授权](files/10097_应用授权.md?t=1585023560699) - * [提供restful接口](files/10100_提供restful接口.md?t=1585023560699) - * [文件上传](files/10104_文件上传.md?t=1585023560699) - * [配置Sleuth链路追踪](files/10109_配置Sleuth链路追踪.md?t=1585023560699) - * [预发布灰度发布](files/10110_预发布灰度发布.md?t=1585023560699) - * [动态修改请求参数](files/10111_动态修改请求参数.md?t=1585023560699) - * [使用eureka](files/10112_使用eureka.md?t=1585023560700) - * [扩展其它注册中心](files/10113_扩展其它注册中心.md?t=1585023560700) + * [快速体验](files/10010_快速体验.md?t=1589794156312) + * [项目接入到SOP](files/10011_项目接入到SOP.md?t=1589794156333) + * [新增接口](files/10020_新增接口.md?t=1589794156333) + * [开发流程](files/10021_开发流程.md?t=1589794156333) + * [业务参数校验](files/10030_业务参数校验.md?t=1589794156333) + * [错误处理](files/10040_错误处理.md?t=1589794156333) + * [编写文档](files/10041_编写文档.md?t=1589794156333) + * [接口交互详解](files/10050_接口交互详解.md?t=1589794156333) + * [easyopen支持](files/10070_easyopen支持.md?t=1589794156333) + * [使用签名校验工具](files/10080_使用签名校验工具.md?t=1589794156334) + * [ISV管理](files/10085_ISV管理.md?t=1589794156334) + * [自定义返回结果](files/10087_自定义返回结果.md?t=1589794156334) + * [自定义过滤器](files/10088_自定义过滤器.md?t=1589794156334) + * [自定义校验token](files/10089_自定义校验token.md?t=1589794156334) + * [网关拦截器](files/10090_网关拦截器.md?t=1589794156334) + * [路由授权](files/10090_路由授权.md?t=1589794156335) + * [接口限流](files/10092_接口限流.md?t=1589794156335) + * [路由监控](files/10093_路由监控.md?t=1589794156335) + * [SDK开发](files/10095_SDK开发.md?t=1589794156335) + * [使用SpringCloudGateway](files/10096_使用SpringCloudGateway.md?t=1589794156335) + * [应用授权](files/10097_应用授权.md?t=1589794156335) + * [提供restful接口](files/10100_提供restful接口.md?t=1589794156335) + * [文件上传](files/10104_文件上传.md?t=1589794156336) + * [配置Sleuth链路追踪](files/10109_配置Sleuth链路追踪.md?t=1589794156336) + * [预发布灰度发布](files/10110_预发布灰度发布.md?t=1589794156336) + * [动态修改请求参数](files/10111_动态修改请求参数.md?t=1589794156336) + * [使用eureka](files/10112_使用eureka.md?t=1589794156336) + * [扩展其它注册中心](files/10113_扩展其它注册中心.md?t=1589794156336) * 原理分析 - * [网关性能测试](files/90001_网关性能测试.md?t=1585023560700) - * [原理分析之@ApiMapping](files/90010_原理分析之@ApiMapping.md?t=1585023560700) - * [原理分析之如何存储路由](files/90011_原理分析之如何存储路由.md?t=1585023560700) - * [原理分析之如何路由](files/90012_原理分析之如何路由.md?t=1585023560700) - * [原理分析之文档归纳](files/90013_原理分析之文档归纳.md?t=1585023560700) - * [原理分析之预发布灰度发布](files/90014_原理分析之预发布灰度发布.md?t=1585023560700) - * [2.x升3.x注意事项](files/90099_2.x升3.x注意事项.md?t=1585023560700) - * [常见问题](files/90100_常见问题.md?t=1585023560700) + * [网关性能测试](files/90001_网关性能测试.md?t=1589794156336) + * [原理分析之@ApiMapping](files/90010_原理分析之@ApiMapping.md?t=1589794156337) + * [原理分析之如何存储路由](files/90011_原理分析之如何存储路由.md?t=1589794156337) + * [原理分析之如何路由](files/90012_原理分析之如何路由.md?t=1589794156337) + * [原理分析之文档归纳](files/90013_原理分析之文档归纳.md?t=1589794156337) + * [原理分析之预发布灰度发布](files/90014_原理分析之预发布灰度发布.md?t=1589794156337) + * [2.x升3.x注意事项](files/90099_2.x升3.x注意事项.md?t=1589794156337) + * [常见问题](files/90100_常见问题.md?t=1589794156337) diff --git a/doc/docs/files/10093_监控日志.md b/doc/docs/files/10093_监控日志.md deleted file mode 100644 index 47941706..00000000 --- a/doc/docs/files/10093_监控日志.md +++ /dev/null @@ -1,44 +0,0 @@ -# 监控日志 - -1.10.0开始sop-admin提供了简单的监控日志查询,方便在线排查问题。 - -- 错误日志统一在网关负责收集 -- 只收集未知类型的错误日志,开发人员主动throw的异常不收集 -- sop-admin通过网关提供的restful接口获取日志内容,然后在后台展示 -- 收集的日志存放在内存中,重启网关日志会消失 -- 只会收集20条不同的日志内容,相同内容会count+1。可设置`ApiConfig.storeErrorCapacity`属性扩大容量,默认容量20 - -第一次使用需要添加网关服务器实例,前往:`服务管理--监控日志--添加监控服务器` - -## 永久保存日志 - -默认收集的日志存放在内存中,重启网关日志会消失(见:`DefaultServiceErrorManager.java`)。如果要永久保存日志内容,需要自己实现`ServiceErrorManager`接口 - -```java -public class MyServiceErrorManager implements ServiceErrorManager { - ... -} -``` - -然后在ApiConfig中配置 - -```java -@Configuration -public class ZuulConfig extends AlipayZuulConfiguration { - - static { - ... - ApiConfig.getInstance().setServiceErrorManager(new MyServiceErrorManager()); - // 日志收集容量,默认20。只会收集20条不同内容的日志 - ApiConfig.getInstance().setStoreErrorCapacity(20); - ... - } - -} -``` - -- 后台预览 - -![监控日志](images/10093_1.png "10093_1.png") - -![监控日志](images/10093_2.png "10093_2.png") \ No newline at end of file diff --git a/doc/docs/files/10093_路由监控.md b/doc/docs/files/10093_路由监控.md new file mode 100644 index 00000000..b9ad73d2 --- /dev/null +++ b/doc/docs/files/10093_路由监控.md @@ -0,0 +1,22 @@ +# 路由监控 + +路由监控功能可以查看各个接口的调用情况,监控信息收集采用拦截器实现。 + +- 统计各个接口的调用次数、耗时等信息 +- 错误日志统一在网关负责收集 +- 只收集未知类型的错误日志,开发人员主动throw的异常不收集 +- 收集的日志存放在内存中,重启网关日志会消失 + +## 永久保存日志 + +默认收集的日志存放在内存中,重启网关日志会消失(见:`com.gitee.sop.gatewaycommon.monitor.MonitorManager.java`)。如果要永久保存日志内容,需要自己修改`MonitorManager` + +- 后台预览 + +![监控日志](images/10093_1.png "10093_1.png") + +![监控日志](images/10093_2.png "10093_2.png") + +相关类: + +- com.gitee.sop.gatewaycommon.interceptor.MonitorRouteInterceptor diff --git a/doc/docs/files/images/10093_1.png b/doc/docs/files/images/10093_1.png index 74c70779..e51da6f4 100644 Binary files a/doc/docs/files/images/10093_1.png and b/doc/docs/files/images/10093_1.png differ diff --git a/doc/docs/files/images/10093_2.png b/doc/docs/files/images/10093_2.png index 997081cf..b23cacde 100644 Binary files a/doc/docs/files/images/10093_2.png and b/doc/docs/files/images/10093_2.png differ