此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Cloud Consul 4.1.3spring-doc.cn

常见应用程序属性

可以在文件内、文件内或作为命令行开关指定各种属性。 本附录提供了常见的 Spring Cloud Consul 属性列表以及对使用它们的基础类的引用。application.propertiesapplication.ymlspring-doc.cn

属性贡献可能来自 Classpath 上的其他 jar 文件,因此您不应将其视为详尽的列表。 此外,您还可以定义自己的属性。
名字 违约 描述

spring.cloud.consul.config.acl-tokenspring-doc.cn

spring.cloud.consul.config.data-keyspring-doc.cn

dataspring-doc.cn

如果 format 为 Format.PROPERTIES 或 Format.YAML,则以下字段将用作查找 consul 的 key 以进行配置。spring-doc.cn

spring.cloud.consul.config.default-contextspring-doc.cn

applicationspring-doc.cn

spring.cloud.consul.config.enabledspring-doc.cn

truespring-doc.cn

spring.cloud.consul.config.fail-fastspring-doc.cn

truespring-doc.cn

如果为 true,则在配置查找期间抛出异常,否则记录警告。spring-doc.cn

spring.cloud.consul.config.formatspring-doc.cn

key-valuespring-doc.cn

spring.cloud.consul.config.namespring-doc.cn

在 consul KV 中查找值时使用的 spring.application.name 的替代方法。spring-doc.cn

spring.cloud.consul.config.前缀spring-doc.cn

spring.cloud.consul.config.前缀spring-doc.cn

spring.cloud.consul.config.profile-separatorspring-doc.cn

,spring-doc.cn

spring.cloud.consul.config.watch.delayspring-doc.cn

1000spring-doc.cn

手表的固定延迟值(以毫秒为单位)。默认值为 1000。spring-doc.cn

spring.cloud.consul.config.watch.enabledspring-doc.cn

truespring-doc.cn

如果手表已启用。默认为 true。spring-doc.cn

spring.cloud.consul.config.watch.wait-timespring-doc.cn

55spring-doc.cn

等待 (或阻止) 监视查询的秒数,默认为 55。需要小于默认 ConsulClient(默认为 60)。要增加 ConsulClient 超时,请创建一个具有自定义 ConsulRawClient 和自定义 HttpClient 的 ConsulClient Bean。spring-doc.cn

spring.cloud.consul.discovery.acl-tokenspring-doc.cn

spring.cloud.consul.discovery.catalog-services-watch-delayspring-doc.cn

1000spring-doc.cn

调用 watch consul catalog 之间的延迟(以毫秒为单位),默认值为 1000。spring-doc.cn

spring.cloud.consul.discovery.catalog-services-watch-timeoutspring-doc.cn

2spring-doc.cn

监视 consul catalog 时要阻塞的秒数,默认为 2。spring-doc.cn

spring.cloud.consul.discovery.consistency-modespring-doc.cn

defaultspring-doc.cn

运行状况服务请求的一致性模式。spring-doc.cn

spring.cloud.consul.discovery.datacentersspring-doc.cn

要在服务器列表中查询的 serviceId 的 → 数据中心的映射。这允许在另一个数据中心中查找服务。spring-doc.cn

spring.cloud.consul.discovery.default-query-tagspring-doc.cn

如果 serverListQueryTags 中未列出服务列表中的标签,则要在服务列表中查询的标签。可以使用逗号分隔值指定多个标记。spring-doc.cn

spring.cloud.consul.discovery.default-zone-metadata-namespring-doc.cn

zonespring-doc.cn

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

spring.cloud.consul.discovery.deregisterspring-doc.cn

truespring-doc.cn

在 consul 中禁用服务的自动注销。spring-doc.cn

spring.cloud.consul.discovery.enable-tag-overridespring-doc.cn

为已注册的服务启用标签覆盖。spring-doc.cn

spring.cloud.consul.discovery.enabledspring-doc.cn

truespring-doc.cn

是否启用了服务发现?spring-doc.cn

spring.cloud.consul.discovery.fail-fastspring-doc.cn

truespring-doc.cn

如果为 true,则在服务注册期间引发异常,否则记录警告(默认为 true)。spring-doc.cn

