此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Cloud Consul 4.3.0! |
常见应用属性
可以在您的内部指定各种属性application.properties
文件,在application.yml
文件,或作为命令行开关。
本附录提供了常见 Spring Cloud Consul 属性的列表以及对使用它们的底层类的引用。
属性贡献可能来自类路径上的其他 jar 文件,因此您不应将其视为详尽的列表。 此外,您可以定义自己的属性。 |
名称 | 默认值 | 描述 |
---|---|---|
spring.cloud.consul.config.acl-token |
||
spring.cloud.consul.config.data-key |
|
如果 format 是 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.一致性模式 |
运行状况服务请求的一致性模式。 |
|
spring.cloud.consul.discovery.datacenters |
在服务器列表中要查询的 serviceId →数据中心的映射。这允许在另一个数据中心中查找服务。 |
|
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 |
通过执行器确定系统运行状况时要使用的执行器运行状况组(根组为 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 检查报告应用程序状态时,是否考虑当前系统运行状况(通过执行器运行状况端点报告)。执行器运行状况终结点也必须可供应用程序使用。 |
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。 |
|
在领事中注册为服务。 |
spring.cloud.consul.discovery.register-health-check |
|
在 consul 中注册健康检查。在服务开发过程中很有用。 |
spring.cloud.consul.discovery.scheme 的 |
|
是注册 http 还是 https 服务。 |
spring.cloud.consul.discovery.server-list-query-tags |
在服务器列表中查询的 serviceId →标记的映射。这允许按另一个标记过滤服务。可以使用逗号分隔值指定多个标记。 |
|
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 在非 root 下,则自定义路径。 |
|
spring.cloud.consul.port |
|
领事代理端口。默认为“8500”。 |
spring.cloud.consul.retry.enabled |
|
如果启用了 consul 重试。 |
spring.cloud.consul.retry.initial-interval |
|
初始重试间隔(以毫秒为单位)。 |
spring.cloud.consul.retry.max次尝试 |
|
最大尝试次数。 |
spring.cloud.consul.retry.max间距 |
|
回退的最大间隔。 |
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 |
打开证书的密码。 |
|
spring.cloud.consul.tls.certificate-path |
证书的文件路径。 |
|
spring.cloud.consul.tls.key-store-instance-type |
要使用的关键框架类型。 |
|
spring.cloud.consul.tls.key存储密码 |
外部密钥库的密码。 |
|
spring.cloud.consul.tls.key存储路径 |
外部密钥库的路径。 |