常用應用程式屬性
可以在 application.properties 檔案、application.yml 檔案中或作為命令列開關指定各種屬性。本附錄提供了常見的 Spring Cloud Consul 屬性列表以及引用使用這些屬性的底層類。
| 屬性貢獻可能來自您 classpath 中的其他 jar 檔案,因此您不應將其視為詳盡列表。此外,您還可以定義自己的屬性。 |
| 名稱 | 預設值 | 描述 |
|---|---|---|
spring.cloud.consul.config.acl-token |
||
spring.cloud.consul.config.data-key |
|
如果格式為 Format.PROPERTIES 或 Format.YAML,則以下欄位用作在 consul 中查詢配置的鍵。 |
spring.cloud.consul.config.default-context |
|
|
spring.cloud.consul.config.enabled |
|
|
spring.cloud.consul.config.fail-fast |
|
如果為 true,則在配置查詢期間丟擲異常,否則記錄警告。 |
spring.cloud.consul.config.format |
|
|
spring.cloud.consul.config.name |
在 consul KV 中查詢值時使用的 spring.application.name 的替代項。 |
|
spring.cloud.consul.config.prefix |
||
spring.cloud.consul.config.prefixes |
||
spring.cloud.consul.config.profile-separator |
|
|
spring.cloud.consul.config.watch.delay |
|
監視的固定延遲值,單位為毫秒。預設為 1000。 |
spring.cloud.consul.config.watch.enabled |
|
是否啟用監視。預設為 true。 |
spring.cloud.consul.config.watch.wait-time |
|
等待(或阻塞)監視查詢的秒數,預設為 55。需要小於預設的 ConsulClient(預設為 60)。要增加 ConsulClient 超時,請建立一個帶有自定義 ConsulRawClient 和自定義 HttpClient 的 ConsulClient bean。 |
spring.cloud.consul.discovery.acl-token |
||
spring.cloud.consul.discovery.catalog-services-watch-delay |
|
呼叫監視 consul 目錄的延遲,單位為毫秒,預設為 1000。 |
spring.cloud.consul.discovery.catalog-services-watch-timeout |
|
監視 consul 目錄時阻塞的秒數,預設為 2。 |
spring.cloud.consul.discovery.consistency-mode |
|
健康服務請求的一致性模式。 |
spring.cloud.consul.discovery.datacenters |
服務 ID 到資料中心的對映,用於在伺服器列表中查詢。這允許在其他資料中心中查詢服務。 |
|
spring.cloud.consul.discovery.default-query-tag |
如果在 serverListQueryTags 中未列出,則在服務列表中查詢的標籤。可以使用逗號分隔的值指定多個標籤。 |
|
spring.cloud.consul.discovery.default-zone-metadata-name |
|
服務例項區域來自元資料。這允許更改元資料標籤名稱。 |
spring.cloud.consul.discovery.deregister |
|
停用在 consul 中自動登出服務。 |
spring.cloud.consul.discovery.enable-tag-override |
啟用註冊服務的標籤覆蓋。 |
|
spring.cloud.consul.discovery.enabled |
|
是否啟用服務發現? |
spring.cloud.consul.discovery.fail-fast |
|
如果為 true,則在服務註冊期間丟擲異常,否則記錄警告(預設為 true)。 |
spring.cloud.consul.discovery.health-check-critical-timeout |
超時,用於登出關鍵時間超過超時的服務(例如 30m)。需要 consul 版本 7.x 或更高版本。 |
|
spring.cloud.consul.discovery.health-check-headers |
應用於健康檢查呼叫的請求頭。 |
|
spring.cloud.consul.discovery.health-check-interval |
|
執行健康檢查的頻率(例如 10s),預設為 10s。 |
spring.cloud.consul.discovery.health-check-path |
|
用於健康檢查的備用伺服器路徑。 |
spring.cloud.consul.discovery.health-check-timeout |
健康檢查超時(例如 10s)。 |
|
spring.cloud.consul.discovery.health-check-tls-skip-verify |
如果為 true,則在服務檢查期間跳過證書驗證,否則執行證書驗證。 |
|
spring.cloud.consul.discovery.health-check-url |
自定義健康檢查 URL 以覆蓋預設值。 |
|
spring.cloud.consul.discovery.heartbeat.actuator-health-group |
透過 Actuator 確定系統健康狀況時使用的 Actuator 健康組(根組為 null)。 |
|
spring.cloud.consul.discovery.heartbeat.enabled |
|
|
spring.cloud.consul.discovery.heartbeat.interval-ratio |
||
spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure |
|
|
spring.cloud.consul.discovery.heartbeat.ttl |
|
|
spring.cloud.consul.discovery.heartbeat.use-actuator-health |
|
在向 Consul TTL 檢查報告應用程式狀態時,是否考慮當前的系統健康狀況(透過 Actuator 健康端點報告)。Actuator 健康端點也必須對應用程式可用。 |
spring.cloud.consul.discovery.hostname |
訪問伺服器時使用的主機名。 |
|
spring.cloud.consul.discovery.include-hostname-in-instance-id |
|
註冊服務時,主機名是否包含在預設例項 ID 中。 |
spring.cloud.consul.discovery.instance-group |
服務例項組。 |
|
spring.cloud.consul.discovery.instance-id |
唯一的服務例項 ID。 |
|
spring.cloud.consul.discovery.instance-zone |
服務例項區域。 |
|
spring.cloud.consul.discovery.ip-address |
訪問服務時使用的 IP 地址(還必須設定 preferIpAddress 才能使用)。 |
|
spring.cloud.consul.discovery.lifecycle.enabled |
|
|
spring.cloud.consul.discovery.management-enable-tag-override |
啟用註冊管理服務的標籤覆蓋。 |
|
spring.cloud.consul.discovery.management-metadata |
註冊管理服務時使用的元資料。 |
|
spring.cloud.consul.discovery.management-port |
註冊管理服務的埠(預設為管理埠)。 |
|
spring.cloud.consul.discovery.management-suffix |
|
註冊管理服務時使用的字尾。 |
spring.cloud.consul.discovery.management-tags |
註冊管理服務時使用的標籤。 |
|
spring.cloud.consul.discovery.metadata |
註冊服務時使用的元資料。 |
|
spring.cloud.consul.discovery.order |
|
|
spring.cloud.consul.discovery.port |
註冊服務的埠(預設為監聽埠)。 |
|
spring.cloud.consul.discovery.prefer-agent-address |
|
我們將如何確定要使用的地址的來源。 |
spring.cloud.consul.discovery.prefer-ip-address |
|
註冊期間使用 IP 地址而不是主機名。 |
spring.cloud.consul.discovery.query-passing |
|
將“passing”引數新增到 /v1/health/service/serviceName。這會將健康檢查傳遞到伺服器。 |
spring.cloud.consul.discovery.register |
|
在 consul 中註冊為服務。 |
spring.cloud.consul.discovery.register-health-check |
|
在 consul 中註冊健康檢查。在服務開發期間很有用。 |
spring.cloud.consul.discovery.scheme |
|
是否註冊 HTTP 或 HTTPS 服務。 |
spring.cloud.consul.discovery.server-list-query-tags |
服務 ID 到標籤的對映,用於在伺服器列表中查詢。這允許按一個或多個標籤過濾服務。可以使用逗號分隔的值指定多個標籤。 |
|
spring.cloud.consul.discovery.service-name |
服務名稱。 |
|
spring.cloud.consul.discovery.tags |
註冊服務時使用的標籤。 |
|
spring.cloud.consul.enabled |
|
是否啟用 Spring Cloud Consul。 |
spring.cloud.consul.host |
|
Consul 代理主機名。預設為“localhost”。 |
spring.cloud.consul.path |
如果 consul 不在根目錄下,則使用自定義路徑。 |
|
spring.cloud.consul.port |
|
Consul 代理埠。預設為“8500”。 |
spring.cloud.consul.retry.enabled |
|
是否啟用 consul 重試。 |
spring.cloud.consul.retry.initial-interval |
|
初始重試間隔,單位為毫秒。 |
spring.cloud.consul.retry.max-attempts |
|
最大嘗試次數。 |
spring.cloud.consul.retry.max-interval |
|
回退的最大間隔。 |
spring.cloud.consul.retry.multiplier |
|
下一個間隔的乘數。 |
spring.cloud.consul.ribbon.enabled |
|
啟用 Consul 和 Ribbon 整合。 |
spring.cloud.consul.scheme |
Consul 代理方案 (HTTP/HTTPS)。如果地址中沒有方案,客戶端將使用 HTTP。 |
|
spring.cloud.consul.service-registry.auto-registration.enabled |
|
啟用 Consul 服務註冊自動註冊。 |
spring.cloud.consul.service-registry.enabled |
|
啟用 Consul 服務註冊功能。 |
spring.cloud.consul.tls.certificate-password |
開啟證書的密碼。 |
|
spring.cloud.consul.tls.certificate-path |
證書的檔案路徑。 |
|
spring.cloud.consul.tls.key-store-instance-type |
要使用的金鑰框架型別。 |
|
spring.cloud.consul.tls.key-store-password |
外部金鑰庫的密碼。 |
|
spring.cloud.consul.tls.key-store-path |
外部金鑰庫的路徑。 |