Eureka配置信息详解

墨蓝 2022-05-05 08:00 183阅读 0赞

#### Eureka包含四部分配置 ####

1.  **instance : 当前Eureka Instance实例配置信息**
2.  **client : Eureka Client客户端特性配置**
3.  **server : Eureka Server注册中心特性配置**
4.  **dashboard : Eureka Server注册中心仪表盘配置**

### Eureka Instance 实例信息配置 ###

> Eureka Instance的配置信息全部保存在`org.springframework.cloud.netflix.eureka.EurekaInstanceConfigBean`配置类中，实际上它是`com.netflix.appinfo.EurekaInstanceConfig`的实现类，替代了`netflix`的`com.netflix.appinfo.CloudInstanceConfig`的默认实现。

> Eureka Instance的配置信息全部以`eureka.instance.xxx`的格式配置。

**配置列表：**

<table> 
 <thead> 
  <tr> 
   <th align="left">配置属性</th> 
   <th align="right">解释</th> 
   <th align="center">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">appname</td> 
   <td align="right">应用名，首先获取<code>spring.application.name</code>的值，如果取值为空，则取默认unknown</td> 
   <td align="center"><code>unknown</code></td> 
  </tr> 
  <tr> 
   <td align="left">appGroupName</td> 
   <td align="right">应用组名</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">instanceEnabledOnit</td> 
   <td align="right">实例注册到Eureka上是，是否立刻开启通讯。有时候应用在准备好服务之前需要一些预处理</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left">nonSecurePort</td> 
   <td align="right">非安全的端口</td> 
   <td align="center"><code>80</code></td> 
  </tr> 
  <tr> 
   <td align="left">securePort</td> 
   <td align="right">安全的端口</td> 
   <td align="center"><code>443</code></td> 
  </tr> 
  <tr> 
   <td align="left">nonSecurePortEnabled</td> 
   <td align="right">是否开启非安全端口通讯</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">securePortEnabled</td> 
   <td align="right">是否开启安全端口通讯</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left">leaseRenewalIntervalInSeconds</td> 
   <td align="right">实例续约间隔时间(s)</td> 
   <td align="center"><code>30</code></td> 
  </tr> 
  <tr> 
   <td align="left">leaseExpirationDurationInSeconds</td> 
   <td align="right">实例超时时间，表示最大leaseExpirationDurationInSeconds秒后没有续约，Server就认为他不可用了，随之就会将其剔除(s)</td> 
   <td align="center"><code>90</code></td> 
  </tr> 
  <tr> 
   <td align="left">virtualHostName</td> 
   <td align="right">虚拟主机名，首先获取<code>spring.application.name</code>的值，如果取值为空，则取默认unknown。</td> 
   <td align="center"><code>unknown</code></td> 
  </tr> 
  <tr> 
   <td align="left">instanceId</td> 
   <td align="right">注册到eureka上的唯一实例ID，不能与相同appname的其他实例重复</td> 
   <td align="center"></td> 
  </tr> 
  <tr> 
   <td align="left">secureVirtualHostName</td> 
   <td align="right">安全虚拟主机名，首先获取<code>spring.application.name</code>的值，如果取值为空，则取默认unknown</td> 
   <td align="center"><code>unknown</code></td> 
  </tr> 
  <tr> 
   <td align="left">metadataMap</td> 
   <td align="right">实例元数据，可以供其他实例使用。比如spring-boot-admin在监控时，获取实例的上下文和端口</td> 
   <td align="center"><code>HashMap</code></td> 
  </tr> 
  <tr> 
   <td align="left">dataCenterInfo</td> 
   <td align="right">实例部署的数据中心。如AWS、MyOwn</td> 
   <td align="center"><code>new MyDataCenterInfo(DataCenterInfo.Name.MyOwn)</code></td> 
  </tr> 
  <tr> 
   <td align="left">ipAddress</td> 
   <td align="right">实例的IP地址</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">statusPageUrlPath</td> 
   <td align="right">实例状态页相对url</td> 
   <td align="center"><code>"/actuator/info"</code></td> 
  </tr> 
  <tr> 
   <td align="left">statusPageUrl</td> 
   <td align="right">实例状态页绝对url</td> 
   <td align="center"><code>url</code></td> 
  </tr> 
  <tr> 
   <td align="left">homePageUrlPath</td> 
   <td align="right">实例主页相对URL</td> 
   <td align="center"><code>/</code></td> 
  </tr> 
  <tr> 
   <td align="left">healthCheckUrlUrlPath</td> 
   <td align="right">实例健康检查相对URL</td> 
   <td align="center"><code>"/actuator/health"</code></td> 
  </tr> 
  <tr> 
   <td align="left">healthCheckUrl</td> 
   <td align="right">实例健康检查绝对URL</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">secureHealthCheckUrl</td> 
   <td align="right">实例安全的健康检查绝对URL</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">namespace</td> 
   <td align="right">配置属性的命名空间（Spring Cloud中被忽略）</td> 
   <td align="center"><code>"eureka"</code></td> 
  </tr> 
  <tr> 
   <td align="left">hostname</td> 
   <td align="right">主机名,不配置的时候讲根据操作系统的主机名来获取</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">preferIpAddress</td> 
   <td align="right">是否优先使用IP地址作为主机名的标识</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
 </tbody> 
