4.Netflix Eureka参数配置项详解

目录

---

Spring Cloud专栏目录（点击进入…）

---

---

Netflix Eureka参数配置项详解（★）

分为客户端（Eureka Client）配置、服务端（Eureka Server）配置、微服务端配置，一共100多项，其中有很多配置参数并不需要去修改，使用默认的就好，有些跟业务相关的配置参数可根据需要自行设置

配置前缀	描述
eureka.instance.*	Eureka实例注册配置项，这些是无论Eureka是做Server，Client都需要的公共配置项。对应的配置类为cloud.netflix.eureka.EurekaInstanceConfigBean
eureka.server.*	Eureka做为Eureka Server才需要配置的选项，即使用eureka做注册中心时才需要配置这个选项。对应的配置类为cloud.netflix.eureka.EurekaClientConfigBean
eureka.client.*	Eureka做为Eureka Client才需要配置的选项，即服务需要向注册中心注册或使用注册中心中的服务时才需要配置这些选项。对应的配置类为cloud.netflix.eureka.server.EurekaServerConfigBean

服务端配置（Eureka Server）

Spring Boot读取org.springframework.cloud.netflix.eureka.server.EurekaServerConfigBean类中的参数，作为EurekaServer的配置

服务端的前缀为eureka.server

都是驼峰命名：
①properties：RegistryFetchIntervalSeconds --> registry.fetch.interval.seconds
②yml：RegistryFetchIntervalSeconds --> registry-fetch-interval-seconds（驼峰命名也可以）

也就是一个大写字母可以转换为“-小写字母”

配置	描述
EnableSelfPreservation	自我保护模式。当出现出现网络分区、Eureka在短时间内丢失过多客户端时，会进入自我保护模式，即一个服务长时间没有发送心跳，Eureka也不会将其删除，默认为true
EvictionIntervalTimerInMs	过期实例应该启动并运行的时间间隔，单位为毫秒，默认为60 * 1000
DisableDelta	增量信息是否可以提供给客户端看，默认为false

AWS（Amazon Web Services）
Spring Cloud for Amazon Web Services是Spring Cloud项目的一部分，可以简化与托管Amazon Web Services的集成。提供了一种使用众所周知的Spring习语和API（如消息传递或缓存API）与AWS提供的服务进行交互的便捷方式。开发人员可以围绕托管服务构建应用程序，而无需关心基础结构或维护。

AWS配置	描述
AWSAccessId	获取aws访问的id，主要用于弹性ip绑定，此配置是用于aws上的，默认为null
AWSSecretKey	获取aws私有秘钥，主要用于弹性ip绑定，此配置是用于aws上的，默认为null
ASGQueryTimeoutMs	查询AWS上ASG（自动缩放组）信息的超时值，单位为毫秒，默认为300
ASGUpdateIntervalMs	从AWS上更新ASG信息的时间间隔，单位为毫秒，默认为5 * 60 * 1000
ASGCacheExpiryTimeoutMs	缓存ASG信息的到期时间，单位为毫秒，默认为10 * 60 * 1000

特性
（1）[SQS]的Spring Messaging API实现
（2）[ElastiCache]的Spring Cache API实现
（3）基于注释的[SNS]端点（HTTP）映射。
（4）按照[CloudFormation]堆栈中定义的逻辑名访问资源
（5）基于[RDS]实例的逻辑名称创建自动JDBC DataSource
（6）Ant风格路径匹配[S3]存储桶的ResourceLoader

BatchReplication：表示集群节点之间的复制是否为了网络效率而进行批处理，默认为false
BindingStrategy：获取配置绑定EIP或Route53的策略

DeltaRetentionTimerIntervalInMs：清理任务程序被唤醒的时间间隔，清理过期的增量信息，单位为毫秒，默认为30 * 1000
DisableDeltaForRemoteRegions：增量信息是否可以提供给客户端或一些远程地区，默认为false
DisableTransparentFallbackToOtherRegion：如果在远程区域本地没有实例运行，对于应用程序回退的旧行为是否被禁用， 默认为false

