|
请使用 Spring Cloud Consul 5.0.1（最新稳定版本）！ |
常用应用程序属性
您可以在 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 |
替代 spring.application.name，用于在 Consul KV 中查找值。 |
|
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超时时间，请创建一个ConsulClient Bean，并使用自定义的ConsulRawClient及自定义HttpClient。 |
spring.cloud.consul.discovery.acl-token |
||
spring.cloud.consul.discovery.catalog-services-watch-delay |
|
调用 watch consul catalog 之间的延迟时间（毫秒），默认值为 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 |
超时解除注册服务，该超时时间长于超时时间（例如 30 分钟）。需要 Consul 版本 7.x 或更高版本。 |
|
spring.cloud.consul.discovery.health-check-headers |
应用于健康检查调用的请求头。 |
|
spring.cloud.consul.discovery.health-check-interval |
|
执行健康检查的频率（例如每10秒一次），默认为10秒。 |
spring.cloud.consul.discovery.health-check-path |
|
备用服务器路径，用于执行运行状况检查。 |
spring.cloud.consul.discovery.health-check-timeout |
超时时间用于健康检查（例如 10 秒）。 |
|
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 |
|
是否应考虑当前系统状态（通过Actuator Health端点报告）对向Consul TTL检查报告应用程序状态的影响。Actuator Health端点也必须对应用程序可用。 |
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 |
服务器唯一标识符。 |
|
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 |
|
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 |
代理方案（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 |
Password to open the certificate. |
|
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 |
指向外部密钥库的路径。 |