public interface EurekaServerConfig
Most of the required information is provided by the default configuration
DefaultEurekaServerConfig.
Note that all configurations are not effective at runtime unless and
otherwise specified.
| Modifier and Type | Method and Description |
|---|---|
boolean |
disableTransparentFallbackToOtherRegion()
Old behavior of fallback to applications in the remote region (if configured) if there are no instances of that
application in the local region, will be disabled.
|
int |
getASGQueryTimeoutMs()
Get the timeout value for querying the AWS for ASG
information.
|
long |
getASGUpdateIntervalMs()
Get the time interval with which the ASG information must be
queried from AWS.
|
java.lang.String |
getAWSAccessId()
Gets the AWS Access Id.
|
java.lang.String |
getAWSSecretKey()
Gets the AWS Secret Key.
|
long |
getDeltaRetentionTimerIntervalInMs()
Get the time interval with which the clean up task should wake up and
check for expired delta information.
|
int |
getEIPBindingRetryIntervalMs()
Gets the interval with which the server should check if the EIP is bound
and should try to bind in the case if it is already not bound.
|
int |
getEIPBindRebindRetries()
Gets the number of times the server should try to bind to the candidate
EIP.
|
long |
getEvictionIntervalTimerInMs()
Get the time interval with which the task that expires instances should
wake up and run.
|
int |
getMaxElementsInPeerReplicationPool()
Get the maximum number of replication events that can be allowed to back
up in the replication pool.
|
int |
getMaxElementsInStatusReplicationPool()
Get the maximum number of replication events that can be allowed to back
up in the status replication pool.
|
long |
getMaxIdleThreadAgeInMinutesForPeerReplication()
Get the idle time for which the replication threads can stay alive.
|
long |
getMaxIdleThreadInMinutesAgeForStatusReplication()
Get the idle time for which the status replication threads can stay
alive.
|
int |
getMaxThreadsForPeerReplication()
Get the maximum number of threads to be used for replication.
|
int |
getMaxThreadsForStatusReplication()
Get the maximum number of threads to be used for status replication.
|
int |
getMaxTimeForReplication()
Get the time in milliseconds to try to replicate before dropping
replication events.
|
int |
getMinThreadsForPeerReplication()
Get the minimum number of threads to be used for replication.
|
int |
getMinThreadsForStatusReplication()
Get the minimum number of threads to be used for status replication.
|
int |
getNumberOfReplicationRetries()
Get the number of times the replication events should be retried with
peers.
|
int |
getPeerEurekaNodesUpdateIntervalMs()
The interval with which the information about the changes in peer eureka
nodes is updated.
|
int |
getPeerEurekaStatusRefreshTimeIntervalMs()
Gets the interval with which the status information about peer nodes is
updated.
|
int |
getPeerNodeConnectionIdleTimeoutSeconds()
Gets the idle time after which the HTTP connection should be
cleaned up.
|
int |
getPeerNodeConnectTimeoutMs()
Gets the timeout value for connecting to peer eureka nodes for
replication.
|
int |
getPeerNodeReadTimeoutMs()
Gets the timeout value for reading information from peer eureka nodes for
replication.
|
int |
getPeerNodeTotalConnections()
Gets the total number of HTTP connections allowed to peer eureka
nodes for replication.
|
int |
getPeerNodeTotalConnectionsPerHost()
Gets the total number of HTTP connections allowed to a
particular peer eureka node for replication.
|
int |
getRateLimiterBurstSize()
Rate limiter, token bucket algorithm property.
|
int |
getRateLimiterFullFetchAverageRate()
Rate limiter, token bucket algorithm property.
|
java.util.Set<java.lang.String> |
getRateLimiterPrivilegedClients()
A list of certified clients.
|
int |
getRateLimiterRegistryFetchAverageRate()
Rate limiter, token bucket algorithm property.
|
int |
getRegistrySyncRetries()
Get the number of times that a eureka node would try to get the registry
information from the peers during startup.
|
java.util.Set<java.lang.String> |
getRemoteRegionAppWhitelist(java.lang.String regionName)
Returns a list of applications that must be retrieved from the passed remote region.
|
int |
getRemoteRegionConnectionIdleTimeoutSeconds()
Gets the idle time after which the HTTP connection should be
cleaned up for remote regions.
|
int |
getRemoteRegionConnectTimeoutMs()
Gets the timeout value for connecting to peer eureka nodes for remote
regions.
|
int |
getRemoteRegionFetchThreadPoolSize()
Size of a thread pool used to execute remote region registry fetch requests.
|
int |
getRemoteRegionReadTimeoutMs()
Gets the timeout value for reading information from peer eureka nodes for
remote regions.
|
int |
getRemoteRegionRegistryFetchInterval()
Get the time interval for which the registry information need to be fetched from the remote region.
|
int |
getRemoteRegionTotalConnections()
Gets the total number of HTTP connections allowed to peer eureka
nodes for remote regions.
|
int |
getRemoteRegionTotalConnectionsPerHost()
Gets the total number of HTTP connections allowed to a
particular peer eureka node for remote regions.
|
java.lang.String |
getRemoteRegionTrustStore()
Gets the fully qualified trust store file that will be used for remote region registry fetches.
|
java.lang.String |
getRemoteRegionTrustStorePassword()
Get the remote region trust store's password.
|
java.lang.String[] |
getRemoteRegionUrls()
Deprecated.
|
java.util.Map<java.lang.String,java.lang.String> |
getRemoteRegionUrlsWithName()
Get a map of region name against remote region discovery url.
|
double |
getRenewalPercentThreshold()
The minimum percentage of renewals that is expected from the clients in
the period specified by
getRenewalThresholdUpdateIntervalMs(). |
int |
getRenewalThresholdUpdateIntervalMs()
The interval with which the threshold as specified in
getRenewalPercentThreshold() needs to be updated. |
long |
getResponseCacheAutoExpirationInSeconds()
Gets the time for which the registry payload should be kept in the cache
if it is not invalidated by change events.
|
long |
getResponseCacheUpdateIntervalMs()
Gets the time interval with which the payload cache of the client should
be updated.
|
long |
getRetentionTimeInMSInDeltaQueue()
Get the time for which the delta information should be cached for the
clients to retrieve the value without missing it.
|
int |
getWaitTimeInMsWhenSyncEmpty()
Gets the time to wait when the eureka server starts up unable to get
instances from peer nodes.
|
boolean |
isRateLimiterEnabled()
Indicates whether the rate limiter should be enabled or disabled.
|
boolean |
isRateLimiterThrottleStandardClients()
Indicate if rate limit standard clients.
|
boolean |
shouldBatchReplication()
Indicates whether the replication between cluster nodes should be batched for network efficiency.
|
boolean |
shouldDisableDelta()
Checks to see if the delta information can be served to client or not.
|
boolean |
shouldDisableDeltaForRemoteRegions()
Checks to see if the delta information can be served to client or not for
remote regions.
|
boolean |
shouldEnableSelfPreservation()
Checks to see if the eureka server is enabled for self preservation.
|
boolean |
shouldGZipContentFromRemoteRegion()
Indicates whether the content fetched from eureka server has to be
compressed for remote regions whenever it is supported by the server.
|
boolean |
shouldLogIdentityHeaders()
Indicates whether the eureka server should log/metric clientAuthHeaders
|
boolean |
shouldPrimeAwsReplicaConnections()
Checks whether the connections to replicas should be primed.
|
boolean |
shouldSyncWhenTimestampDiffers()
Checks whether to synchronize instances when timestamp differs.
|
java.lang.String getAWSAccessId()
java.lang.String getAWSSecretKey()
int getEIPBindRebindRetries()
The changes are effective at runtime.
int getEIPBindingRetryIntervalMs()
The changes are effective at runtime.
boolean shouldEnableSelfPreservation()
When enabled, the server keeps track of the number of renewals
it should receive from the server. Any time, the number of renewals drops
below the threshold percentage as defined by
getRenewalPercentThreshold(), the server turns off expirations
to avert danger.This will help the server in maintaining the registry
information in case of network problems between client and the server.
The changes are effective at runtime.
double getRenewalPercentThreshold()
getRenewalThresholdUpdateIntervalMs().
If the renewals drop below the threshold, the expirations are disabled if
the shouldEnableSelfPreservation() is enabled.
The changes are effective at runtime.
85% will be specified as 0.85.int getRenewalThresholdUpdateIntervalMs()
getRenewalPercentThreshold() needs to be updated.int getPeerEurekaNodesUpdateIntervalMs()
The changes are effective at runtime.
int getNumberOfReplicationRetries()
The changes are effective at runtime.
int getPeerEurekaStatusRefreshTimeIntervalMs()
The changes are effective at runtime.
int getWaitTimeInMsWhenSyncEmpty()
int getPeerNodeConnectTimeoutMs()
int getPeerNodeReadTimeoutMs()
int getPeerNodeTotalConnections()
int getPeerNodeTotalConnectionsPerHost()
int getPeerNodeConnectionIdleTimeoutSeconds()
long getRetentionTimeInMSInDeltaQueue()
long getDeltaRetentionTimerIntervalInMs()
long getEvictionIntervalTimerInMs()
int getASGQueryTimeoutMs()
long getASGUpdateIntervalMs()
long getResponseCacheAutoExpirationInSeconds()
long getResponseCacheUpdateIntervalMs()
boolean shouldDisableDelta()
The changes are effective at runtime.
long getMaxIdleThreadInMinutesAgeForStatusReplication()
int getMinThreadsForStatusReplication()
int getMaxThreadsForStatusReplication()
int getMaxElementsInStatusReplicationPool()
Depending on the memory allowed, timeout and the replication traffic, this value can vary.
boolean shouldSyncWhenTimestampDiffers()
The changes are effective at runtime.
int getRegistrySyncRetries()
int getMaxElementsInPeerReplicationPool()
Depending on the memory allowed, timeout and the replication traffic, this value can vary.
long getMaxIdleThreadAgeInMinutesForPeerReplication()
int getMinThreadsForPeerReplication()
int getMaxThreadsForPeerReplication()
int getMaxTimeForReplication()
boolean shouldPrimeAwsReplicaConnections()
boolean shouldDisableDeltaForRemoteRegions()
The changes are effective at runtime.
int getRemoteRegionConnectTimeoutMs()
int getRemoteRegionReadTimeoutMs()
int getRemoteRegionTotalConnections()
int getRemoteRegionTotalConnectionsPerHost()
int getRemoteRegionConnectionIdleTimeoutSeconds()
boolean shouldGZipContentFromRemoteRegion()
java.util.Map<java.lang.String,java.lang.String> getRemoteRegionUrlsWithName()
java.lang.String[] getRemoteRegionUrls()
getRemoteRegionUrlsWithName()URLs.@Nullable
java.util.Set<java.lang.String> getRemoteRegionAppWhitelist(@Nullable
java.lang.String regionName)
null which means that no filtering should be applied on the applications
for this region i.e. all applications must be returned. null to this method.regionName - Name of the region for which the application whitelist is to be retrieved. If null a global
setting is returned.null all
applications must be retrieved.int getRemoteRegionRegistryFetchInterval()
int getRemoteRegionFetchThreadPoolSize()
java.lang.String getRemoteRegionTrustStore()
java.lang.String getRemoteRegionTrustStorePassword()
boolean disableTransparentFallbackToOtherRegion()
true if the old behavior is to be disabled.boolean shouldBatchReplication()
true if the replication needs to be batched.boolean shouldLogIdentityHeaders()
true if the clientAuthHeaders should be logged and/or emitted as metricsboolean isRateLimiterEnabled()
boolean isRateLimiterThrottleStandardClients()
java.util.Set<java.lang.String> getRateLimiterPrivilegedClients()
int getRateLimiterBurstSize()
getRateLimiterRegistryFetchAverageRate()
and getRateLimiterFullFetchAverageRate().int getRateLimiterRegistryFetchAverageRate()
getRateLimiterBurstSize().int getRateLimiterFullFetchAverageRate()
getRateLimiterBurstSize().