EIP（Enterprise Information Portal）
企业信息门户EIP（Enterprise Information Portal）是指在Internet的环境下，把各种应用系统、数据资源和互联网资源统一集成到企业信息门户之下，根据每个用户使用特点和角色的不同，形成个性化的应用界面，并通过对事件和消息的处理、传输把用户有机地联系在一起

EIP配置	描述
EIPBindRebindRetries	获取服务器尝试绑定到候选的EIP的次数，默认为3（集群相互注册）
EIPBindingRetryIntervalMsWhenUnbound	服务器检查IP绑定的时间间隔，单位为毫秒，默认为1 * 60 * 1000
EIPBindingRetryIntervalMs	与上面的是同一作用，仅仅是稳定状态检查，默认为5 * 60 * 1000
EnableReplicatedRequestCompression	复制的数据在发送请求时是否被压缩，默认为false
Experimental	当尝试新功能迁移过程时，为了避免配置API污染，相应的配置即可投入实验配置部分，默认为null

配置	描述
RenewalPercentThreshold	阈值因子，默认是0.85，如果阈值比最小值大，则自我保护模式开启
RenewalThresholdUpdateIntervalMs	阈值更新的时间间隔，单位为毫秒，默认为15 * 60 * 1000
RetentionTimeInMSInDeltaQueue	客户端保持增量信息缓存的时间，从而保证不会丢失这些信息，单位为毫秒，默认为3 * 60 * 1000
RegistrySyncRetries	当eureka服务器启动时尝试去获取集群里其他服务器上的注册信息的次数，默认为5
RegistrySyncRetryWaitMs	当eureka服务器启动时获取其他服务器的注册信息失败时，会再次尝试获取，期间需要等待的时间，默认为30 * 1000毫秒
RemoteRegionConnectTimeoutMs	连接到对等远程地eureka节点的超时时间，默认为1000毫秒
RemoteRegionReadTimeoutMs	获取从远程地区eureka节点读取信息的超时时间，默认为1000毫秒
RemoteRegionTotalConnections	获取远程地区对等节点上http连接的总数，默认为1000
RemoteRegionTotalConnectionsPerHost	获取远程地区特定的对等节点上http连接的总数，默认为500
RemoteRegionConnectionIdleTimeoutSeconds	http连接被清理之后远程地区服务器的空闲时间，默认为30秒
RemoteRegionUrlsWithName	针对远程地区发现的网址域名的map
RemoteRegionUrls	远程地区的URL列表
RemoteRegionAppWhitelist	必须通过远程区域中检索的应用程序的列表
RemoteRegionRegistryFetchInterval	从远程区域取出该注册表的信息的时间间隔，默认为30秒
RemoteRegionFetchThreadPoolSize	用于执行远程区域注册表请求的线程池的大小，默认为20
RemoteRegionTrustStore	用来合格请求远程区域注册表的信任存储文件，默认为空
RemoteRegionTrustStorePassword	获取偏远地区信任存储文件的密码，默认为“changeit”
ResponseCacheAutoExpirationInSeconds	当注册表信息被改变时，则其被保存在缓存中不失效的时间，默认为180秒
ResponseCacheUpdateIntervalMs	客户端的有效负载缓存应该更新的时间间隔，默认为30 * 1000毫秒
RateLimiterEnabled	限流是否应启用或禁用，默认为false
RateLimiterThrottleStandardClients	是否对标准客户端进行限流，默认false
RateLimiterPrivilegedClients	认证的客户端列表，这里是除了标准的eureka Java客户端
RateLimiterBurstSize	速率限制的burst size ，默认为10，这里用的是令牌桶算法
RateLimiterRegistryFetchAverageRate	速率限制器用的是令牌桶算法，此配置指定平均执行注册请求速率，默认为500
RateLimiterFullFetchAverageRate	速率限制器用的是令牌桶算法，此配置指定平均执行请求速率，默认为100
Route53DomainTTL	用于建立route53域的ttl，默认为301
Route53BindRebindRetries	服务器尝试绑定到候选Route53域的次数，默认为3
Route53BindingRetryIntervalMs	服务器应该检查是否和Route53域绑定的时间间隔，默认为5 * 60 * 1000毫秒

