Spring Cloud Gateway使用说明（7）-- actuator

15. Actuator API

/gateway的actuator端点允许监视Spring Cloud Gateway应用程序并与之交互。要进行远程访问，必须在应用程序属性中暴露HTTP或JMX 端口。

Example 72. application.properties

management.endpoint.gateway.enabled=true # default value
management.endpoints.web.exposure.include=gateway

15.1. 获取详细路由配置

Spring Cloud Gateway添加了一个全新的、更加详细的格式接口。它添加关于每个路由更多的详细信息，让你可以查看详细的断言、过滤器和其它配置。下面例子配置/actuator/gateway/routes：

[
  {
    "predicate": "(Hosts: [**.addrequestheader.org] && Paths: [/headers], match trailing slash: true)",
    "route_id": "add_request_header_test",
    "filters": [
      "[[AddResponseHeader X-Response-Default-Foo = 'Default-Bar'], order = 1]",
      "[[AddRequestHeader X-Request-Foo = 'Bar'], order = 1]",
      "[[PrefixPath prefix = '/httpbin'], order = 2]"
    ],
    "uri": "lb://testservice",
    "order": 0
  }
]

这个特性默认是开启的，如果要关闭，如下：
Example 73. application.properties

spring.cloud.gateway.actuator.verbose.enabled=false

在以后的版本中也会是默认开启

15.2. 查找路由filters

本节介绍如何查找路由filter, 包括：

• Global Filters
• [gateway-route-filters]

15.2.1. 全局filters

要检索应用于所有路由的 [global filters]，请get请求 /actuator/gateway/globalfilters。返回的结果类似于以下内容：

{
  "org.springframework.cloud.gateway.filter.LoadBalancerClientFilter@77856cc5": 10100,
  "org.springframework.cloud.gateway.filter.RouteToRequestUrlFilter@4f6fd101": 10000,
  "org.springframework.cloud.gateway.filter.NettyWriteResponseFilter@32d22650": -1,
  "org.springframework.cloud.gateway.filter.ForwardRoutingFilter@106459d9": 2147483647,
  "org.springframework.cloud.gateway.filter.NettyRoutingFilter@1fbd5e0": 2147483647,
  "org.springframework.cloud.gateway.filter.ForwardPathFilter@33a71d23": 0,
  "org.springframework.cloud.gateway.filter.AdaptCachedBodyGlobalFilter@135064ea": 2147483637,
  "org.springframework.cloud.gateway.filter.WebsocketRoutingFilter@23c05889": 2147483646
}

返回结果包含已就绪的global filters的详细信息(如 org.springframework.cloud.gateway.filter.LoadBalancerClientFilter@77856cc5)。对于每个global filters，返回结果字符串对应过滤器链中的相应顺序。

15.2.2. 路由filter

要检索应用于路由的 [GatewayFilter factories] ，请get请求/actuator/gateway/routefilters。返回结果类似于以下内容：

{
  "[AddRequestHeaderGatewayFilterFactory@570ed9c configClass = AbstractNameValueGatewayFilterFactory.NameValueConfig]": null,
  "[SecureHeadersGatewayFilterFactory@fceab5d configClass = Object]": null,
  "[SaveSessionGatewayFilterFactory@4449b273 configClass = Object]": null
}

返回结果包含应用于所有路由的GatewayFilter的详细信息。显示每个工厂提供字符串格式的相应对象（例如， [SecureHeadersGatewayFilterFactory@fceab5d configClass = Object]）。请注意，null值是由于endpoint controller实现不完整造成的，因为它尝试在filter chain中设置对象的顺序，这不适用于GatewayFilter工厂对象。

15.3. 刷新路由缓存

如果要清理路由的缓存，请POST请求/actuator/gateway/refresh。该请求将返回一个没有body的200返回码。

15.4. 查找路由

要检索网关中定义的路由，发送GET请求/actuator/gateway/routes，返回结果如下所示：

[{
  "route_id": "first_route",
  "route_object": {
    "predicate": "org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory$$Lambda$432/1736826640@1e9d7e7d",
    "filters": [
      "OrderedGatewayFilter{delegate=org.springframework.cloud.gateway.filter.factory.PreserveHostHeaderGatewayFilterFactory$$Lambda$436/674480275@6631ef72, order=0}"
    ]
  },
  "order": 0
},
{
  "route_id": "second_route",
  "route_object": {
    "predicate": "org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory$$Lambda$432/1736826640@cd8d298",
    "filters": []
  },
  "order": 0
}]

返回结果中包含网关中所有定义的路由信息，下面表格中描述了返回结果信息：

Path	Type	Description
route_id	String	路由id
route_object.predicate	Object	断言
route_object.filters	Array	路由过滤器
order	Number	顺序，值越低，优先级越高。

15.5. 查找特定路由

要获取单个路由的信息，发送GET请求 /actuator/gateway/routes/{id} (如： /actuator/gateway/routes/first_route)，返回结果如下所示：

{
  "id": "first_route",
  "predicates": [{
    "name": "Path",
    "args": {"_genkey_0":"/first"}
  }],
  "filters": [],
  "uri": "https://www.uri-destination.org",
  "order": 0
}]

Path	Type	Description
id	String	路由id
predicates	Array	断言,包括名字和参数
filters	Array	路由过滤器
uri	String	目标URI
order	Number	顺序，值越低，优先级越高。

15.6. 创建和删除路由

要创建一个路由，发送POST请求 /gateway/routes/{id_route_to_create}，参数为JSON结构，具体参数数据结构参考上面章节。

要删除一个路由，发送 DELETE请求 /gateway/routes/{id_route_to_delete}。

15.7. 总结：接口列表

下表总结了Spring Cloud Gateway actuator endpoints。注意，每个endpoint都是/actuator/gateway作为基本路径。

id	HTTP Method	Description
globalfilters	GET	返回全局Filter列表
routefilters	GET	每个路由的filter
refresh	POST	刷新路由缓存
routes	GET	路由列表
routes/{id}	GET	指定路由的信息
routes/{id}	POST	创建路由
routes/{id}	DELETE	删除路由

Spring Cloud Gateway 2.2.3 官方使用说明（1）–路由
Spring Cloud Gateway 2.2.3 官方使用说明（2）-- 路由filter（上）
Spring Cloud Gateway 2.2.3 官方使用说明（2）-- 路由filter（下）
Spring Cloud Gateway 2.2.3 官方使用说明（3）-- Global filter
Spring Cloud Gateway 2.2.3 官方使用说明（4）-- HttpHeader Filters
Spring Cloud Gateway 2.2.3 使用说明（5）-- TLS 和 SSL
Spring Cloud Gateway 2.2.3 使用说明（6）-- 其它配置

Spring Cloud Gateway 2.2.3 使用说明（7）-- actuator

Spring Cloud Gateway 2.2.3 使用说明（8）-- 开发指导