spring.cloud.consul.discovery.health-check-critical-timeoutspring-doc.cn

取消注册服务时间超过超时时间(例如 30m)的超时。需要 consul 版本 7.x 或更高版本。spring-doc.cn

spring.cloud.consul.discovery.health-check-headersspring-doc.cn

要应用于运行状况检查调用的标头。spring-doc.cn

spring.cloud.consul.discovery.health-check-intervalspring-doc.cn

10sspring-doc.cn

执行运行状况检查的频率(例如 10 秒),默认为 10 秒。spring-doc.cn

spring.cloud.consul.discovery.health-check-pathspring-doc.cn

/actuator/healthspring-doc.cn

要调用的备用服务器路径以进行运行状况检查。spring-doc.cn

spring.cloud.consul.discovery.health-check-timeoutspring-doc.cn

运行状况检查超时(例如 10 秒)。spring-doc.cn

spring.cloud.consul.discovery.health-check-tls-skip-verifyspring-doc.cn

在服务检查期间跳过证书验证,如果为 true,则运行证书验证。spring-doc.cn

spring.cloud.consul.discovery.health-check-urlspring-doc.cn

自定义运行状况检查 URL 以覆盖默认值。spring-doc.cn

spring.cloud.consul.discovery.heartbeat.actuator-health-groupspring-doc.cn

通过 Actuator 确定系统运行状况时要使用的 Actuator 运行状况组(根组为 null)。spring-doc.cn

spring.cloud.consul.discovery.heartbeat.enabledspring-doc.cn

falsespring-doc.cn

spring.cloud.consul.discovery.heartbeat.interval-ratiospring-doc.cn

spring.cloud.consul.discovery.heartbeat.reregister-service-on-failurespring-doc.cn

falsespring-doc.cn

spring.cloud.consul.discovery.heartbeat.ttlspring-doc.cn

30sspring-doc.cn

spring.cloud.consul.discovery.heartbeat.use-actuator-healthspring-doc.cn

truespring-doc.cn

在向 Consul TTL 检查报告应用程序状态时,是否考虑当前的系统健康状况(通过 Actuator Health 端点报告)。Actuator Health 端点也必须对应用程序可用。spring-doc.cn

spring.cloud.consul.discovery.hostnamespring-doc.cn

访问服务器时使用的主机名。spring-doc.cn

spring.cloud.consul.discovery.include-hostname-in-instance-idspring-doc.cn

falsespring-doc.cn

注册服务时,默认实例 ID 中是否包含 hostname。spring-doc.cn

spring.cloud.consul.discovery.instance-groupspring-doc.cn

服务实例组。spring-doc.cn

spring.cloud.consul.discovery.instance-idspring-doc.cn

唯一的服务实例 ID。spring-doc.cn

spring.cloud.consul.discovery.instance-zonespring-doc.cn

服务实例区域。spring-doc.cn

spring.cloud.consul.discovery.ip 地址spring-doc.cn

访问服务时使用的 IP 地址(还必须将 preferIpAddress 设置为使用)。spring-doc.cn

spring.cloud.consul.discovery.lifecycle.enabledspring-doc.cn

truespring-doc.cn

spring.cloud.consul.discovery.management-enable-tag-overridespring-doc.cn

为已注册的管理服务启用标签覆盖。spring-doc.cn

spring.cloud.consul.discovery.management-metadataspring-doc.cn

注册管理服务时使用的元数据。spring-doc.cn

spring.cloud.consul.discovery.management-portspring-doc.cn

用于在其下注册管理服务的端口(默认为 management port)。spring-doc.cn

spring.cloud.consul.discovery.management-suffixspring-doc.cn

managementspring-doc.cn

注册管理服务时使用的后缀。spring-doc.cn

spring.cloud.consul.discovery.management-tagsspring-doc.cn

添加管理服务时使用的标签。spring-doc.cn

spring.cloud.consul.discovery.metadataspring-doc.cn

注册服务时使用的元数据。spring-doc.cn

spring.cloud.consul.discovery.orderspring-doc.cn

0spring-doc.cn

用于对可用客户端进行排序的发现客户端的顺序。CompositeDiscoveryClientspring-doc.cn