配置	描述
PeerEurekaNodesUpdateIntervalMs	集群里eureka节点的变化信息更新的时间间隔，单位为毫秒，默认为10 * 60 * 1000
PeerNodeConnectTimeoutMs	连接对等节点服务器复制的超时的时间，单位为毫秒，默认为200
PeerNodeReadTimeoutMs	读取对等节点服务器复制的超时的时间，单位为毫秒，默认为200
PeerNodeTotalConnections	获取对等节点上http连接的总数，默认为1000
PeerNodeTotalConnectionsPerHost	获取特定的对等节点上http连接的总数，默认为500
PeerNodeConnectionIdleTimeoutSeconds	http连接被清理之后服务器的空闲时间，默认为30秒
PeerEurekaStatusRefreshTimeIntervalMs	服务器节点的状态信息被更新的时间间隔，单位为毫秒，默认为30 * 1000
PrimeAwsReplicaConnections	对集群中服务器节点的连接是否应该准备，默认为true

配置	描述
MaxIdleThreadInMinutesAgeForStatusReplication	状态复制线程可以保持存活的空闲时间，默认为10分钟
MinThreadsForStatusReplication	被用于状态复制的线程的最小数目，默认为1
MaxThreadsForStatusReplication	被用于状态复制的线程的最大数目，默认为1
MaxElementsInStatusReplicationPool	可允许的状态复制池备份复制事件的最大数量，默认为10000
MaxElementsInPeerReplicationPool	复制池备份复制事件的最大数量，默认为10000
MaxIdleThreadAgeInMinutesForPeerReplication	复制线程可以保持存活的空闲时间，默认为15分钟
MinThreadsForPeerReplication	获取将被用于复制线程的最小数目，默认为5
MaxThreadsForPeerReplication	获取将被用于复制线程的最大数目，默认为20
MaxTimeForReplication	尝试在丢弃复制事件之前进行复制的时间，默认为30000毫秒

配置	描述
LogIdentityHeaders	Eureka服务器是否应该登录clientAuthHeaders，默认为true
ListAutoScalingGroupsRoleName	用来描述从AWS第三账户的自动缩放组中的角色名称，默认为“ListAutoScalingGroups”

配置	描述
NumberOfReplicationRetries	获取集群里服务器尝试复制数据的次数，默认为5
WaitTimeInMsWhenSyncEmpty	在Eureka服务器获取不到集群里对等服务器上的实例时，需要等待的时间，单位为毫秒，默认为1000 * 60 * 5
UseReadOnlyResponseCache	目前采用的是二级缓存策略，一个是读写高速缓存过期策略，另一个没有过期只有只读缓存，默认为true，表示只读缓存
SyncWhenTimestampDiffers	当时间变化实例是否跟着同步，默认为true
GZipContentFromRemoteRegion	Eureka服务器中获取的内容是否在远程地区被压缩，默认为true
JsonCodecName	如果没有设置默认的编解码器将使用全JSON编解码器，获取的是编码器的类名称
XmlCodecName	如果没有设置默认的编解码器将使用xml编解码器，获取的是编码器的类名称

客户端配置（Eureka Client）

Spring Boot读取org.springframework.cloud.netflix.eureka.EurekaClientConfigBean类中的参数，作为EurekaClient的配置

服务客户端的前缀为eureka.client

