只需要为Spring Cloud Gateway添加Spring Boot Actuator,并将gateway
端点暴露,即可获得若干监控端点。
management:
endpoints:
web:
exposure:
# 当然暴露'*' 更好啦..
include: gateway
一、监控端点一览表
ID | HTTP Method | Description |
---|---|---|
globalfilters |
GET | 展示所有的全局过滤器 |
routefilters |
GET | 展示所有的过滤器工厂(GatewayFilter factories) |
refresh |
POST【无消息体】 | 清空路由缓存 |
routes |
GET | 展示路由列表 |
routes/{id} |
GET | 展示指定id的路由的信息 |
routes/{id} |
POST【消息体如下】 | 新增一个路由 |
routes/{id} |
DELETE【无消息体】 | 删除一个路由 |
二、动态添加路由配置
要想动态添加路由配置,只需发送POST请求,消息体如下:
{
"predicates": [
{
"name": "Path",
"args": {
"_genkey_0": "/test"
}
}
],
"filters": [
{
"name": "AddRequestHeader",
"args": {
"_genkey_0": "X-Request-Foo",
"_genkey_1": "Bar"
}
},
{
"name": "PreLog",
"args": {
"_genkey_0": "a",
"_genkey_1": "b"
}
}
],
"uri": "https://www.itmuch.com",
"order": 0
}
添加完成后,可再次访问${GATEWAY_URL}/actuator/gateway/routes
端点,可以看到,新的路由已被动态添加了。
三、排错、调试技巧总结
1. Actuator监控端点
借助Actuator的监控端点,可分析全局过滤器、过滤器工厂、路由详情
2. 日志
将如下包的日志级别设置成debug
或trace
org.springframework.cloud.gateway
org.springframework.http.server.reactive
org.springframework.web.reactive
org.springframework.boot.autoconfigure.web
reactor.netty
redisratelimiter
配置示例:
logging:
level:
org.springframework.cloud.gateway: trace
3. Wiretap【从Greenwich SR3及更高版本才会支持】
Reactor Netty HttpClient
以及 HttpServer
可启用 Wiretap
。将reactor.netty
包设置成 debug
或 trace
,然后设置如下属性:
spring.cloud.gateway.httpserver.wiretap=true
spring.cloud.gateway.httpclient.wiretap=true
分别开启HttpServer及HttpClient的Wiretap。
然后,就可以分析日志啦。