You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
387 lines
20 KiB
387 lines
20 KiB
<!DOCTYPE html> |
|
<html lang="en"> |
|
<head> |
|
<meta charset="UTF-8"> |
|
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> |
|
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
|
<meta name="generator" content="Asciidoctor 1.5.8"> |
|
<title>Common application properties</title> |
|
<link rel="stylesheet" href="css/spring.css"> |
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> |
|
|
|
<style> |
|
.hidden { |
|
display: none; |
|
} |
|
|
|
.switch { |
|
border-width: 1px 1px 0 1px; |
|
border-style: solid; |
|
border-color: #7a2518; |
|
display: inline-block; |
|
} |
|
|
|
.switch--item { |
|
padding: 10px; |
|
background-color: #ffffff; |
|
color: #7a2518; |
|
display: inline-block; |
|
cursor: pointer; |
|
} |
|
|
|
.switch--item:not(:first-child) { |
|
border-width: 0 0 0 1px; |
|
border-style: solid; |
|
border-color: #7a2518; |
|
} |
|
|
|
.switch--item.selected { |
|
background-color: #7a2519; |
|
color: #ffffff; |
|
} |
|
</style> |
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js"></script> |
|
<script type="text/javascript"> |
|
function addBlockSwitches() { |
|
$('.primary').each(function() { |
|
primary = $(this); |
|
createSwitchItem(primary, createBlockSwitch(primary)).item.addClass("selected"); |
|
primary.children('.title').remove(); |
|
}); |
|
$('.secondary').each(function(idx, node) { |
|
secondary = $(node); |
|
primary = findPrimary(secondary); |
|
switchItem = createSwitchItem(secondary, primary.children('.switch')); |
|
switchItem.content.addClass('hidden'); |
|
findPrimary(secondary).append(switchItem.content); |
|
secondary.remove(); |
|
}); |
|
} |
|
|
|
function createBlockSwitch(primary) { |
|
blockSwitch = $('<div class="switch"></div>'); |
|
primary.prepend(blockSwitch); |
|
return blockSwitch; |
|
} |
|
|
|
function findPrimary(secondary) { |
|
candidate = secondary.prev(); |
|
while (!candidate.is('.primary')) { |
|
candidate = candidate.prev(); |
|
} |
|
return candidate; |
|
} |
|
|
|
function createSwitchItem(block, blockSwitch) { |
|
blockName = block.children('.title').text(); |
|
content = block.children('.content').first().append(block.next('.colist')); |
|
item = $('<div class="switch--item">' + blockName + '</div>'); |
|
item.on('click', '', content, function(e) { |
|
$(this).addClass('selected'); |
|
$(this).siblings().removeClass('selected'); |
|
e.data.siblings('.content').addClass('hidden'); |
|
e.data.removeClass('hidden'); |
|
}); |
|
blockSwitch.append(item); |
|
return {'item': item, 'content': content}; |
|
} |
|
|
|
function globalSwitch() { |
|
$('.switch--item').each(function() { |
|
$(this).off('click'); |
|
$(this).on('click', function() { |
|
selectedText = $(this).text() |
|
selectedIndex = $(this).index() |
|
$(".switch--item").filter(function() { return ($(this).text() === selectedText) }).each(function() { |
|
$(this).addClass('selected'); |
|
$(this).siblings().removeClass('selected'); |
|
selectedContent = $(this).parent().siblings(".content").eq(selectedIndex) |
|
selectedContent.removeClass('hidden'); |
|
selectedContent.siblings().addClass('hidden'); |
|
}); |
|
}); |
|
}); |
|
} |
|
|
|
$(addBlockSwitches); |
|
$(globalSwitch); |
|
|
|
</script> |
|
|
|
</head> |
|
<body class="book toc2 toc-left"> |
|
<div id="header"> |
|
<div id="toc" class="toc2"> |
|
<div id="toctitle">Table of Contents</div> |
|
<ul class="sectlevel1"> |
|
<li><a href="#common-application-properties">Appendix A: Common application properties</a></li> |
|
</ul> |
|
</div> |
|
</div> |
|
<div id="content"> |
|
<div class="sect1"> |
|
<h2 id="common-application-properties"><a class="link" href="#common-application-properties">Appendix A: Common application properties</a></h2> |
|
<div class="sectionbody"> |
|
<div class="paragraph"> |
|
<p>Various properties can be specified inside your <code>application.properties</code> file, inside your <code>application.yml</code> file, or as command line switches. |
|
This appendix provides a list of common Spring Cloud Commons properties and references to the underlying classes that consume them.</p> |
|
</div> |
|
<div class="admonitionblock note"> |
|
<table> |
|
<tr> |
|
<td class="icon"> |
|
<i class="fa icon-note" title="Note"></i> |
|
</td> |
|
<td class="content"> |
|
Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. |
|
Also, you can define your own properties. |
|
</td> |
|
</tr> |
|
</table> |
|
</div> |
|
<table class="tableblock frame-all grid-all stretch"> |
|
<colgroup> |
|
<col style="width: 33.3333%;"> |
|
<col style="width: 33.3333%;"> |
|
<col style="width: 33.3334%;"> |
|
</colgroup> |
|
<thead> |
|
<tr> |
|
<th class="tableblock halign-left valign-top">Name</th> |
|
<th class="tableblock halign-left valign-top">Default</th> |
|
<th class="tableblock halign-left valign-top">Description</th> |
|
</tr> |
|
</thead> |
|
<tbody> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.compatibility-verifier.compatible-boot-versions</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Default accepted versions for the Spring Boot dependency. You can set {@code x} for the patch version if you don’t want to specify a concrete value. Example: {@code 3.4.x}</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.compatibility-verifier.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables creation of Spring Cloud compatibility verification.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.config.allow-override</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Flag to indicate that {@link #isOverrideSystemProperties() systemPropertiesOverride} can be used. Set to false to prevent users from changing the default accidentally. Default true.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.config.override-none</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Flag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is true, external properties should take lowest priority and should not override any existing property sources (including local config files). Default false.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.config.override-system-properties</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Flag to indicate that the external properties should override system properties. Default true.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.composite-indicator.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables discovery client composite health indicator.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.health-indicator.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.health-indicator.include-description</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.simple.instances</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.simple.local.instance-id</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The unique identifier or name for the service instance.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.simple.local.metadata</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata for the service instance. Can be used by discovery clients to modify their behaviour per instance, e.g. when load balancing.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.simple.local.service-id</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The identifier or name for the service. Multiple instances might share the same service ID.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.simple.local.uri</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The URI of the service instance. Will be parsed to extract the scheme, host, and port.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.client.simple.order</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.discovery.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables discovery client health indicators.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.features.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables the features endpoint.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.httpclientfactories.apache.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables creation of Apache Http Client factory beans.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.httpclientfactories.ok.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables creation of OK Http Client factory beans.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.hypermedia.refresh.fixed-delay</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.hypermedia.refresh.initial-delay</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">10000</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.inetutils.default-hostname</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">localhost</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The default hostname. Used in case of errors.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.inetutils.default-ip-address</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">127.0.0.1</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The default IP address. Used in case of errors.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.inetutils.ignored-interfaces</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">List of Java regular expressions for network interfaces that will be ignored.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.inetutils.preferred-networks</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">List of Java regular expressions for network addresses that will be preferred.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.inetutils.timeout-seconds</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout, in seconds, for calculating hostname.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.inetutils.use-only-site-local-interfaces</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to use only interfaces with site local addresses. See {@link InetAddress#isSiteLocalAddress()} for more details.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.cache.caffeine.spec</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The spec to use to create caches. See CaffeineSpec for more details on the spec format.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.cache.capacity</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">256</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Initial cache capacity expressed as int.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.cache.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables Spring Cloud LoadBalancer caching mechanism.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.cache.ttl</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">35s</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Time To Live - time counted from writing of the record, after which cache entries are expired, expressed as a {@link Duration}. The property {@link String} has to be in keeping with the appropriate syntax as specified in Spring Boot <code>StringToDurationConverter</code>. @see <a href= "https://github.com/spring-projects/spring-boot/blob/master/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/StringToDurationConverter.java">StringToDurationConverter.java</a></p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.health-check.initial-delay</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Initial delay value for the HealthCheck scheduler.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.health-check.interval</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">25s</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Interval for rerunning the HealthCheck scheduler.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.health-check.path</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.retry.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.ribbon.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Causes <code>RibbonLoadBalancerClient</code> to be used by default.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.service-discovery.timeout</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">String representation of Duration of the timeout for calls to service discovery.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.loadbalancer.zone</p></td> |
|
<td class="tableblock halign-left valign-top"></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Spring Cloud LoadBalancer zone.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.refresh.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables autoconfiguration for the refresh scope and associated features.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.refresh.extra-refreshable</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Additional class names for beans to post process into refresh scope.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.refresh.never-refreshable</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Comma separated list of class names for beans to never be refreshed or rebound.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.service-registry.auto-registration.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Whether service auto-registration is enabled. Defaults to true.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.service-registry.auto-registration.fail-fast</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Whether startup fails if there is no AutoServiceRegistration. Defaults to false.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.service-registry.auto-registration.register-management</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to register the management as a service. Defaults to true.</p></td> |
|
</tr> |
|
<tr> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.util.enabled</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td> |
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables creation of Spring Cloud utility beans.</p></td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
</div> |
|
</div> |
|
</div> |
|
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script> |
|
<script type="text/javascript" src="js/toc.js"></script> |
|
<link rel="stylesheet" href="js/highlight/styles/github.min.css"> |
|
<script src="js/highlight/highlight.min.js"></script> |
|
<script>hljs.initHighlighting()</script> |
|
</body> |
|
</html> |