配置	描述
FetchRegistry	此客户端是否获取eureka服务器注册表上的注册信息，默认为true
RegisterWithEureka	是否在eureka服务器上注册自己的信息以供其他服务发现，默认为true
RegistryFetchIntervalSeconds	从Eureka Server服务器注册表中获取注册信息的时间间隔（s），默认为30秒

配置	描述
AllowRedirects	服务器是否能够重定向客户端请求到备份服务器。 如果设置为false，服务器将直接处理请求，如果设置为true，它可能发送HTTP重定向到客户端。默认为false
AvailabilityZones	获取实例所在的地区下可用性的区域列表，用逗号隔开
BackupRegistryImpl	获取实现了eureka客户端在第一次启动时读取注册表的信息作为回退选项的实现名称
CacheRefreshExecutorThreadPoolSize	执行程序缓存刷新线程池的大小，默认为5
CacheRefreshExecutorExponentialBackOffBound	执行程序指数回退刷新的相关属性，是重试延迟的最大倍数值，默认为10
ClientDataAccept	客户端数据接收
DisableDelta	默认为false
DollarReplacement	eureka服务器序列化/反序列化的信息中获取“$”符号的的替换字符串。默认为“_-”
	DecoderName
EscapeCharReplacement	eureka服务器序列化/反序列化的信息中获取“_”符号的的替换字符串。默认为“__”
Experimental	当尝试新功能迁移过程时，为了避免配置API污染，相应的配置即可投入实验配置部分，默认为null
EncoderName	这是一个短暂的编码器的配置，如果最新的编码器是稳定的，则可以去除，默认为null
EurekaServiceUrlPollIntervalSeconds	询问Eureka服务url信息变化的时间间隔（s），默认为300秒
EurekaServerReadTimeoutSeconds	eureka需要超时读取之前需要等待的时间，默认为8秒
EurekaServerConnectTimeoutSeconds	eureka需要超时连接之前需要等待的时间，默认为5秒
EurekaServerTotalConnections	eureka客户端允许所有eureka服务器连接的总数目，默认是200
EurekaServerTotalConnectionsPerHost	eureka客户端允许eureka服务器主机连接的总数目，默认是50
EurekaServerURLContext	表示eureka注册中心的路径，如果配置为eureka，则为http://x.x.x.x:x/eureka/，在eureka的配置文件中加入此配置表示eureka作为客户端向注册中心注册，从而构成eureka集群。此配置只有在eureka服务器ip地址列表是在DNS中才会用到，默认为null
EurekaServerPort	获取eureka服务器的端口，此配置只有在eureka服务器ip地址列表是在DNS中才会用到。默认为null
EurekaServerDNSName	获取要查询的DNS名称来获得eureka服务器，此配置只有在eureka服务器ip地址列表是在DNS中才会用到。默认为null
EurekaServerServiceUrls	Eureka服务器的连接，默认为http://XXXX:X/eureka/。但是如果采用DNS方式获取服务地址，则不需要配置此设置
EurekaConnectionIdleTimeoutSeconds	Eureka服务的http请求关闭之前其响应的时间，默认为30 秒
FilterOnlyUpInstances	是否获得处于开启状态的实例的应用程序过滤之后的应用程序。默认为true
fetchRegistryForRemoteRegions	eureka服务注册表信息里的以逗号隔开的地区名单，如果不这样返回这些地区名单，则客户端启动将会出错。默认为null
HeartbeatExecutorThreadPoolSize	心跳执行程序线程池的大小。默认为5
HeartbeatExecutorExponentialBackOffBound	心跳执行程序回退相关的属性，是重试延迟的最大倍数值，默认为10
InstanceInfoReplicationIntervalSeconds	复制实例变化信息到Eureka服务器所需要的时间间隔（s），默认为30秒
InitialInstanceInfoReplicationIntervalSeconds	最初复制实例信息到eureka服务器所需的时间（s），默认为40秒
Region	获取实例所在的地区。默认为us-east-1
RegistryRefreshSingleVipAddress	此客户端只对一个单一的VIP注册表的信息感兴趣。默认为null
ProxyHost	获取eureka服务的代理主机，默认为null
ProxyPort	获取eureka服务的代理端口, 默认为null
ProxyUserName	获取eureka服务的代理用户名，默认为null
ProxyPassword	获取eureka服务的代理密码，默认为null
PreferSameZoneEureka	实例是否使用同一zone里的eureka服务器，默认为true，理想状态下，eureka客户端与服务端是在同一zone下
GZipContent	eureka注册表的内容是否被压缩，默认为true，并且是在最好的网络流量下被压缩
UseDnsForFetchingServiceUrls	eureka客户端是否应该使用DNS机制来获取eureka服务器的地址列表，默认为false
LogDeltaDiff	是否记录eureka服务器和客户端之间在注册表的信息方面的差异，默认为false
OnDemandUpdateStatusChange	如果设置为true,客户端的状态更新将会点播更新到远程服务器上，默认为true

