Common application properties

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

属性贡献可以来自类路径上的其他 jar 文件，因此你不应该将此视为一份详尽的清单。此外，你可以定义自己的属性。

Name Default Description

Name	Default	Description
spring.cloud.consul.config.acl-token
spring.cloud.consul.config.data-key	`data`	如果格式为 Format.PROPERTIES 或 Format.YAML，则使用以下字段作为键在 Consul 中查找配置。
spring.cloud.consul.config.default-context	`application`
spring.cloud.consul.config.enabled	`true`
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`	以毫秒为单位的观察固定延迟的值。默认为 1000。
spring.cloud.consul.config.watch.enabled	`true`	是否启用观察。默认为真。
spring.cloud.consul.config.watch.wait-time	`55`	观察查询的等待（或阻止）秒数，默认为 55。需要小于默认 ConsulClient（默认为 60）。要增加 ConsulClient 超时，请使用自定义 HttpClient 创建一个具有自定义 ConsulRawClient 的 ConsulClient bean。
spring.cloud.consul.discovery.acl-token
spring.cloud.consul.discovery.catalog-services-watch-delay	`1000`	以毫秒为单位的调用 Consul 目录观察之间的延迟，默认为 1000。
spring.cloud.consul.discovery.catalog-services-watch-timeout	`2`	观察 Consul 目录时阻止的秒数，默认为 2。
spring.cloud.consul.discovery.consistency-mode		健康服务请求的一致性模式。
spring.cloud.consul.discovery.datacenters		serviceId 到数据中心的映射 → 在服务器列表中进行查询。这允许在其他数据中心查找服务。
spring.cloud.consul.discovery.default-query-tag		如果没有在ServerListQueryTags中列出服务列表，则需要查询的标签。可以使用逗号分隔的值指定多个标签。
spring.cloud.consul.discovery.default-zone-metadata-name	`zone`	服务实例区域来自元数据。这允许更改元数据标签名称。
spring.cloud.consul.discovery.deregister	`true`	在Consul中禁用服务的自动注销。
spring.cloud.consul.discovery.enable-tag-override		为注册的服务启用标签覆盖。
spring.cloud.consul.discovery.enabled	`true`	Is service discovery enabled?
spring.cloud.consul.discovery.fail-fast	`true`	如果为真，则在服务注册过程中引发异常；否则，记录警告（默认为真）。
spring.cloud.consul.discovery.health-check-critical-timeout		注销服务超过超时时间（例如 30 分钟）的超时。需要Consul版本 7.x 或更高版本。
spring.cloud.consul.discovery.health-check-headers		应用于健康检查调用的标头。
spring.cloud.consul.discovery.health-check-interval	`10s`	执行健康检查的频率（例如 10 秒），默认为 10 秒。
spring.cloud.consul.discovery.health-check-path	`/actuator/health`	调用健康检查所调用备用服务器路径。
spring.cloud.consul.discovery.health-check-timeout		健康检查超时（例如 10 秒）。
spring.cloud.consul.discovery.health-check-tls-skip-verify		如果为真，则在服务检查期间跳过证书验证；否则，运行证书验证。
spring.cloud.consul.discovery.health-check-url		自定义健康检查url以覆盖默认设置。
spring.cloud.consul.discovery.heartbeat.actuator-health-group		通过Actuator确定系统健康状况时的执行器健康组（根组为null）。
spring.cloud.consul.discovery.heartbeat.enabled	`false`
spring.cloud.consul.discovery.heartbeat.interval-ratio
spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure	`false`
spring.cloud.consul.discovery.heartbeat.ttl	`30s`
spring.cloud.consul.discovery.heartbeat.use-actuator-health	`true`	向 Consul TTL 检查报告应用程序状态时是否考虑当前系统运行状况（通过 Actuator Health 端点报告）。应用程序还必须能访问 Actuator Health 端点。
spring.cloud.consul.discovery.hostname		访问服务器时要使用的主机名。
spring.cloud.consul.discovery.include-hostname-in-instance-id	`false`	向服务注册时是否将主机名包括在默认实例 ID 中。
spring.cloud.consul.discovery.instance-group		Service instance group.
spring.cloud.consul.discovery.instance-id		Unique service instance id.
spring.cloud.consul.discovery.instance-zone		Service instance zone.
spring.cloud.consul.discovery.ip-address		访问服务时要使用的 IP 地址（还必须设置 preferIpAddress 为要使用）。
spring.cloud.consul.discovery.lifecycle.enabled	`true`
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	`management`	向管理服务注册时要使用的后缀。
spring.cloud.consul.discovery.management-tags		向管理服务注册时要使用的标签。
spring.cloud.consul.discovery.metadata		向服务注册时要使用的元数据。
spring.cloud.consul.discovery.order	`0`	`CompositeDiscoveryClient` 用于对可用客户端排序的发现客户端的顺序。
spring.cloud.consul.discovery.port		在以下端口注册服务（默认为侦听端口）。
spring.cloud.consul.discovery.prefer-agent-address	`false`	我们如何确定要使用的地址的来源。
spring.cloud.consul.discovery.prefer-ip-address	`false`	在注册期间使用ip地址，而不是主机名。
spring.cloud.consul.discovery.query-passing	`false`	向/v1/health/service/serviceName添加“passing”参数。这让健康检查通过推送到服务器中。
spring.cloud.consul.discovery.register	`true`	在consul中注册为服务。
spring.cloud.consul.discovery.register-health-check	`true`	在consul中注册健康检查。这对开发服务很有用。
spring.cloud.consul.discovery.scheme	`http`	是否注册http或https服务。
spring.cloud.consul.discovery.server-list-query-tags		serviceId’s→标签到服务器列表中查询的映射。这样就可以按一个或多个标签对服务进行过滤处理。多个标签可用逗号分隔的值来指定。
spring.cloud.consul.discovery.service-name		Service name.
spring.cloud.consul.discovery.tags		在注册服务时要使用的标签。
spring.cloud.consul.enabled	`true`	spring cloud consul是否启用。
spring.cloud.consul.host	`localhost`	consul代理主机名。默认为“localhost”。
spring.cloud.consul.path		如果consul位于非根目录下，就需要自定义路径。
spring.cloud.consul.port	`8500`	consul代理端口。默认为“8500”。
spring.cloud.consul.retry.enabled	`true`	是否启用consul重试。
spring.cloud.consul.retry.initial-interval	`1000`	初始重试时间间隔（毫秒）。
spring.cloud.consul.retry.max-attempts	`6`	Maximum number of attempts.
spring.cloud.consul.retry.max-interval	`2000`	Maximum interval for backoff.
spring.cloud.consul.retry.multiplier	`1.1`	Multiplier for next interval.
spring.cloud.consul.ribbon.enabled	`true`	启用Consul和Ribbon集成。
spring.cloud.consul.scheme		Consul 代理方案 (HTTP/HTTPS)。如果地址中没有方案 - 客户端将使用 HTTP。
spring.cloud.consul.service-registry.auto-registration.enabled	`true`	启用 Consul 服务注册自动注册。
spring.cloud.consul.service-registry.enabled	`true`	启用 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		外部密钥库的路径。

spring.cloud.consul.config.acl-token

spring.cloud.consul.config.data-key

data

如果格式为 Format.PROPERTIES 或 Format.YAML，则使用以下字段作为键在 Consul 中查找配置。

spring.cloud.consul.config.default-context

application

spring.cloud.consul.config.enabled

true

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

以毫秒为单位的观察固定延迟的值。默认为 1000。

spring.cloud.consul.config.watch.enabled

true

是否启用观察。默认为真。

spring.cloud.consul.config.watch.wait-time

55

观察查询的等待（或阻止）秒数，默认为 55。需要小于默认 ConsulClient（默认为 60）。要增加 ConsulClient 超时，请使用自定义 HttpClient 创建一个具有自定义 ConsulRawClient 的 ConsulClient bean。

spring.cloud.consul.discovery.acl-token

spring.cloud.consul.discovery.catalog-services-watch-delay

1000

以毫秒为单位的调用 Consul 目录观察之间的延迟，默认为 1000。

spring.cloud.consul.discovery.catalog-services-watch-timeout

2

观察 Consul 目录时阻止的秒数，默认为 2。

spring.cloud.consul.discovery.consistency-mode

健康服务请求的一致性模式。

spring.cloud.consul.discovery.datacenters

serviceId 到数据中心的映射 → 在服务器列表中进行查询。这允许在其他数据中心查找服务。

spring.cloud.consul.discovery.default-query-tag

如果没有在ServerListQueryTags中列出服务列表，则需要查询的标签。可以使用逗号分隔的值指定多个标签。

spring.cloud.consul.discovery.default-zone-metadata-name

zone

服务实例区域来自元数据。这允许更改元数据标签名称。

spring.cloud.consul.discovery.deregister

true

在Consul中禁用服务的自动注销。

spring.cloud.consul.discovery.enable-tag-override

为注册的服务启用标签覆盖。

spring.cloud.consul.discovery.enabled

true

Is service discovery enabled?

spring.cloud.consul.discovery.fail-fast

true

如果为真，则在服务注册过程中引发异常；否则，记录警告（默认为真）。

spring.cloud.consul.discovery.health-check-critical-timeout

注销服务超过超时时间（例如 30 分钟）的超时。需要Consul版本 7.x 或更高版本。

spring.cloud.consul.discovery.health-check-headers

应用于健康检查调用的标头。

spring.cloud.consul.discovery.health-check-interval

10s

执行健康检查的频率（例如 10 秒），默认为 10 秒。

spring.cloud.consul.discovery.health-check-path

/actuator/health

调用健康检查所调用备用服务器路径。

spring.cloud.consul.discovery.health-check-timeout

健康检查超时（例如 10 秒）。

spring.cloud.consul.discovery.health-check-tls-skip-verify

如果为真，则在服务检查期间跳过证书验证；否则，运行证书验证。

spring.cloud.consul.discovery.health-check-url

自定义健康检查url以覆盖默认设置。

spring.cloud.consul.discovery.heartbeat.actuator-health-group

通过Actuator确定系统健康状况时的执行器健康组（根组为null）。

spring.cloud.consul.discovery.heartbeat.enabled

false

spring.cloud.consul.discovery.heartbeat.interval-ratio

spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure

false

spring.cloud.consul.discovery.heartbeat.ttl

30s

spring.cloud.consul.discovery.heartbeat.use-actuator-health

true

向 Consul TTL 检查报告应用程序状态时是否考虑当前系统运行状况（通过 Actuator Health 端点报告）。应用程序还必须能访问 Actuator Health 端点。

spring.cloud.consul.discovery.hostname

访问服务器时要使用的主机名。

spring.cloud.consul.discovery.include-hostname-in-instance-id

false

向服务注册时是否将主机名包括在默认实例 ID 中。

spring.cloud.consul.discovery.instance-group

Service instance group.

spring.cloud.consul.discovery.instance-id

Unique service instance id.

spring.cloud.consul.discovery.instance-zone

Service instance zone.

spring.cloud.consul.discovery.ip-address

访问服务时要使用的 IP 地址（还必须设置 preferIpAddress 为要使用）。

spring.cloud.consul.discovery.lifecycle.enabled

true

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

management

向管理服务注册时要使用的后缀。

spring.cloud.consul.discovery.management-tags

向管理服务注册时要使用的标签。

spring.cloud.consul.discovery.metadata

向服务注册时要使用的元数据。

spring.cloud.consul.discovery.order

0

CompositeDiscoveryClient 用于对可用客户端排序的发现客户端的顺序。

spring.cloud.consul.discovery.port

在以下端口注册服务（默认为侦听端口）。

spring.cloud.consul.discovery.prefer-agent-address

false

我们如何确定要使用的地址的来源。

spring.cloud.consul.discovery.prefer-ip-address

false

在注册期间使用ip地址，而不是主机名。

spring.cloud.consul.discovery.query-passing

false

向/v1/health/service/serviceName添加“passing”参数。这让健康检查通过推送到服务器中。

spring.cloud.consul.discovery.register

true

在consul中注册为服务。

spring.cloud.consul.discovery.register-health-check

true

在consul中注册健康检查。这对开发服务很有用。

spring.cloud.consul.discovery.scheme

http

是否注册http或https服务。

spring.cloud.consul.discovery.server-list-query-tags

serviceId’s→标签到服务器列表中查询的映射。这样就可以按一个或多个标签对服务进行过滤处理。多个标签可用逗号分隔的值来指定。

spring.cloud.consul.discovery.service-name

Service name.

spring.cloud.consul.discovery.tags

在注册服务时要使用的标签。

spring.cloud.consul.enabled

true

spring cloud consul是否启用。

spring.cloud.consul.host

localhost

consul代理主机名。默认为“localhost”。

spring.cloud.consul.path

如果consul位于非根目录下，就需要自定义路径。

spring.cloud.consul.port

8500

consul代理端口。默认为“8500”。

spring.cloud.consul.retry.enabled

true

是否启用consul重试。

spring.cloud.consul.retry.initial-interval

1000

初始重试时间间隔（毫秒）。

spring.cloud.consul.retry.max-attempts

6

Maximum number of attempts.

spring.cloud.consul.retry.max-interval

2000

Maximum interval for backoff.

spring.cloud.consul.retry.multiplier

1.1

Multiplier for next interval.

spring.cloud.consul.ribbon.enabled

true

启用Consul和Ribbon集成。

spring.cloud.consul.scheme

Consul 代理方案 (HTTP/HTTPS)。如果地址中没有方案 - 客户端将使用 HTTP。

spring.cloud.consul.service-registry.auto-registration.enabled

true

启用 Consul 服务注册自动注册。

spring.cloud.consul.service-registry.enabled

true

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

外部密钥库的路径。