spring.cloud.consul.discovery.portspring-doc.cn

用于注册服务的端口(默认为 listening port)。spring-doc.cn

spring.cloud.consul.discovery.prefer-agent-address的spring-doc.cn

falsespring-doc.cn

我们将如何确定要使用的地址的来源。spring-doc.cn

spring.cloud.consul.discovery.prefer-ip-address的spring-doc.cn

falsespring-doc.cn

在注册过程中使用 IP 地址而不是主机名。spring-doc.cn

spring.cloud.consul.discovery.query-passingspring-doc.cn

falsespring-doc.cn

将 'passing' 参数添加到 /v1/health/service/serviceName。这会将运行状况检查传递到服务器。spring-doc.cn

spring.cloud.consul.discovery.registerspring-doc.cn

truespring-doc.cn

在 Consul 中注册为服务。spring-doc.cn

spring.cloud.consul.discovery.register-health-checkspring-doc.cn

truespring-doc.cn

在 consul 中注册健康检查。在服务开发过程中很有用。spring-doc.cn

spring.cloud.consul.discovery.schemespring-doc.cn

httpspring-doc.cn

注册 http 还是 https 服务。spring-doc.cn

spring.cloud.consul.discovery.server-list-query-tagsspring-doc.cn

要在服务器列表中查询的 serviceId 的 → 标记的映射。这允许按多个标签筛选服务。可以使用逗号分隔值指定多个标记。spring-doc.cn

spring.cloud.consul.discovery.service-namespring-doc.cn

服务名称。spring-doc.cn

spring.cloud.consul.discovery.tagsspring-doc.cn

注册服务时使用的标签。spring-doc.cn

spring.cloud.consul.enabledspring-doc.cn

truespring-doc.cn

是否启用了 Spring Cloud Consul。spring-doc.cn

spring.cloud.consul.hostspring-doc.cn

localhostspring-doc.cn

Consul 代理主机名。默认为 'localhost'。spring-doc.cn

spring.cloud.consul.pathspring-doc.cn

自定义路径(如果 consul 位于非 root 下)。spring-doc.cn

spring.cloud.consul.portspring-doc.cn

8500spring-doc.cn

Consul 代理端口。默认为 '8500'。spring-doc.cn

spring.cloud.consul.retry.enabledspring-doc.cn

truespring-doc.cn

如果启用了 consul retry。spring-doc.cn

spring.cloud.consul.retry.initial-intervalspring-doc.cn

1000spring-doc.cn

初始重试间隔(以毫秒为单位)。spring-doc.cn

spring.cloud.consul.retry.max 次尝试spring-doc.cn

6spring-doc.cn

最大尝试次数。spring-doc.cn

spring.cloud.consul.retry.max 间隔spring-doc.cn

2000spring-doc.cn

回退的最大间隔。spring-doc.cn

spring.cloud.consul.retry.multiplierspring-doc.cn

1.1spring-doc.cn

下一个间隔的乘数。spring-doc.cn

spring.cloud.consul.ribbon.enabledspring-doc.cn

truespring-doc.cn

启用 Consul 和 Ribbon 集成。spring-doc.cn

spring.cloud.consul.schemespring-doc.cn

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

spring.cloud.consul.service-registry.auto-registration.enabledspring-doc.cn

truespring-doc.cn

启用 Consul Service Registry 自动注册。spring-doc.cn

spring.cloud.consul.service-registry.enabledspring-doc.cn

truespring-doc.cn

启用 Consul Service Registry 功能。spring-doc.cn

spring.cloud.consul.tls.certificate-passwordspring-doc.cn

用于打开证书的密码。spring-doc.cn

spring.cloud.consul.tls.certificate-pathspring-doc.cn

证书的文件路径。spring-doc.cn

spring.cloud.consul.tls.key-store 实例类型spring-doc.cn

要使用的密钥框架的类型。spring-doc.cn

spring.cloud.consul.tls.key store 密码spring-doc.cn

外部密钥库的密码。spring-doc.cn

spring.cloud.consul.tls.key store 路径spring-doc.cn

外部密钥库的路径。spring-doc.cn