实例配置（Instance，公共配置）

Spring Boot读取org.springframework.cloud.netflix.eureka.EurekaInstanceConfigBean类中的参数，作为Eureka实例的配置

服务客户端的前缀为eureka.instance。参数格式，使用方法跟上面一致

配置	描述
HostName	与此实例相关联的主机名，是其他实例可以用来进行请求的准确名称
LeaseRenewalIntervalInSeconds	eureka客户需要多长时间发送心跳给eureka服务器，表明它仍然活着。默认为30 秒
LeaseExpirationDurationInSeconds	Eureka服务器在接收到实例的最后一次发出的心跳后，需要等待多久才可以将此实例删除，默认为90秒
preferIpAddress	以IP地址注册到服务中心，相互注册使用IP地址
Appname	获得在eureka服务上注册的应用程序的名字，默认为unknow
AppGroupName	获得在eureka服务上注册的应用程序组的名字，默认为unknow
ASGName	与此实例相关联 AWS自动缩放组名称。此项配置是在AWS环境专门使用的实例启动，它已被用于流量停用后自动把一个实例退出服务
DataCenterInfo	该实例被部署在数据中心
DefaultAddressResolutionOrder	获取实例的网络地址，默认为[]
IpAddress	获取实例的ip地址
InstanceId	此实例注册到eureka服务端的唯一的实例ID。其组成为${spring.application.name}: ${spring.application.instance_id:${random.value}}
InstanceEnabledOnit	实例注册到eureka服务器时，是否开启通讯，默认为false
NonSecurePort	获取该实例应该接收通信的非安全端口。默认为80
NonSecurePortEnabled	该实例应该接收通信的非安全端口是否启用，默认为true
Namespace	获取用于查找属性的命名空间，默认为eureka
HomePageUrlPath	获取此实例的相关主页URL路径，然后构造出主机名，安全端口等，默认为/
HomePageUrl	获取此实例的绝对主页URL路径，为其他服务提供信息时使用的路径,默认为null
HealthCheckUrlPath	获取此实例的相对健康检查URL路径，默认为/health
HealthCheckUrl	获取此实例的绝对健康检查URL路径,默认为null
SecurePort	获取该实例应该接收通信的安全端口，默认为443
SecurePortEnabled	该实例应该接收通信的安全端口是否启用，默认为false
SecureVirtualHostName	此实例定义的安全虚拟主机名
StatusPageUrlPath	获取此实例状态页的URL路径，然后构造出主机名，安全端口等，默认为/info
StatusPageUrl	获取此实例绝对状态页的URL路径，为其他服务提供信息时来找到这个实例的状态的路径，默认为null
SecureHealthCheckUrl	获取此实例的绝对安全健康检查网页的URL路径，默认为null
MetadataMap	获取与此实例相关联的元数据(key,value)。这个信息被发送到eureka服务器，其他实例可以使用
VirtualHostName	此实例定义的虚拟主机名，其他实例将通过使用虚拟主机名找到该实例