常用應用程式屬性

可以在 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.