</table>

--------------------

### Eureka Client客户端特性配置 ###

> Eureka Client客户端特性配置是对作为Eureka客户端的特性配置，包括Eureka注册中心，本身也是一个Eureka Client。Eureka Client特性配置全部在`org.springframework.cloud.netflix.eureka.EurekaClientConfigBean`中，实际上它是`com.netflix.discovery.EurekaClientConfig`的实现类，替代了netxflix的默认实现

> Eureka Client客户端特性配置全部以`eureka.client.xxx`的格式配置。

**配置列表:**

<table> 
 <thead> 
  <tr> 
   <th align="left">配置属性</th> 
   <th align="right">解释</th> 
   <th align="center">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">enabled</td> 
   <td align="right">是否启用Eureka client</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">registryFetchIntervalSeconds</td> 
   <td align="right">定时从Eureka Server拉取服务注册信息的间隔时间(s)</td> 
   <td align="center"><code>30</code></td> 
  </tr> 
  <tr> 
   <td align="left">instanceInfoReplicationIntervalSeconds</td> 
   <td align="right">定时将实例信息（如果变化了）复制到Eureka Server的间隔时间。（InstanceInfoReplicator线程）</td> 
   <td align="center"><code>30</code></td> 
  </tr> 
  <tr> 
   <td align="left">initialInstanceInfoReplicationIntervalSeconds</td> 
   <td align="right">首次将实例信息复制到Eureka Server的延迟时间。（InstanceInfoReplicator线程）</td> 
   <td align="center"><code>40</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServiceUrlPollIntervalSeconds</td> 
   <td align="right">拉取Eureka Server地址的间隔时间（Eureka Server有可能增减）</td> 
   <td align="center"><code>300</code></td> 
  </tr> 
  <tr> 
   <td align="left">proxyPort</td> 
   <td align="right">Eureka Server的代理端口</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">proxyHost</td> 
   <td align="right">Eureka Server的代理主机名</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">proxyUserName</td> 
   <td align="right">Eureka Server的代理用户名</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">proxyPassword</td> 
   <td align="right">Eureka Server的代理密码</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServerReadTimeoutSeconds</td> 
   <td align="right">从Eureka Server读取信息的超时时间(s)</td> 
   <td align="center"><code>8</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServerConnectTimeoutSeconds</td> 
   <td align="right">连接Eureka Server的超时时间</td> 
   <td align="center"><code>5</code></td> 
  </tr> 
  <tr> 
   <td align="left">backupRegistryImpl</td> 
   <td align="right">Eureka Client第一次启动时获取服务注册信息的调用的回溯实现。Eureka Client启动时首次会检查有没有BackupRegistry的实现类，如果有实现类，则优先从这个实现类里获取服务注册信息</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServerTotalConnections</td> 
   <td align="right">Eureka client连接Eureka Server的链接总数</td> 
   <td align="center"><code>200</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServerTotalConnectionsPerHost</td> 
   <td align="right">Eureka client连接单台Eureka Server的链接总数</td> 
   <td align="center"><code>50</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServerURLContext</td> 
   <td align="right">当Eureka server的列表在DNS中时，Eureka Server的上下文路径。如http://xxxx/eureka</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServerPort</td> 
   <td align="right">当Eureka server的列表在DNS中时，Eureka Server的端口</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaServerDNSName</td> 
   <td align="right">当Eureka server的列表在DNS中时，且要通过DNSName获取Eureka Server列表时，DNS名字</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">region</td> 
   <td align="right">实例所属区域</td> 
   <td align="center"><code>us-east-1</code></td> 
  </tr> 
  <tr> 
   <td align="left">eurekaConnectionIdleTimeoutSeconds</td> 
   <td align="right">Eureka Client和Eureka Server之间的Http连接的空闲超时时间</td> 
   <td align="center"><code>30</code></td> 
  </tr> 
  <tr> 
   <td align="left">heartbeatExecutorThreadPoolSize</td> 
   <td align="right">心跳（续约）执行器线程池大小</td> 
   <td align="center"><code>2</code></td> 
  </tr> 
  <tr> 
   <td align="left">heartbeatExecutorExponentialBackOffBound</td> 
   <td align="right">心跳执行器在续约过程中超时后的再次执行续约的最大延迟倍数。默认最大延迟时间=<code>10 * eureka.instance.leaseRenewalIntervalInSeconds</code></td> 
   <td align="center"><code>10</code></td> 
  </tr> 
  <tr> 
   <td align="left">cacheRefreshExecutorThreadPoolSize</td> 
   <td align="right">cacheRefreshExecutord的线程池大小（获取注册信息）</td> 
   <td align="center"><code>2</code></td> 
  </tr> 
  <tr> 
   <td align="left">cacheRefreshExecutorExponentialBackOffBound</td> 
   <td align="right">cacheRefreshExecutord的再次执行的最大延迟倍数。默认最大延迟时间=<code>10 *eureka.client.registryFetchIntervalSeconds</code></td> 
   <td align="center"><code>10</code></td> 
  </tr> 
  <tr> 
   <td align="left">serviceUrl</td> 
   <td align="right">Eureka Server的分区地址。默认添加了一个defualtZone。也就是最常用的配置<code>eureka.client.service-url.defaultZone=xxx</code></td> 
   <td align="center"><code>new HashMap();serviceUrl.put(DEFAULT_ZONE, DEFAULT_URL)</code></td> 
  </tr> 
  <tr> 
   <td align="left">registerWithEureka</td> 
   <td align="right">是否注册到Eureka Server</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">preferSameZoneEureka</td> 
   <td align="right">是否使用相同Zone下的Eureka server</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">logDeltaDiff</td> 
   <td align="right">是否记录Eureka Server和Eureka Client之间注册信息的差异</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left">disableDelta</td> 
   <td align="right">是否开启增量同步注册信息</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left">fetchRemoteRegionsRegistry</td> 
   <td align="right">获取注册服务的远程地区，以逗号隔开</td> 
   <td align="center"><code>null</code></td> 
  </tr> 
  <tr> 
   <td align="left">availabilityZones</td> 
   <td align="right">可用分区列表。用逗号隔开</td> 
   <td align="center"><code>HashMap</code></td> 
  </tr> 
  <tr> 
   <td align="left">filterOnlyUpInstances</td> 
   <td align="right">是否只拉取UP状态的实例</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">fetchRegistry</td> 
   <td align="right">是否拉取注册信息</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">shouldUnregisterOnShutdown</td> 
   <td align="right">是否在停止服务的时候向Eureka Server发起Cancel指令</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">shouldEnforceRegistrationAtInit</td> 
   <td align="right">是否在初始化过程中注册服务</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
 </tbody> 
