本站内所有文档均为中英对照文档，点击中文可以显示英文。此提醒连续关闭5次后，将不再显示。
常用应用属性
你可以在 application.properties 文件、application.yml 文件或作为命令行开关来指定各种属性。本附录列出了常见的 Spring Cloud Gateway 属性，并引用了使用这些属性的底层类。
备注
属性贡献可以来自类路径上的额外 jar 文件，因此你不应将其视为一个详尽的列表。此外，你也可以定义自己的属性。
| 名称 | 默认 | 描述 |
|---|---|---|
| spring.cloud.gateway.server.webflux.default-filters | 应用于每个路由的过滤器定义列表。 | |
| spring.cloud.gateway.server.webflux.discovery.locator.enabled | false | 启用 DiscoveryClient 网关集成的标志。 |
| spring.cloud.gateway.server.webflux.discovery.locator.filters | ||
| spring.cloud.gateway.server.webflux.discovery.locator.include-expression | true | 用于评估是否在网关集成中包含服务的SpEL表达式，默认为：true。 |
| spring.cloud.gateway.server.webflux.discovery.locator.lower-case-service-id | false | 将谓词和过滤器中的 serviceId 转换为小写的选项，默认为 false。在与 Eureka 配合使用时非常有用，因为 Eureka 会自动将 serviceId 转换为大写。例如，MYSERVICE 将匹配 /myservice/** |
| spring.cloud.gateway.server.webflux.discovery.locator.predicates | ||
| spring.cloud.gateway.server.webflux.discovery.locator.route-id-prefix | 路由ID的前缀，默认为 discoveryClient.getClass().getSimpleName() + "_"。服务ID将被追加以创建路由ID。 | |
| spring.cloud.gateway.server.webflux.discovery.locator.url-expression | 'lb://'+serviceId | 为每个路由创建URI的SpEL表达式，默认为：'lb://'+serviceId。 |
| spring.cloud.gateway.server.webflux.enabled | true | 启用网关功能。 |
| spring.cloud.gateway.server.webflux.fail-on-route-definition-error | true | 在路由定义错误时选择失败，默认为 true。否则，将记录一个警告。 |
| spring.cloud.gateway.server.webflux.filter.add-request-header.enabled | true | 启用添加请求头过滤器。 |
| spring.cloud.gateway.server.webflux.filter.add-request-parameter.enabled | true | 启用 add-request-parameter 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.add-response-header.enabled | true | 启用 add-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.circuit-breaker.enabled | true | 启用断路器过滤器。 |
| spring.cloud.gateway.server.webflux.filter.dedupe-response-header.enabled | true | 启用 dedupe-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.fallback-headers.enabled | true | 启用 fallback-headers 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.json-to-grpc.enabled | true | 启用 JSON 到 gRPC 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.enabled | false | 启用本地响应缓存过滤器。 |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.request.no-cache-strategy | skip-update-cache-entry | |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.size | 此路由条目逐出缓存的最大大小（以 KB、MB 和 GB 为单位）。 | |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.time-to-live | 5m | 缓存条目的过期时间（以 s 表示秒，m 表示分钟，h 表示小时）。 |
| spring.cloud.gateway.server.webflux.filter.map-request-header.enabled | true | 启用 map-request-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.modify-request-body.enabled | true | 启用修改请求体过滤器。 |
| spring.cloud.gateway.server.webflux.filter.modify-response-body.enabled | true | 启用修改响应体过滤器。 |
| spring.cloud.gateway.server.webflux.filter.prefix-path.enabled | true | 启用前缀路径过滤器。 |
| spring.cloud.gateway.server.webflux.filter.preserve-host-header.enabled | true | 启用 preserve-host-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.redirect-to.enabled | true | 启用重定向过滤器。 |
| spring.cloud.gateway.server.webflux.filter.remove-hop-by-hop.headers | ||
| spring.cloud.gateway.server.webflux.filter.remove-hop-by-hop.order | ||
| spring.cloud.gateway.server.webflux.filter.remove-request-header.enabled | true | 启用移除请求头过滤器。 |
| spring.cloud.gateway.server.webflux.filter.remove-request-parameter.enabled | true | 启用移除请求参数过滤器。 |
| spring.cloud.gateway.server.webflux.filter.remove-response-header.enabled | true | 启用移除响应头过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-header-size.enabled | true | 启用请求头大小过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-header-to-request-uri.enabled | true | 启用请求头到请求URI的过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-rate-limiter.default-key-resolver | ||
| spring.cloud.gateway.server.webflux.filter.request-rate-limiter.default-rate-limiter | ||
| spring.cloud.gateway.server.webflux.filter.request-rate-limiter.enabled | true | 启用请求速率限制器过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-size.enabled | true | 启用请求大小过滤器。 |
| spring.cloud.gateway.server.webflux.filter.retry.enabled | true | 启用重试过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-location-response-header.enabled | true | 启用重写位置响应头过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-location.enabled | true | 启用重写位置过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-path.enabled | true | 启用重写路径过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-request-parameter.enabled | true | 启用重写请求参数过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-response-header.enabled | true | 启用重写响应头过滤器。 |
| spring.cloud.gateway.server.webflux.filter.save-session.enabled | true | 启用保存会话过滤器。 |
| spring.cloud.gateway.server.webflux.filter.secure-headers.content-security-policy | default-src 'self' https:; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src https:; style-src 'self' https: 'unsafe-inline' | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.content-type-options | nosniff | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.default-headers | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.disable | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.disabled-headers | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.download-options | noopen | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.enabled | true | 启用安全头部过滤器。 |
| spring.cloud.gateway.server.webflux.filter.secure-headers.enabled-headers | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.frame-options | DENY | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.permissions-policy | accelerometer=(), ambient-light-sensor=(), autoplay=(), battery=(), camera=(), cross-origin-isolated=(), display-capture=(), document-domain=(), encrypted-media=(), execution-while-not-rendered=(), execution-while-out-of-viewport=(), fullscreen=(), geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), microphone=(), midi=(), navigation-override=(), payment=(), picture-in-picture=(), publickey-credentials-get=(), screen-wake-lock=(), sync-xhr=(), usb=(), web-share=(), xr-spatial-tracking=() | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.permitted-cross-domain-policies | none | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.referrer-policy | no-referrer | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.strict-transport-security | max-age=631138519 | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.xss-protection-header | 1 ; mode=block | |
| spring.cloud.gateway.server.webflux.filter.set-path.enabled | true | 启用设置路径过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-request-header.enabled | true | 启用设置请求头过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-request-host-header.enabled | true | 启用 set-request-host-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-response-header.enabled | true | 启用 set-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-status.enabled | true | 启用设置状态过滤器。 |
| spring.cloud.gateway.server.webflux.filter.strip-prefix.enabled | true | 启用 strip-prefix 过滤器。 |
| spring.cloud.gateway.server.webflux.forwarded.by.enabled | false | 启用 Forwarded: by 标头部分。 |
| spring.cloud.gateway.server.webflux.forwarded.enabled | true | 启用 ForwardedHeadersFilter。 |
| spring.cloud.gateway.server.webflux.global-filter.adapt-cached-body.enabled | true | 启用 adapt-cached-body 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.forward-path.enabled | true | 启用前向路径全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.forward-routing.enabled | true | 启用前向路由全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.load-balancer-client.enabled | true | 启用负载均衡器客户端全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.local-response-cache.enabled | true | 为所有路由启用本地响应缓存过滤器，允许使用 LocalResponseCache 过滤器在路由级别添加特定配置。 |
| spring.cloud.gateway.server.webflux.global-filter.netty-routing.enabled | true | 启用 netty-routing 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.netty-write-response.enabled | true | 启用 netty-write-response 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.reactive-load-balancer-client.enabled | true | 启用 reactive-load-balancer-client 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.remove-cached-body.enabled | true | 启用全局过滤器 remove-cached-body。 |
| spring.cloud.gateway.server.webflux.global-filter.route-to-request-url.enabled | true | 启用 route-to-request-url 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.websocket-routing.enabled | true | 启用 websocket-routing 全局过滤器。 |
| spring.cloud.gateway.server.webflux.globalcors.add-to-simple-url-handler-mapping | false | 是否应将全局 CORS 配置添加到 URL 处理程序。 |
| spring.cloud.gateway.server.webflux.globalcors.cors-configurations | ||
| spring.cloud.gateway.server.webflux.handler-mapping.order | 1 | RoutePredicateHandlerMapping 的顺序。 |
| spring.cloud.gateway.server.webflux.httpclient.compression | false | 为 Netty HttpClient 启用压缩功能。 |
| spring.cloud.gateway.server.webflux.httpclient.connect-timeout | 连接超时时间，单位为毫秒，默认值为30秒。 | |
| spring.cloud.gateway.server.webflux.httpclient.max-header-size | 最大响应标头大小。 | |
| spring.cloud.gateway.server.webflux.httpclient.max-initial-line-length | 最大初始行长度。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.acquire-timeout | 仅适用于 FIXED 类型，等待获取的最大时间（以毫秒为单位）。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.eviction-interval | 0 | 在后台以指定间隔执行定期驱逐检查。默认情况下禁用（{@link Duration#ZERO}） |
| spring.cloud.gateway.server.webflux.httpclient.pool.leasing-strategy | fifo | 配置连接池的租借策略（先进先出或后进先出），默认为先进先出，这是Netty的默认设置。 |
| spring.cloud.gateway.server.webflux.httpclient.pool.max-connections | 仅适用于 FIXED 类型，在开始对现有连接进行挂起获取之前允许的最大连接数。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.max-idle-time | 通道将在指定毫秒数后关闭。如果为 NULL，则表示没有最大空闲时间。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.max-life-time | 通道关闭前的持续时间。如果为 NULL，则表示没有最大生命周期。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.metrics | false | 启用通道池指标收集并在 Micrometer 中注册。默认禁用。 |
| spring.cloud.gateway.server.webflux.httpclient.pool.name | proxy | 通道池映射名称，默认为 proxy。 |
| spring.cloud.gateway.server.webflux.httpclient.pool.type | elastic | HttpClient 使用的连接池类型（弹性、固定或禁用）。 |
| spring.cloud.gateway.server.webflux.httpclient.proxy.host | Netty HttpClient 代理配置的主机名。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.non-proxy-hosts-pattern | 用于绕过代理直接访问的已配置主机列表的正则表达式（Java）。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.password | Netty HttpClient 代理配置的密码。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.port | Netty HttpClient 的代理配置端口。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.type | http | 用于配置 Netty HttpClient 代理类型的参数（http、socks4 或 socks5）。 |
| spring.cloud.gateway.server.webflux.httpclient.proxy.username | Netty HttpClient 代理配置的用户名。 | |
| spring.cloud.gateway.server.webflux.httpclient.response-timeout | 响应超时。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.close-notify-flush-timeout | 3000ms | SSL close_notify 刷新超时。默认值为 3000 毫秒。 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.close-notify-read-timeout | 0 | SSL close_notify 读取超时。默认值为 0 毫秒。 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.handshake-timeout | 10000ms | SSL 握手超时。默认值为 10000 毫秒 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-password | 密钥密码，默认与密钥库密码相同。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store | Netty HttpClient 的密钥库路径。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-password | Keystore 密码。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-provider | Netty HttpClient 的 Keystore 提供程序，可选字段。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-type | JKS | Netty HttpClient 的密钥库类型，默认为 JKS。 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.ssl-bundle | 要使用的 SSL 捆绑包名称。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.trusted-x509-certificates | 用于验证远程端点证书的可信证书。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.use-insecure-trust-manager | false | 安装 netty InsecureTrustManagerFactory。此管理器不安全，不适用于生产环境。 |
| spring.cloud.gateway.server.webflux.httpclient.websocket.max-frame-payload-length | 最大帧负载长度。 | |
| spring.cloud.gateway.server.webflux.httpclient.websocket.proxy-ping | true | 代理将ping帧转发至下游服务，默认值为true。 |
| spring.cloud.gateway.server.webflux.httpclient.wiretap | false | 为 Netty HttpClient 启用窃听调试功能。 |
| spring.cloud.gateway.server.webflux.httpserver.wiretap | false | 启用 Netty HttpServer 的 wiretap 调试功能。 |
| spring.cloud.gateway.server.webflux.loadbalancer.use404 | false | |
| spring.cloud.gateway.server.webflux.metrics.enabled | false | 启用指标数据的收集。 |
| spring.cloud.gateway.server.webflux.metrics.path-tags.enabled | false | 启用网关路径标签提供程序。 |
| spring.cloud.gateway.server.webflux.metrics.prefix | spring.cloud.gateway | 由网关发出的所有指标的前缀。 |
| spring.cloud.gateway.server.webflux.metrics.tags | 添加到指标的标签映射。 | |
| spring.cloud.gateway.server.webflux.metrics.tags.path.enabled | false | 启用网关路径标签提供程序。 |
| spring.cloud.gateway.server.webflux.observability.enabled | true | 是否应开启 Micrometer 可观测性支持。 |
| spring.cloud.gateway.server.webflux.predicate.after.enabled | true | 启用后置断言。 |
| spring.cloud.gateway.server.webflux.predicate.before.enabled | true | 启用前置谓词。 |
| spring.cloud.gateway.server.webflux.predicate.between.enabled | true | 启用 between 谓词。 |
| spring.cloud.gateway.server.webflux.predicate.cloud-foundry-route-service.enabled | true | 启用 cloud-foundry-route-service 断言。 |
| spring.cloud.gateway.server.webflux.predicate.cookie.enabled | true | 启用 Cookie 谓词。 |
| spring.cloud.gateway.server.webflux.predicate.header.enabled | true | 启用头部谓词。 |
| spring.cloud.gateway.server.webflux.predicate.host.enabled | true | 启用主机谓词。 |
| spring.cloud.gateway.server.webflux.predicate.host.include-port | true | 在匹配主机名时包含端口。 |
| spring.cloud.gateway.server.webflux.predicate.method.enabled | true | 启用方法谓词。 |
| spring.cloud.gateway.server.webflux.predicate.path.enabled | true | 启用路径谓词。 |
| spring.cloud.gateway.server.webflux.predicate.query.enabled | true | 启用查询谓词。 |
| spring.cloud.gateway.server.webflux.predicate.read-body.enabled | true | 启用读取正文谓词。 |
| spring.cloud.gateway.server.webflux.predicate.remote-addr.enabled | true | 启用远程地址谓词。 |
| spring.cloud.gateway.server.webflux.predicate.weight.enabled | true | 启用权重谓词。 |
| spring.cloud.gateway.server.webflux.predicate.xforwarded-remote-addr.enabled | true | 启用 xforwarded-remote-addr 谓词。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.burst-capacity-header | X-RateLimit-Burst-Capacity | 返回突发容量配置的响应头名称。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.config | ||
| spring.cloud.gateway.server.webflux.redis-rate-limiter.include-headers | true | 是否包含包含速率限制器信息的头部，默认为 true。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.remaining-header | X-RateLimit-Remaining | 返回当前秒内剩余请求数量的响应头名称。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.replenish-rate-header | X-RateLimit-Replenish-Rate | 返回补充速率配置的请求头名称。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.requested-tokens-header | X-RateLimit-Requested-Tokens | 返回请求令牌配置的标头名称。 |
| spring.cloud.gateway.server.webflux.redis-route-definition-repository.enabled | true | 是否应启用 RedisRouteDefinitionRepository。 |
| spring.cloud.gateway.server.webflux.restrictive-property-accessor.enabled | true | 限制 SpEL 中的方法和属性访问。 |
| spring.cloud.gateway.server.webflux.route-filter-cache-enabled | false | 启用路由过滤器缓存，默认为 false。 |
| spring.cloud.gateway.server.webflux.route-refresh-listener.enabled | true | 是否应开启 RouteRefreshListener。 |
| spring.cloud.gateway.server.webflux.routes | 路由列表。 | |
| spring.cloud.gateway.server.webflux.set-status.original-status-header-name | 包含代理请求的 HTTP 代码的标头名称。 | |
| spring.cloud.gateway.server.webflux.streaming-media-types | ||
| spring.cloud.gateway.server.webflux.trusted-proxies | 定义代理的正则表达式，当它们出现在 Forwarded 或 X-Forwarded 头中时被视为可信。 | |
| spring.cloud.gateway.server.webflux.version.default-version | 默认版本。 | |
| spring.cloud.gateway.server.webflux.version.detect-supported-versions | true | 标记是否使用映射中出现的API版本进行支持的版本验证（true），或仅使用显式配置的版本（false）。默认为true。 |
| spring.cloud.gateway.server.webflux.version.header-name | 用于提取 API 版本的头名称。 | |
| spring.cloud.gateway.server.webflux.version.media-type | 用于提取 API 版本的媒体类型名称。 | |
| spring.cloud.gateway.server.webflux.version.media-type-param-name | 用于提取 API 版本的媒体类型参数名称。 | |
| spring.cloud.gateway.server.webflux.version.path-segment | 用于提取 API 版本号的路径段索引。 | |
| spring.cloud.gateway.server.webflux.version.request-param-name | 用于提取 API 版本的请求参数名称。 | |
| spring.cloud.gateway.server.webflux.version.required | false | |
| spring.cloud.gateway.server.webflux.version.supported-versions | ||
| spring.cloud.gateway.server.webflux.x-forwarded.enabled | true | 如果启用了 XForwardedHeadersFilter。 |
| spring.cloud.gateway.server.webflux.x-forwarded.for-append | true | 如果启用了将 X-Forwarded-For 作为列表追加的功能。 |
| spring.cloud.gateway.server.webflux.x-forwarded.for-enabled | true | 如果启用了 X-Forwarded-For。 |
| spring.cloud.gateway.server.webflux.x-forwarded.host-append | true | 如果启用了将 X-Forwarded-Host 作为列表追加的功能。 |
| spring.cloud.gateway.server.webflux.x-forwarded.host-enabled | true | 如果启用了 X-Forwarded-Host。 |
| spring.cloud.gateway.server.webflux.x-forwarded.order | 0 | XForwardedHeadersFilter 的顺序。 |
| spring.cloud.gateway.server.webflux.x-forwarded.port-append | true | 如果启用了将 X-Forwarded-Port 作为列表追加的功能。 |
| spring.cloud.gateway.server.webflux.x-forwarded.port-enabled | true | 如果启用了 X-Forwarded-Port。 |
| spring.cloud.gateway.server.webflux.x-forwarded.prefix-append | true | 如果启用了将 X-Forwarded-Prefix 作为列表追加的功能。 |
| spring.cloud.gateway.server.webflux.x-forwarded.prefix-enabled | true | 如果启用了 X-Forwarded-Prefix。 |
| spring.cloud.gateway.server.webflux.x-forwarded.proto-append | true | 如果启用了将 X-Forwarded-Proto 作为列表追加的功能。 |
| spring.cloud.gateway.server.webflux.x-forwarded.proto-enabled | true | 如果启用了 X-Forwarded-Proto。 |
| spring.cloud.gateway.server.webmvc.form-filter.enabled | true | 启用表单过滤器。 |
| spring.cloud.gateway.server.webmvc.forwarded-by-enabled | false | 是否在 Forwarded 标头中添加 "by" 参数。 |
| spring.cloud.gateway.server.webmvc.forwarded-request-headers-filter.enabled | true | 启用转发请求头过滤器。 |
| spring.cloud.gateway.server.webmvc.remove-content-length-request-headers-filter.enabled | true | 启用 remove-content-length-request-headers-filter。 |
| spring.cloud.gateway.server.webmvc.remove-hop-by-hop-request-headers-filter.enabled | true | 启用移除逐跳请求头过滤器。 |
| spring.cloud.gateway.server.webmvc.remove-hop-by-hop-response-headers-filter.enabled | true | 启用移除逐跳响应头过滤器。 |
| spring.cloud.gateway.server.webmvc.remove-http2-status-response-headers-filter.enabled | true | 启用 remove-http2-status-response-headers-filter。 |
| spring.cloud.gateway.server.webmvc.routes | 路由列表。 | |
| spring.cloud.gateway.server.webmvc.routes-map | 路由映射。 | |
| spring.cloud.gateway.server.webmvc.streaming-buffer-size | 16384 | 流媒体 MIME 类型的缓冲区大小。 |
| spring.cloud.gateway.server.webmvc.streaming-media-types | 流式传输的 MIME 类型。 | |
| spring.cloud.gateway.server.webmvc.transfer-encoding-normalization-request-headers-filter.enabled | true | 启用传输编码规范化请求头过滤器。 |
| spring.cloud.gateway.server.webmvc.trusted-proxies | 定义代理的正则表达式，当它们出现在 Forwarded 或 X-Forwarded 头中时被视为可信。 | |
| spring.cloud.gateway.server.webmvc.use-framework-retry-filter | false | 当 Spring Retry 存在于类路径中，但你仍希望使用 Spring Framework 的重试功能作为重试过滤器时，请将此属性设置为 true。 |
| spring.cloud.gateway.server.webmvc.weight-calculator-filter.enabled | true | 启用权重计算器过滤器。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.enabled | true | 如果启用了 XForwardedHeadersFilter。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.for-append | true | 如果启用了将 X-Forwarded-For 作为列表追加的功能。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.for-enabled | true | 如果启用了 X-Forwarded-For。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.host-append | true | 如果启用了将 X-Forwarded-Host 作为列表追加的功能。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.host-enabled | true | 如果启用了 X-Forwarded-Host。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.order | 0 | XForwardedHeadersFilter 的顺序。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.port-append | true | 如果启用了将 X-Forwarded-Port 作为列表追加的功能。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.port-enabled | true | 如果启用了 X-Forwarded-Port。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.prefix-append | true | 如果启用了将 X-Forwarded-Prefix 作为列表追加的功能。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.prefix-enabled | true | 如果启用了 X-Forwarded-Prefix。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.proto-append | true | 如果启用了将 X-Forwarded-Proto 作为列表追加的功能。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.proto-enabled | true | 如果启用了 X-Forwarded-Proto。 |
可观测性元数据
可观测性 - 指标
以下是本项目声明的所有指标列表。
Gateway Http Client 观测
通过网关发送请求时创建的观察记录。
指标名称 http.client.requests (由约定类 org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention 定义)。类型 timer。
指标名称 http.client.requests.active (由约定类 org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention 定义)。类型 long task timer。
important
在启动观测后添加的 KeyValues 可能不会出现在 *.active 指标中。
important
Micrometer 内部使用 纳秒 作为基本单位。然而，每个后端决定了实际的基本单位。（例如，Prometheus 使用秒）
封闭类的完全限定名称 org.springframework.cloud.gateway.filter.headers.observation.GatewayDocumentedObservation。
表 1. 低基数键
| 名称 | 描述 |
|---|---|
http.method (必需) | HTTP 方法。 |
http.status_code (必需) | HTTP 状态码。 |
spring.cloud.gateway.route.id (必需) | 路由 ID。 |
spring.cloud.gateway.route.uri (必需) | 取自路由的 HTTP URI。 |
表 2. 高基数键
| 名称 | 描述 |
|---|---|
http.uri (必填) | 完整的 HTTP URI。 |
可观测性 - 跨度
以下是本项目声明的所有 Span 列表。
Gateway Http Client Observation Span
通过网关发送请求时创建的观察记录。
Span 名称 http.client.requests (由约定类 org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention 定义)。
封闭类的完全限定名 org.springframework.cloud.gateway.filter.headers.observation.GatewayDocumentedObservation。
表 3. 标签键
| 名称 | 描述 |
|---|---|
http.method (必需) | HTTP 方法。 |
http.status_code (必需) | HTTP 状态码。 |
http.uri (必需) | 完整的 HTTP URI。 |
spring.cloud.gateway.route.id (必需) | 路由 ID。 |
spring.cloud.gateway.route.uri (必需) | 从路由中获取的 HTTP URI。 |
可观测性 - 约定
以下是本项目声明的所有 GlobalObservationConvention 和 ObservationConvention 列表。
表 4. ObservationConvention 实现
| ObservationConvention 类名 | 适用的 ObservationContext 类名 |
|---|---|
org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention | GatewayContext |
org.springframework.cloud.gateway.filter.headers.observation.GatewayObservationConvention | GatewayContext |