常用应用程序属性

可以在 application.properties 文件、application.yml 文件或作为命令行开关指定各种属性。本附录提供了常见的 Spring Cloud Gateway 属性列表以及引用使用它们的底层类。

属性贡献可能来自您 classpath 中的其他 jar 文件,因此您不应将其视为详尽列表。此外,您还可以定义自己的属性。
名称 默认值 描述

spring.cloud.gateway.server.webflux.default-filters

应用于每个路由的过滤器定义列表。

spring.cloud.gateway.server.webflux.discovery.locator.enabled

启用 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

在谓词和过滤器中将 serviceId 转换为小写的选项,默认为 false。在 eureka 自动将 serviceId 大写时很有用。因此 MYSERIVCE 将匹配 /myservice/**

spring.cloud.gateway.server.webflux.discovery.locator.predicates

spring.cloud.gateway.server.webflux.discovery.locator.route-id-prefix

routeId 的前缀,默认为 discoveryClient.getClass().getSimpleName() + "_"。Service Id 将被附加以创建 routeId。

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

启用 add-request-header 过滤器。

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

启用 circuit-breaker 过滤器。

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

启用 local-response-cache 过滤器。

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

启用 modify-request-body 过滤器。

spring.cloud.gateway.server.webflux.filter.modify-response-body.enabled

true

启用 modify-response-body 过滤器。

spring.cloud.gateway.server.webflux.filter.prefix-path.enabled

true

启用 prefix-path 过滤器。

spring.cloud.gateway.server.webflux.filter.preserve-host-header.enabled

true

启用 preserve-host-header 过滤器。

spring.cloud.gateway.server.webflux.filter.redirect-to.enabled

true

启用 redirect-to 过滤器。

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

启用 remove-request-header 过滤器。

spring.cloud.gateway.server.webflux.filter.remove-request-parameter.enabled

true

启用 remove-request-parameter 过滤器。

spring.cloud.gateway.server.webflux.filter.remove-response-header.enabled

true

启用 remove-response-header 过滤器。

spring.cloud.gateway.server.webflux.filter.request-header-size.enabled

true

启用 request-header-size 过滤器。

spring.cloud.gateway.server.webflux.filter.request-header-to-request-uri.enabled

true

启用 request-header-to-request-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

启用 request-rate-limiter 过滤器。

spring.cloud.gateway.server.webflux.filter.request-size.enabled

true

启用 request-size 过滤器。

spring.cloud.gateway.server.webflux.filter.retry.enabled

true

启用 retry 过滤器。

spring.cloud.gateway.server.webflux.filter.rewrite-location-response-header.enabled

true

启用 rewrite-location-response-header 过滤器。

spring.cloud.gateway.server.webflux.filter.rewrite-location.enabled

true

启用 rewrite-location 过滤器。

spring.cloud.gateway.server.webflux.filter.rewrite-path.enabled

true

启用 rewrite-path 过滤器。

spring.cloud.gateway.server.webflux.filter.rewrite-request-parameter.enabled

true

启用 rewrite-request-parameter 过滤器。

spring.cloud.gateway.server.webflux.filter.rewrite-response-header.enabled

true

启用 rewrite-response-header 过滤器。

spring.cloud.gateway.server.webflux.filter.save-session.enabled

true

启用 save-session 过滤器。

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

启用 secure-headers 过滤器。

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

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

启用 set-path 过滤器。

spring.cloud.gateway.server.webflux.filter.set-request-header.enabled

true

启用 set-request-header 过滤器。

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

启用 set-status 过滤器。

spring.cloud.gateway.server.webflux.filter.strip-prefix.enabled

true

启用 strip-prefix 过滤器。

spring.cloud.gateway.server.webflux.forwarded.by.enabled

启用 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

启用 forward-path 全局过滤器。

spring.cloud.gateway.server.webflux.global-filter.forward-routing.enabled

true

启用 forward-routing 全局过滤器。

spring.cloud.gateway.server.webflux.global-filter.load-balancer-client.enabled

true

启用 load-balancer-client 全局过滤器。

spring.cloud.gateway.server.webflux.global-filter.local-response-cache.enabled

true

为所有路由启用 local-response-cache 过滤器,它允许使用 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

全局 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

为 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

配置池的租用策略(先进先出或后进先出),默认为 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

启用通道池指标以在 Micrometer 中收集和注册。默认禁用。

spring.cloud.gateway.server.webflux.httpclient.pool.name

代理

通道池映射名称,默认为 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

密钥密码,默认为 keyStorePassword。

spring.cloud.gateway.server.webflux.httpclient.ssl.key-store

Netty HttpClient 的密钥库路径。

spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-password

密钥库密码。

spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-provider

Netty HttpClient 的密钥库提供程序,可选字段。

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

安装 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

为 Netty HttpClient 启用 wiretap 调试。

spring.cloud.gateway.server.webflux.httpserver.wiretap

为 Netty HttpServer 启用 wiretap 调试。

spring.cloud.gateway.server.webflux.loadbalancer.use404

spring.cloud.gateway.server.webflux.metrics.enabled

启用指标数据收集。

spring.cloud.gateway.server.webflux.metrics.prefix

spring.cloud.gateway

网关发出的所有指标的前缀。

spring.cloud.gateway.server.webflux.metrics.tags

添加到指标的标签映射。

spring.cloud.gateway.server.webflux.observability.enabled

true

是否开启 Micrometer 可观测性支持。

spring.cloud.gateway.server.webflux.predicate.after.enabled

true

启用 after 谓词。

spring.cloud.gateway.server.webflux.predicate.before.enabled

true

启用 before 谓词。

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

启用 header 谓词。

spring.cloud.gateway.server.webflux.predicate.host.enabled

true

启用 host 谓词。

spring.cloud.gateway.server.webflux.predicate.host.include-port

true

在匹配主机名时包含端口。

spring.cloud.gateway.server.webflux.predicate.method.enabled

true

启用 method 谓词。

spring.cloud.gateway.server.webflux.predicate.path.enabled

true

启用 path 谓词。

spring.cloud.gateway.server.webflux.predicate.query.enabled

true

启用 query 谓词。

spring.cloud.gateway.server.webflux.predicate.read-body.enabled

true

启用 read-body 谓词。

spring.cloud.gateway.server.webflux.predicate.remote-addr.enabled

true

启用 remote-addr 谓词。

spring.cloud.gateway.server.webflux.predicate.weight.enabled

true

启用 weight 谓词。

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。

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

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

启用 form-filter。

spring.cloud.gateway.server.webmvc.forwarded-request-headers-filter.enabled

true

启用 forwarded-request-headers-filter。

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

启用 remove-hop-by-hop-request-headers-filter。

spring.cloud.gateway.server.webmvc.remove-hop-by-hop-response-headers-filter.enabled

true

启用 remove-hop-by-hop-response-headers-filter。

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

启用 transfer-encoding-normalization-request-headers-filter。

spring.cloud.gateway.server.webmvc.trusted-proxies

定义当出现在 Forwarded 或 X-Forwarded 头部中时被信任的代理的正则表达式。

spring.cloud.gateway.server.webmvc.use-framework-retry-filter

如果 Spring Retry 在 classpath 上,但您仍然希望使用 Spring Framework 重试作为您的重试过滤器,请将此属性设置为 true。

spring.cloud.gateway.server.webmvc.weight-calculator-filter.enabled

true

启用 weight-calculator-filter。

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。

可观测性元数据

可观测性 - 指标

以下是本项目声明的所有指标列表。

网关 Http 客户端观测

通过网关发送请求时创建的观测。

指标名称 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

在启动观测后添加的键值可能会从 *.active 指标中缺失。
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

以下是本项目声明的所有 Span 列表。

网关 Http 客户端观测跨度

通过网关发送请求时创建的观测。

跨度名称 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。

可观测性 - 约定

您可以在下面找到此项目声明的所有 GlobalObservationConventionObservationConvention 列表。

表 4. ObservationConvention 实现

ObservationConvention 类名

适用的 ObservationContext 类名

org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention

GatewayContext

org.springframework.cloud.gateway.filter.headers.observation.GatewayObservationConvention

GatewayContext

© . This site is unofficial and not affiliated with VMware.