</table>

--------------------

### Eureka Server注册中心端配置 ###

> Eureka Server注册中心端的配置是对注册中心的特性配置。Eureka Server的配置全部在`org.springframework.cloud.netflix.eureka.server.EurekaServerConfigBean`里，实际上它是`com.netflix.eureka.EurekaServerConfig`的实现类，替代了netflix的默认实现

> Eureka Server的配置全部以`eureka.server.xxx`的格式进行配置

**配置列表：**

<table> 
 <thead> 
  <tr> 
   <th align="left">配置属性</th> 
   <th align="right">解释</th> 
   <th align="center">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">enableSelfPreservation</td> 
   <td align="right">是否开启自我保护</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">renewalPercentThreshold</td> 
   <td align="right">自我保护续约百分比阀值因子。如果实际续约数小于续约数阀值，则开启自我保护</td> 
   <td align="center"><code>0.85</code></td> 
  </tr> 
  <tr> 
   <td align="left">renewalThresholdUpdateIntervalMs</td> 
   <td align="right">续约数阀值更新频率</td> 
   <td align="center"><code>15 * 60 * 1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">peerEurekaNodesUpdateIntervalMs</td> 
   <td align="right">Eureka Server节点更新频率</td> 
   <td align="center"><code>10 * 60 * 1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">enableReplicatedRequestCompression</td> 
   <td align="right">是否启用复制请求压缩</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left">waitTimeInMsWhenSyncEmpty</td> 
   <td align="right">当从其他节点同步实例信息为空时等待的时间</td> 
   <td align="center"><code>5 * 60 * 1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">peerNodeConnectTimeoutMs</td> 
   <td align="right">节点间连接的超时时间</td> 
   <td align="center"><code>200</code></td> 
  </tr> 
  <tr> 
   <td align="left">peerNodeReadTimeoutMs</td> 
   <td align="right">节点间读取信息的超时时间</td> 
   <td align="center"><code>200</code></td> 
  </tr> 
  <tr> 
   <td align="left">peerNodeTotalConnectionsPerHost</td> 
   <td align="right">单个节点间连接总数</td> 
   <td align="center"><code>500</code></td> 
  </tr> 
  <tr> 
   <td align="left">peerNodeConnectionIdleTimeoutSeconds</td> 
   <td align="right">节点间连接空闲超时时间</td> 
   <td align="center"><code>30</code></td> 
  </tr> 
  <tr> 
   <td align="left">retentionTimeInMSInDeltaQueue</td> 
   <td align="right">增量队列的缓存时间</td> 
   <td align="center"><code>3 * MINUTES</code></td> 
  </tr> 
  <tr> 
   <td align="left">deltaRetentionTimerIntervalInMs</td> 
   <td align="right">清理增量队列中过期的频率</td> 
   <td align="center"><code>30 * 1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">evictionIntervalTimerInMs</td> 
   <td align="right">剔除任务频率</td> 
   <td align="center"><code>60*1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">responseCacheAutoExpirationInSeconds</td> 
   <td align="right">注册列表缓存超时时间（当注册列表没有变化时）</td> 
   <td align="center"><code>180</code></td> 
  </tr> 
  <tr> 
   <td align="left">responseCacheUpdateIntervalMs</td> 
   <td align="right">注册列表缓存更新频率</td> 
   <td align="center"><code>30 * 1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">useReadOnlyResponseCache</td> 
   <td align="right">是否开启注册列表的二级缓存</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">disableDelta</td> 
   <td align="right">是否为client提供增量信息</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left">maxThreadsForStatusReplication</td> 
   <td align="right">状态同步的最大线程数</td> 
   <td align="center"><code>1</code></td> 
  </tr> 
  <tr> 
   <td align="left">maxElementsInStatusReplicationPool</td> 
   <td align="right">状态同步队列的最大容量</td> 
   <td align="center"><code>10000</code></td> 
  </tr> 
  <tr> 
   <td align="left">syncWhenTimestampDiffers</td> 
   <td align="right">当时间差异时是否同步</td> 
   <td align="center"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left">registrySyncRetries</td> 
   <td align="right">注册信息同步重试次数</td> 
   <td align="center"><code>0</code></td> 
  </tr> 
  <tr> 
   <td align="left">registrySyncRetryWaitMs</td> 
   <td align="right">注册信息同步重试期间的时间间隔</td> 
   <td align="center"><code>30 * 1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">maxElementsInPeerReplicationPool</td> 
   <td align="right">节点间同步事件的最大容量</td> 
   <td align="center"><code>10000</code></td> 
  </tr> 
  <tr> 
   <td align="left">minThreadsForPeerReplication</td> 
   <td align="right">节点间同步的最小线程数</td> 
   <td align="center"><code>5</code></td> 
  </tr> 
  <tr> 
   <td align="left">maxThreadsForPeerReplication</td> 
   <td align="right">节点间同步的最大线程数</td> 
   <td align="center"><code>20</code></td> 
  </tr> 
  <tr> 
   <td align="left">maxTimeForReplication</td> 
   <td align="right">节点间同步的最大时间，单位为毫秒</td> 
   <td align="center"><code>30000</code></td> 
  </tr> 
  <tr> 
   <td align="left">disableDeltaForRemoteRegions</td> 
   <td align="right">是否启用远程区域增量</td> 
   <td align="center"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left">remoteRegionConnectTimeoutMs</td> 
   <td align="right">远程区域连接超时时间</td> 
   <td align="center"><code>1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">remoteRegionReadTimeoutMs</td> 
   <td align="right">远程区域读取超时时间</td> 
   <td align="center"><code>1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">remoteRegionTotalConnections</td> 
   <td align="right">远程区域最大连接数</td> 
   <td align="center"><code>1000</code></td> 
  </tr> 
  <tr> 
   <td align="left">remoteRegionTotalConnectionsPerHost</td> 
   <td align="right">远程区域单机连接数</td> 
   <td align="center"><code>500</code></td> 
  </tr> 
  <tr> 
   <td align="left">remoteRegionConnectionIdleTimeoutSeconds</td> 
   <td align="right">远程区域连接空闲超时时间</td> 
   <td align="center"><code>30</code></td> 
  </tr> 
  <tr> 
   <td align="left">remoteRegionRegistryFetchInterval</td> 
   <td align="right">远程区域注册信息拉取频率</td> 
   <td align="center"><code>30</code></td> 
  </tr> 
  <tr> 
   <td align="left">remoteRegionFetchThreadPoolSize</td> 
   <td align="right">远程区域注册信息线程数</td> 
   <td align="center"><code>20</code></td> 
  </tr> 
 </tbody> 
</table>

--------------------

### Eureka Server注册中心仪表盘配置 ###

> 注册中心仪表盘的配置主要是控制注册中心的可视化展示。以`eureka.dashboard.xxx`的格式配置

**配置列表：**

<table> 
 <thead> 
  <tr> 
   <th align="left">配置属性</th> 
   <th align="right">解释</th> 
   <th align="center">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">path</td> 
   <td align="right">仪表盘访问路径</td> 
   <td align="center"><code>/</code></td> 
  </tr> 
  <tr> 
   <td align="left">enabled</td> 
   <td align="right">是否启用仪表盘</td> 
   <td align="center">``</td> 
  </tr> 
 </tbody> 
</table>

#### 参考 ####

[Eureka配置列表][Eureka]

[Eureka]: http://www.majunwei.com/view/201808130827002632.html