Part XV. Appendix: Compendium of Configuration Properties

NameDefaultDescription
archaius.propagate.environmentChangedEventtruePropagates EnvironmentChanged events to Archaius ConfigurationManager.
encrypt.fail-on-errortrueFlag to say that a process should fail if there is an encryption or decryption error.
encrypt.key A symmetric key. As a stronger alternative consider using a keystore.
encrypt.key-store.alias Alias for a key in the store.
encrypt.key-store.location Location of the key store file, e.g. classpath:/keystore.jks.
encrypt.key-store.password Password that locks the keystore.
encrypt.key-store.secret Secret protecting the key (defaults to the same as the password).
encrypt.rsa.algorithm The RSA algorithm to use (DEFAULT or OEAP). Once it is set do not change it (or existing ciphers will not a decryptable).
encrypt.rsa.saltdeadbeefSalt for the random secret used to encrypt cipher text. Once it is set do not change it (or existing ciphers will not a decryptable).
encrypt.rsa.strongfalseFlag to indicate that "strong" AES encryption should be used internally. If true then the GCM algorithm is applied to the AES encrypted bytes. Default is false (in which case "standard" CBC is used instead). Once it is set do not change it (or existing ciphers will not a decryptable).
endpoints.bus.enabled
endpoints.bus.id
endpoints.bus.sensitive
endpoints.consul.enabled
endpoints.consul.id
endpoints.consul.sensitive
endpoints.env.post.enabledtrueEnable changing the Environment through a POST to /env.
endpoints.features.enabled
endpoints.features.id
endpoints.features.sensitive
endpoints.pause.enabledtrueEnable the /pause endpoint (to send Lifecycle.stop()).
endpoints.pause.id
endpoints.pause.sensitive
endpoints.refresh.enabledtrueEnable the /refresh endpoint to refresh configuration and re-initialize refresh scoped beans.
endpoints.refresh.id
endpoints.refresh.sensitive
endpoints.restart.enabledtrueEnable the /restart endpoint to restart the application context.
endpoints.restart.id
endpoints.restart.pause-endpoint.enabled
endpoints.restart.pause-endpoint.id
endpoints.restart.pause-endpoint.sensitive
endpoints.restart.resume-endpoint.enabled
endpoints.restart.resume-endpoint.id
endpoints.restart.resume-endpoint.sensitive
endpoints.restart.sensitive
endpoints.restart.timeout0
endpoints.resume.enabledtrueEnable the /resume endpoint (to send Lifecycle.start()).
endpoints.resume.id
endpoints.resume.sensitive
endpoints.routes.enabled
endpoints.routes.id
endpoints.routes.sensitive
endpoints.zookeeper.enabledtrueEnable the /zookeeper endpoint to inspect the state of zookeeper.
eureka.client.allow-redirectsfalseIndicates whether server can redirect a client request to a backup server/cluster. If set to false, the server will handle the request directly, If set to true, it may send HTTP redirect to the client, with a new server location.
eureka.client.availability-zones Gets the list of availability zones (used in AWS data centers) for the region in which this instance resides. The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSeconds.
eureka.client.backup-registry-impl Gets the name of the implementation which implements BackupRegistry to fetch the registry information as a fall back option for only the first time when the eureka client starts. This may be needed for applications which needs additional resiliency for registry information without which it cannot operate.
eureka.client.cache-refresh-executor-exponential-back-off-bound10Cache refresh executor exponential back off related property. It is a maximum multiplier value for retry delay, in case where a sequence of timeouts occurred.
eureka.client.cache-refresh-executor-thread-pool-size2The thread pool size for the cacheRefreshExecutor to initialise with
eureka.client.client-data-accept EurekaAccept name for client data accept
eureka.client.decoder-name This is a transient config and once the latest codecs are stable, can be removed (as there will only be one)
eureka.client.disable-deltafalseIndicates whether the eureka client should disable fetching of delta and should rather resort to getting the full registry information. Note that the delta fetches can reduce the traffic tremendously, because the rate of change with the eureka server is normally much lower than the rate of fetches. The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSeconds
eureka.client.dollar-replacement_-Get a replacement string for Dollar sign <code>$</code> during serializing/deserializing information in eureka server.
eureka.client.enabledtrueFlag to indicate that the Eureka client is enabled.
eureka.client.encoder-name This is a transient config and once the latest codecs are stable, can be removed (as there will only be one)
eureka.client.escape-char-replacement__Get a replacement string for underscore sign <code>_</code> during serializing/deserializing information in eureka server.
eureka.client.eureka-connection-idle-timeout-seconds30Indicates how much time (in seconds) that the HTTP connections to eureka server can stay idle before it can be closed. In the AWS environment, it is recommended that the values is 30 seconds or less, since the firewall cleans up the connection information after a few mins leaving the connection hanging in limbo
eureka.client.eureka-server-connect-timeout-seconds5Indicates how long to wait (in seconds) before a connection to eureka server needs to timeout. Note that the connections in the client are pooled by org.apache.http.client.HttpClient and this setting affects the actual connection creation and also the wait time to get the connection from the pool.
eureka.client.eureka-server-d-n-s-name Gets the DNS name to be queried to get the list of eureka servers.This information is not required if the contract returns the service urls by implementing serviceUrls. The DNS mechanism is used when useDnsForFetchingServiceUrls is set to true and the eureka client expects the DNS to configured a certain way so that it can fetch changing eureka servers dynamically. The changes are effective at runtime.
eureka.client.eureka-server-port Gets the port to be used to construct the service url to contact eureka server when the list of eureka servers come from the DNS.This information is not required if the contract returns the service urls eurekaServerServiceUrls(String). The DNS mechanism is used when useDnsForFetchingServiceUrls is set to true and the eureka client expects the DNS to configured a certain way so that it can fetch changing eureka servers dynamically. The changes are effective at runtime.
eureka.client.eureka-server-read-timeout-seconds8Indicates how long to wait (in seconds) before a read from eureka server needs to timeout.
eureka.client.eureka-server-total-connections200Gets the total number of connections that is allowed from eureka client to all eureka servers.
eureka.client.eureka-server-total-connections-per-host50Gets the total number of connections that is allowed from eureka client to a eureka server host.
eureka.client.eureka-server-u-r-l-context Gets the URL context to be used to construct the service url to contact eureka server when the list of eureka servers come from the DNS. This information is not required if the contract returns the service urls from eurekaServerServiceUrls. The DNS mechanism is used when useDnsForFetchingServiceUrls is set to true and the eureka client expects the DNS to configured a certain way so that it can fetch changing eureka servers dynamically. The changes are effective at runtime.
eureka.client.eureka-service-url-poll-interval-seconds0Indicates how often(in seconds) to poll for changes to eureka server information. Eureka servers could be added or removed and this setting controls how soon the eureka clients should know about it.
eureka.client.fetch-registrytrueIndicates whether this client should fetch eureka registry information from eureka server.
eureka.client.fetch-remote-regions-registry Comma separated list of regions for which the eureka registry information will be fetched. It is mandatory to define the availability zones for each of these regions as returned by availabilityZones. Failing to do so, will result in failure of discovery client startup.
eureka.client.filter-only-up-instancestrueIndicates whether to get the applications after filtering the applications for instances with only InstanceStatus UP states.
eureka.client.g-zip-contenttrueIndicates whether the content fetched from eureka server has to be compressed whenever it is supported by the server. The registry information from the eureka server is compressed for optimum network traffic.
eureka.client.healthcheck.enabledtrueEnables the Eureka health check handler.
eureka.client.heartbeat-executor-exponential-back-off-bound10Heartbeat executor exponential back off related property. It is a maximum multiplier value for retry delay, in case where a sequence of timeouts occurred.
eureka.client.heartbeat-executor-thread-pool-size2The thread pool size for the heartbeatExecutor to initialise with
eureka.client.initial-instance-info-replication-interval-seconds40Indicates how long initially (in seconds) to replicate instance info to the eureka server
eureka.client.instance-info-replication-interval-seconds30Indicates how often(in seconds) to replicate instance changes to be replicated to the eureka server.
eureka.client.log-delta-difffalseIndicates whether to log differences between the eureka server and the eureka client in terms of registry information. Eureka client tries to retrieve only delta changes from eureka server to minimize network traffic. After receiving the deltas, eureka client reconciles the information from the server to verify it has not missed out some information. Reconciliation failures could happen when the client has had network issues communicating to server.If the reconciliation fails, eureka client gets the full registry information. While getting the full registry information, the eureka client can log the differences between the client and the server and this setting controls that. The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSecondsr
eureka.client.on-demand-update-status-changetrueIf set to true, local status updates via ApplicationInfoManager will trigger on-demand (but rate limited) register/updates to remote eureka servers
eureka.client.prefer-same-zone-eurekatrueIndicates whether or not this instance should try to use the eureka server in the same zone for latency and/or other reason. Ideally eureka clients are configured to talk to servers in the same zone The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSeconds
eureka.client.property-resolver
eureka.client.proxy-host Gets the proxy host to eureka server if any.
eureka.client.proxy-password Gets the proxy password if any.
eureka.client.proxy-port Gets the proxy port to eureka server if any.
eureka.client.proxy-user-name Gets the proxy user name if any.
eureka.client.regionus-east-1Gets the region (used in AWS datacenters) where this instance resides.
eureka.client.register-with-eurekatrueIndicates whether or not this instance should register its information with eureka server for discovery by others. In some cases, you do not want your instances to be discovered whereas you just want do discover other instances.
eureka.client.registry-fetch-interval-seconds30Indicates how often(in seconds) to fetch the registry information from the eureka server.
eureka.client.registry-refresh-single-vip-address Indicates whether the client is only interested in the registry information for a single VIP.
eureka.client.service-url Map of availability zone to list of fully qualified URLs to communicate with eureka server. Each value can be a single URL or a comma separated list of alternative locations. Typically the eureka server URLs carry protocol,host,port,context and version information if any. Example: http://ec2-256-156-243-129.compute-1.amazonaws.com:7001/eureka/ The changes are effective at runtime at the next service url refresh cycle as specified by eurekaServiceUrlPollIntervalSeconds.
eureka.client.use-dns-for-fetching-service-urlsfalseIndicates whether the eureka client should use the DNS mechanism to fetch a list of eureka servers to talk to. When the DNS name is updated to have additional servers, that information is used immediately after the eureka client polls for that information as specified in eurekaServiceUrlPollIntervalSeconds. Alternatively, the service urls can be returned serviceUrls, but the users should implement their own mechanism to return the updated list in case of changes. The changes are effective at runtime.
eureka.dashboard.enabledtrueFlag to enable the Eureka dashboard. Default true.
eureka.dashboard.path/The path to the Eureka dashboard (relative to the servlet path). Defaults to "/".
eureka.instance.a-s-g-name Gets the AWS autoscaling group name associated with this instance. This information is specifically used in an AWS environment to automatically put an instance out of service after the instance is launched and it has been disabled for traffic..
eureka.instance.app-group-name Get the name of the application group to be registered with eureka.
eureka.instance.appnameunknownGet the name of the application to be registered with eureka.
eureka.instance.data-center-info Returns the data center this instance is deployed. This information is used to get some AWS specific instance information if the instance is deployed in AWS.
eureka.instance.default-address-resolution-order[]
eureka.instance.environment
eureka.instance.health-check-url Gets the absolute health check page URL for this instance. The users can provide the healthCheckUrlPath if the health check page resides in the same instance talking to eureka, else in the cases where the instance is a proxy for some other server, users can provide the full URL. If the full URL is provided it takes precedence. <p> It is normally used for making educated decisions based on the health of the instance - for example, it can be used to determine whether to proceed deployments to an entire farm or stop the deployments without causing further damage. The full URL should follow the format http://${eureka.hostname}:7001/ where the value $ is replaced at runtime.
eureka.instance.health-check-url-path/healthGets the relative health check URL path for this instance. The health check page URL is then constructed out of the hostname and the type of communication - secure or unsecure as specified in securePort and nonSecurePort. It is normally used for making educated decisions based on the health of the instance - for example, it can be used to determine whether to proceed deployments to an entire farm or stop the deployments without causing further damage.
eureka.instance.home-page-url Gets the absolute home page URL for this instance. The users can provide the homePageUrlPath if the home page resides in the same instance talking to eureka, else in the cases where the instance is a proxy for some other server, users can provide the full URL. If the full URL is provided it takes precedence. It is normally used for informational purposes for other services to use it as a landing page. The full URL should follow the format http://${eureka.hostname}:7001/ where the value $ is replaced at runtime.
eureka.instance.home-page-url-path/Gets the relative home page URL Path for this instance. The home page URL is then constructed out of the hostName and the type of communication - secure or unsecure. It is normally used for informational purposes for other services to use it as a landing page.
eureka.instance.hostname The hostname if it can be determined at configuration time (otherwise it will be guessed from OS primitives).
eureka.instance.initial-status Initial status to register with rmeote Eureka server.
eureka.instance.instance-enabled-onitfalseIndicates whether the instance should be enabled for taking traffic as soon as it is registered with eureka. Sometimes the application might need to do some pre-processing before it is ready to take traffic.
eureka.instance.instance-id Get the unique Id (within the scope of the appName) of this instance to be registered with eureka.
eureka.instance.ip-address Get the IPAdress of the instance. This information is for academic purposes only as the communication from other instances primarily happen using the information supplied in {@link #getHostName(boolean)}.
eureka.instance.lease-expiration-duration-in-seconds90Indicates the time in seconds that the eureka server waits since it received the last heartbeat before it can remove this instance from its view and there by disallowing traffic to this instance. Setting this value too long could mean that the traffic could be routed to the instance even though the instance is not alive. Setting this value too small could mean, the instance may be taken out of traffic because of temporary network glitches.This value to be set to atleast higher than the value specified in leaseRenewalIntervalInSeconds.
eureka.instance.lease-renewal-interval-in-seconds30Indicates how often (in seconds) the eureka client needs to send heartbeats to eureka server to indicate that it is still alive. If the heartbeats are not received for the period specified in leaseExpirationDurationInSeconds, eureka server will remove the instance from its view, there by disallowing traffic to this instance. Note that the instance could still not take traffic if it implements HealthCheckCallback and then decides to make itself unavailable.
eureka.instance.metadata-map Gets the metadata name/value pairs associated with this instance. This information is sent to eureka server and can be used by other instances.
eureka.instance.namespaceeurekaGet the namespace used to find properties. Ignored in Spring Cloud.
eureka.instance.non-secure-port80Get the non-secure port on which the instance should receive traffic.
eureka.instance.non-secure-port-enabledtrueIndicates whether the non-secure port should be enabled for traffic or not.
eureka.instance.prefer-ip-addressfalseFlag to say that, when guessing a hostname, the IP address of the server should be used in prference to the hostname reported by the OS.
eureka.instance.registry.default-open-for-traffic-count1Value used in determining when leases are cancelled, default to 1 for standalone. Should be set to 0 for peer replicated eurekas
eureka.instance.registry.expected-number-of-renews-per-min1
eureka.instance.secure-health-check-url Gets the absolute secure health check page URL for this instance. The users can provide the secureHealthCheckUrl if the health check page resides in the same instance talking to eureka, else in the cases where the instance is a proxy for some other server, users can provide the full URL. If the full URL is provided it takes precedence. <p> It is normally used for making educated decisions based on the health of the instance - for example, it can be used to determine whether to proceed deployments to an entire farm or stop the deployments without causing further damage. The full URL should follow the format http://${eureka.hostname}:7001/ where the value $ is replaced at runtime.
eureka.instance.secure-port443Get the Secure port on which the instance should receive traffic.
eureka.instance.secure-port-enabledfalseIndicates whether the secure port should be enabled for traffic or not.
eureka.instance.secure-virtual-host-nameunknownGets the secure virtual host name defined for this instance. This is typically the way other instance would find this instance by using the secure virtual host name.Think of this as similar to the fully qualified domain name, that the users of your services will need to find this instance.
eureka.instance.status-page-url Gets the absolute status page URL path for this instance. The users can provide the statusPageUrlPath if the status page resides in the same instance talking to eureka, else in the cases where the instance is a proxy for some other server, users can provide the full URL. If the full URL is provided it takes precedence. It is normally used for informational purposes for other services to find about the status of this instance. Users can provide a simple HTML indicating what is the current status of the instance.
eureka.instance.status-page-url-path/infoGets the relative status page URL path for this instance. The status page URL is then constructed out of the hostName and the type of communication - secure or unsecure as specified in securePort and nonSecurePort. It is normally used for informational purposes for other services to find about the status of this instance. Users can provide a simple HTML indicating what is the current status of the instance.
eureka.instance.virtual-host-nameunknownGets the virtual host name defined for this instance. This is typically the way other instance would find this instance by using the virtual host name.Think of this as similar to the fully qualified domain name, that the users of your services will need to find this instance.
eureka.server.a-s-g-cache-expiry-timeout-ms0
eureka.server.a-s-g-query-timeout-ms300
eureka.server.a-s-g-update-interval-ms0
eureka.server.a-w-s-access-id
eureka.server.a-w-s-secret-key
eureka.server.batch-replicationfalse
eureka.server.binding-strategy
eureka.server.delta-retention-timer-interval-in-ms0
eureka.server.disable-deltafalse
eureka.server.disable-delta-for-remote-regionsfalse
eureka.server.disable-transparent-fallback-to-other-regionfalse
eureka.server.e-i-p-bind-rebind-retries3
eureka.server.e-i-p-binding-retry-interval-ms0
eureka.server.e-i-p-binding-retry-interval-ms-when-unbound0
eureka.server.enable-replicated-request-compressionfalse
eureka.server.enable-self-preservationtrue
eureka.server.eviction-interval-timer-in-ms0
eureka.server.g-zip-content-from-remote-regiontrue
eureka.server.json-codec-name
eureka.server.list-auto-scaling-groups-role-nameListAutoScalingGroups
eureka.server.log-identity-headerstrue
eureka.server.max-elements-in-peer-replication-pool10000
eureka.server.max-elements-in-status-replication-pool10000
eureka.server.max-idle-thread-age-in-minutes-for-peer-replication15
eureka.server.max-idle-thread-in-minutes-age-for-status-replication10
eureka.server.max-threads-for-peer-replication20
eureka.server.max-threads-for-status-replication1
eureka.server.max-time-for-replication30000
eureka.server.min-available-instances-for-peer-replication-1
eureka.server.min-threads-for-peer-replication5
eureka.server.min-threads-for-status-replication1
eureka.server.number-of-replication-retries5
eureka.server.peer-eureka-nodes-update-interval-ms0
eureka.server.peer-eureka-status-refresh-time-interval-ms0
eureka.server.peer-node-connect-timeout-ms200
eureka.server.peer-node-connection-idle-timeout-seconds30
eureka.server.peer-node-read-timeout-ms200
eureka.server.peer-node-total-connections1000
eureka.server.peer-node-total-connections-per-host500
eureka.server.prime-aws-replica-connectionstrue
eureka.server.property-resolver
eureka.server.rate-limiter-burst-size10
eureka.server.rate-limiter-enabledfalse
eureka.server.rate-limiter-full-fetch-average-rate100
eureka.server.rate-limiter-privileged-clients
eureka.server.rate-limiter-registry-fetch-average-rate500
eureka.server.rate-limiter-throttle-standard-clientsfalse
eureka.server.registry-sync-retries0
eureka.server.registry-sync-retry-wait-ms0
eureka.server.remote-region-app-whitelist
eureka.server.remote-region-connect-timeout-ms1000
eureka.server.remote-region-connection-idle-timeout-seconds30
eureka.server.remote-region-fetch-thread-pool-size20
eureka.server.remote-region-read-timeout-ms1000
eureka.server.remote-region-registry-fetch-interval30
eureka.server.remote-region-total-connections1000
eureka.server.remote-region-total-connections-per-host500
eureka.server.remote-region-trust-store
eureka.server.remote-region-trust-store-passwordchangeit
eureka.server.remote-region-urls
eureka.server.remote-region-urls-with-name
eureka.server.renewal-percent-threshold0.85
eureka.server.renewal-threshold-update-interval-ms0
eureka.server.response-cache-auto-expiration-in-seconds180
eureka.server.response-cache-update-interval-ms0
eureka.server.retention-time-in-m-s-in-delta-queue0
eureka.server.route53-bind-rebind-retries3
eureka.server.route53-binding-retry-interval-ms0
eureka.server.route53-domain-t-t-l30
eureka.server.sync-when-timestamp-differstrue
eureka.server.use-read-only-response-cachetrue
eureka.server.wait-time-in-ms-when-sync-empty0
eureka.server.xml-codec-name
feign.client.config
feign.client.default-configdefault
feign.client.default-to-propertiestrue
feign.compression.request.mime-types[text/xml, application/xml, application/json]The list of supported mime types.
feign.compression.request.min-request-size2048The minimum threshold content size.
feign.httpclient.connection-timeout2000
feign.httpclient.connection-timer-repeat3000
feign.httpclient.disable-ssl-validationfalse
feign.httpclient.follow-redirectstrue
feign.httpclient.max-connections200
feign.httpclient.max-connections-per-route50
feign.httpclient.time-to-live900
feign.httpclient.time-to-live-unit
health.config.enabledfalseFlag to indicate that the config server health indicator should be installed.
health.config.time-to-live0Time to live for cached result, in milliseconds. Default 300000 (5 min).
hystrix.metrics.enabledtrueEnable Hystrix metrics polling. Defaults to true.
hystrix.metrics.polling-interval-ms2000Interval between subsequent polling of metrics. Defaults to 2000 ms.
hystrix.shareSecurityContextfalseEnables auto-configuration of the Hystrix concurrency strategy plugin hook who will transfer the SecurityContext from your main thread to the one used by the Hystrix command.
management.health.refresh.enabledtrueEnable the health endpoint for the refresh scope.
management.health.zookeeper.enabledtrueEnable the health endpoint for zookeeper.
management.metrics.binders.hystrix.enabledtrueEnables creation of OK Http Client factory beans.
netflix.atlas.batch-size10000
netflix.atlas.enabledtrue
netflix.atlas.uri
netflix.metrics.servo.cache-warning-threshold1000When the ServoMonitorCache reaches this size, a warning is logged. This will be useful if you are using string concatenation in RestTemplate urls.
netflix.metrics.servo.registry-classcom.netflix.servo.BasicMonitorRegistryFully qualified class name for monitor registry used by Servo.
proxy.auth.load-balancedfalse
proxy.auth.routes Authentication strategy per route.
ribbon.eager-load.clients
ribbon.eager-load.enabledfalse
ribbon.eureka.enabledtrueEnables the use of Eureka with Ribbon.
ribbon.http.client.enabledfalseDeprecated property to enable Ribbon RestClient.
ribbon.okhttp.enabledfalseEnables the use of the OK HTTP Client with Ribbon.
ribbon.restclient.enabledfalseEnables the use of the deprecated Ribbon RestClient.
ribbon.secure-ports
spring.cloud.bus.ack.destination-service Service that wants to listen to acks. By default null (meaning all services).
spring.cloud.bus.ack.enabledtrueFlag to switch off acks (default on).
spring.cloud.bus.destinationspringCloudBusName of Spring Cloud Stream destination for messages.
spring.cloud.bus.enabledtrueFlag to indicate that the bus is enabled.
spring.cloud.bus.env.enabledtrueFlag to switch off environment change events (default on).
spring.cloud.bus.refresh.enabledtrueFlag to switch off refresh events (default on).
spring.cloud.bus.trace.enabledfalseFlag to switch on tracing of acks (default off).
spring.cloud.cloudfoundry.discovery.enabledtrueFlag to indicate that discovery is enabled.
spring.cloud.cloudfoundry.discovery.heartbeat-frequency5000Frequency in milliseconds of poll for heart beat. The client will poll on this frequency and broadcast a list of service ids.
spring.cloud.cloudfoundry.discovery.org Organization name to authenticate with (default to user’s default).
spring.cloud.cloudfoundry.discovery.password Password for user to authenticate and obtain token.
spring.cloud.cloudfoundry.discovery.space Space name to authenticate with (default to user’s default).
spring.cloud.cloudfoundry.discovery.urlhttps://api.run.pivotal.ioURL of Cloud Foundry API (Cloud Controller).
spring.cloud.cloudfoundry.discovery.username Username to authenticate (usually an email address).
spring.cloud.config.allow-overridetrueFlag to indicate that {@link #isOverrideSystemProperties() systemPropertiesOverride} can be used. Set to false to prevent users from changing the default accidentally. Default true.
spring.cloud.config.authorization Authorization token used by the client to connect to the server.
spring.cloud.config.discovery.enabledfalseFlag to indicate that config server discovery is enabled (config server URL will be looked up via discovery).
spring.cloud.config.discovery.service-idconfigserverService id to locate config server.
spring.cloud.config.enabledtrueFlag to say that remote configuration is enabled. Default true;
spring.cloud.config.fail-fastfalseFlag to indicate that failure to connect to the server is fatal (default false).
spring.cloud.config.headers Additional headers used to create the client request.
spring.cloud.config.label The label name to use to pull remote configuration properties. The default is set on the server (generally "master" for a git based server).
spring.cloud.config.name Name of application used to fetch remote properties.
spring.cloud.config.override-nonefalseFlag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is true, external properties should take lowest priority, and not override any existing property sources (including local config files). Default false.
spring.cloud.config.override-system-propertiestrueFlag to indicate that the external properties should override system properties. Default true.
spring.cloud.config.password The password to use (HTTP Basic) when contacting the remote server.
spring.cloud.config.profiledefaultThe default profile to use when fetching remote configuration (comma-separated). Default is "default".
spring.cloud.config.retry.initial-interval1000Initial retry interval in milliseconds.
spring.cloud.config.retry.max-attempts6Maximum number of attempts.
spring.cloud.config.retry.max-interval2000Maximum interval for backoff.
spring.cloud.config.retry.multiplier1.1Multiplier for next interval.
spring.cloud.config.server.bootstrapfalseFlag indicating that the config server should initialize its own Environment with properties from the remote repository. Off by default because it delays startup but can be useful when embedding the server in another application.
spring.cloud.config.server.default-application-nameapplicationDefault application name when incoming requests do not have a specific one.
spring.cloud.config.server.default-label Default repository label when incoming requests do not have a specific label.
spring.cloud.config.server.default-profiledefaultDefault application profile when incoming requests do not have a specific one.
spring.cloud.config.server.encrypt.enabledtrueEnable decryption of environment properties before sending to client.
spring.cloud.config.server.git.basedir Base directory for local working copy of repository.
spring.cloud.config.server.git.clone-on-startfalseFlag to indicate that the repository should be cloned on startup (not on demand). Generally leads to slower startup but faster first query.
spring.cloud.config.server.git.default-labelmaster
spring.cloud.config.server.git.delete-untracked-branchesfalseFlag to indicate that the branch should be deleted locally if it’s origin tracked branch was removed.
spring.cloud.config.server.git.environment
spring.cloud.config.server.git.force-pullfalseFlag to indicate that the repository should force pull. If true discard any local changes and take from remote repository.
spring.cloud.config.server.git.git-credentials-provider The credentials provider to use to connect to the Git repository.
spring.cloud.config.server.git.git-factory
spring.cloud.config.server.git.host-key
spring.cloud.config.server.git.host-key-algorithm
spring.cloud.config.server.git.ignore-local-ssh-settingsfalse
spring.cloud.config.server.git.known-hosts-file
spring.cloud.config.server.git.last-refresh0Time of the last refresh of the git repository
spring.cloud.config.server.git.order
spring.cloud.config.server.git.passphrase Passphrase for unlocking your ssh private key.
spring.cloud.config.server.git.password Password for authentication with remote repository.
spring.cloud.config.server.git.preferred-authentications
spring.cloud.config.server.git.private-key
spring.cloud.config.server.git.proxy-host
spring.cloud.config.server.git.proxy-port
spring.cloud.config.server.git.refresh-rate0Time (in seconds) between refresh of the git repository
spring.cloud.config.server.git.repos Map of repository identifier to location and other properties.
spring.cloud.config.server.git.search-paths Search paths to use within local working copy. By default searches only the root.
spring.cloud.config.server.git.strict-host-key-checkingtrueReject incoming SSH host keys from remote servers not in the known host list.
spring.cloud.config.server.git.timeout5Timeout (in seconds) for obtaining HTTP or SSH connection (if applicable). Default 5 seconds.
spring.cloud.config.server.git.transport-config-callback Transport configuration callback for JGit commands.
spring.cloud.config.server.git.uri URI of remote repository.
spring.cloud.config.server.git.username Username for authentication with remote repository.
spring.cloud.config.server.health.repositories
spring.cloud.config.server.jdbc.order0
spring.cloud.config.server.jdbc.sqlSELECT KEY, VALUE from PROPERTIES where APPLICATION=? and PROFILE=? and LABEL=?
spring.cloud.config.server.native.add-label-locationstrueFlag to determine whether label locations should be added.
spring.cloud.config.server.native.default-labelmaster
spring.cloud.config.server.native.fail-on-errorfalseFlag to determine how to handle exceptions during decryption (default false).
spring.cloud.config.server.native.order
spring.cloud.config.server.native.search-locations[]Locations to search for configuration files. Defaults to the same as a Spring Boot app so [classpath:/,classpath:/config/,file:./,file:./config/].
spring.cloud.config.server.native.version Version string to be reported for native repository
spring.cloud.config.server.overrides Extra map for a property source to be sent to all clients unconditionally.
spring.cloud.config.server.prefix Prefix for configuration resource paths (default is empty). Useful when embedding in another application when you don’t want to change the context path or servlet path.
spring.cloud.config.server.strip-document-from-yamltrueFlag to indicate that YAML documents that are text or collections (not a map) should be returned in "native" form.
spring.cloud.config.server.svn.basedir Base directory for local working copy of repository.
spring.cloud.config.server.svn.default-labeltrunkThe default label for environment properties requests.
spring.cloud.config.server.svn.environment
spring.cloud.config.server.svn.order
spring.cloud.config.server.svn.passphrase Passphrase for unlocking your ssh private key.
spring.cloud.config.server.svn.password Password for authentication with remote repository.
spring.cloud.config.server.svn.search-paths Search paths to use within local working copy. By default searches only the root.
spring.cloud.config.server.svn.strict-host-key-checkingtrueReject incoming SSH host keys from remote servers not in the known host list.
spring.cloud.config.server.svn.uri URI of remote repository.
spring.cloud.config.server.svn.username Username for authentication with remote repository.
spring.cloud.config.server.vault.order
spring.cloud.config.token Security Token passed thru to underlying environment repository.
spring.cloud.config.urihttp://localhost:8888The URI of the remote server (default http://localhost:8888).
spring.cloud.config.username The username to use (HTTP Basic) when contacting the remote server.
spring.cloud.consul.config.acl-token
spring.cloud.consul.config.data-keydataIf format is Format.PROPERTIES or Format.YAML then the following field is used as key to look up consul for configuration.
spring.cloud.consul.config.default-contextapplication
spring.cloud.consul.config.enabledtrue
spring.cloud.consul.config.fail-fasttrueThrow exceptions during config lookup if true, otherwise, log warnings.
spring.cloud.consul.config.format
spring.cloud.consul.config.name Alternative to spring.application.name to use in looking up values in consul KV.
spring.cloud.consul.config.prefixconfig
spring.cloud.consul.config.profile-separator,
spring.cloud.consul.config.watch.delay1000The value of the fixed delay for the watch in millis. Defaults to 1000.
spring.cloud.consul.config.watch.enabledtrueIf the watch is enabled. Defaults to true.
spring.cloud.consul.config.watch.wait-time55The number of seconds to wait (or block) for watch query, defaults to 55. Needs to be less than default ConsulClient (defaults to 60). To increase ConsulClient timeout create a ConsulClient bean with a custom ConsulRawClient with a custom HttpClient.
spring.cloud.consul.discovery.acl-token
spring.cloud.consul.discovery.catalog-services-watch-delay10
spring.cloud.consul.discovery.catalog-services-watch-timeout2
spring.cloud.consul.discovery.datacenters Map of serviceId’s → datacenter to query for in server list. This allows looking up services in another datacenters.
spring.cloud.consul.discovery.default-query-tag Tag to query for in service list if one is not listed in serverListQueryTags.
spring.cloud.consul.discovery.default-zone-metadata-namezoneService instance zone comes from metadata. This allows changing the metadata tag name.
spring.cloud.consul.discovery.deregistertrueDisable automatic de-registration of service in consul.
spring.cloud.consul.discovery.enabledtrueIs service discovery enabled?
spring.cloud.consul.discovery.fail-fasttrueThrow exceptions during service registration if true, otherwise, log warnings (defaults to true).
spring.cloud.consul.discovery.health-check-critical-timeout Timeout to deregister services critical for longer than timeout (e.g. 30m). Requires consul version 7.x or higher.
spring.cloud.consul.discovery.health-check-interval10sHow often to perform the health check (e.g. 10s), defaults to 10s.
spring.cloud.consul.discovery.health-check-path/healthAlternate server path to invoke for health checking
spring.cloud.consul.discovery.health-check-timeout Timeout for health check (e.g. 10s).
spring.cloud.consul.discovery.health-check-tls-skip-verify Skips certificate verification during service checks if true, otherwise runs certificate verification.
spring.cloud.consul.discovery.health-check-url Custom health check url to override default
spring.cloud.consul.discovery.heartbeat.enabledfalse
spring.cloud.consul.discovery.heartbeat.heartbeat-interval
spring.cloud.consul.discovery.heartbeat.interval-ratio
spring.cloud.consul.discovery.heartbeat.ttl-units
spring.cloud.consul.discovery.heartbeat.ttl-value30
spring.cloud.consul.discovery.hostname Hostname to use when accessing server
spring.cloud.consul.discovery.instance-group Service instance group
spring.cloud.consul.discovery.instance-id Unique service instance id
spring.cloud.consul.discovery.instance-zone Service instance zone
spring.cloud.consul.discovery.ip-address IP address to use when accessing service (must also set preferIpAddress to use)
spring.cloud.consul.discovery.lifecycle.enabledtrue
spring.cloud.consul.discovery.management-port Port to register the management service under (defaults to management port)
spring.cloud.consul.discovery.management-suffixmanagementSuffix to use when registering management service
spring.cloud.consul.discovery.management-tags Tags to use when registering management service
spring.cloud.consul.discovery.port Port to register the service under (defaults to listening port)
spring.cloud.consul.discovery.prefer-agent-addressfalseSource of how we will determine the address to use
spring.cloud.consul.discovery.prefer-ip-addressfalseUse ip address rather than hostname during registration
spring.cloud.consul.discovery.query-passingfalseAdd the 'passing` parameter to /v1/health/service/serviceName. This pushes health check passing to the server.
spring.cloud.consul.discovery.registertrueRegister as a service in consul.
spring.cloud.consul.discovery.register-health-checktrueRegister health check in consul. Useful during development of a service.
spring.cloud.consul.discovery.schemehttpWhether to register an http or https service
spring.cloud.consul.discovery.server-list-query-tags Map of serviceId’s → tag to query for in server list. This allows filtering services by a single tag.
spring.cloud.consul.discovery.service-name Service name
spring.cloud.consul.discovery.tags Tags to use when registering service
spring.cloud.consul.enabledtrueIs spring cloud consul enabled
spring.cloud.consul.hostlocalhostConsul agent hostname. Defaults to 'localhost'.
spring.cloud.consul.port8500Consul agent port. Defaults to '8500'.
spring.cloud.consul.retry.initial-interval1000Initial retry interval in milliseconds.
spring.cloud.consul.retry.max-attempts6Maximum number of attempts.
spring.cloud.consul.retry.max-interval2000Maximum interval for backoff.
spring.cloud.consul.retry.multiplier1.1Multiplier for next interval.
spring.cloud.consul.tls.certificate-password Password to open the certificate.
spring.cloud.consul.tls.certificate-path File path to the certificate.
spring.cloud.consul.tls.key-store-instance-type Type of key framework to use.
spring.cloud.consul.tls.key-store-password Password to an external keystore
spring.cloud.consul.tls.key-store-path Path to an external keystore
spring.cloud.discovery.client.composite-indicator.enabledtrueEnables discovery client composite health indicator.
spring.cloud.discovery.client.health-indicator.enabledtrue
spring.cloud.discovery.client.health-indicator.include-descriptiontrue
spring.cloud.discovery.client.simple.instances
spring.cloud.discovery.client.simple.local.metadata Metadata for the service instance. Can be used by discovery clients to modify their behaviour per instance, e.g. when load balancing.
spring.cloud.discovery.client.simple.local.service-id The identifier or name for the service. Multiple instances might share the same service id.
spring.cloud.discovery.client.simple.local.uri The URI of the service instance. Will be parsed to extract the scheme, hos and port.
spring.cloud.discovery.enabledtrueEnables discovery client health indicators.
spring.cloud.features.enabledtrueEnables the features endpoint.
spring.cloud.gateway.proxy.headers Fixed header values that will be added to all downstream requests.
spring.cloud.gateway.proxy.sensitive A set of sensitive header names that will not be sent downstream by default.
spring.cloud.httpclientfactories.apache.enabledtrueEnables creation of Apache Http Client factory beans.
spring.cloud.httpclientfactories.ok.enabledtrueEnables creation of OK Http Client factory beans.
spring.cloud.hypermedia.refresh.fixed-delay5000
spring.cloud.hypermedia.refresh.initial-delay10000
spring.cloud.inetutils.default-hostnamelocalhostThe default hostname. Used in case of errors.
spring.cloud.inetutils.default-ip-address127.0.0.1The default ipaddress. Used in case of errors.
spring.cloud.inetutils.ignored-interfaces List of Java regex expressions for network interfaces that will be ignored.
spring.cloud.inetutils.preferred-networks List of Java regex expressions for network addresses that will be preferred.
spring.cloud.inetutils.timeout-seconds1Timeout in seconds for calculating hostname.
spring.cloud.inetutils.use-only-site-local-interfacesfalseUse only interfaces with site local addresses. See {@link InetAddress#isSiteLocalAddress()} for more details.
spring.cloud.loadbalancer.retry.enabledtrue
spring.cloud.refresh.enabledtrueEnables autoconfiguration for the refresh scope and associated features.
spring.cloud.service-registry.auto-registration.enabledtrueIf Auto-Service Registration is enabled, default to true.
spring.cloud.service-registry.auto-registration.fail-fastfalseShould startup fail if there is no AutoServiceRegistration, default to false.
spring.cloud.service-registry.auto-registration.register-managementtrueWhether to register the management as a service, defaults to true
spring.cloud.stream.binders
spring.cloud.stream.bindings
spring.cloud.stream.consul.binder.event-timeout5
spring.cloud.stream.default-binder
spring.cloud.stream.dynamic-destinations[]
spring.cloud.stream.instance-count1
spring.cloud.stream.instance-index0
spring.cloud.stream.integration.message-handler-not-propagated-headers Message header names that will NOT be copied from the inbound message.
spring.cloud.util.enabledtrueEnables creation of Spring Cloud utility beans.
spring.cloud.vault.app-id.app-id-pathapp-idMount path of the AppId authentication backend.
spring.cloud.vault.app-id.network-interface Network interface hint for the "MAC_ADDRESS" UserId mechanism.
spring.cloud.vault.app-id.user-idMAC_ADDRESSUserId mechanism. Can be either "MAC_ADDRESS", "IP_ADDRESS", a string or a class name.
spring.cloud.vault.app-role.app-role-pathapproleMount path of the AppId authentication backend.
spring.cloud.vault.app-role.role-id The RoleId.
spring.cloud.vault.app-role.secret-id The SecretId.
spring.cloud.vault.application-nameapplicationApplication name for AppId authentication.
spring.cloud.vault.authentication
spring.cloud.vault.aws-ec2.aws-ec2-pathaws-ec2Mount path of the AWS-EC2 authentication backend.
spring.cloud.vault.aws-ec2.identity-documenthttp://169.254.169.254/latest/dynamic/instance-identity/pkcs7URL of the AWS-EC2 PKCS7 identity document.
spring.cloud.vault.aws-ec2.nonce Nonce used for AWS-EC2 authentication. An empty nonce defaults to nonce generation.
spring.cloud.vault.aws-ec2.role Name of the role, optional.
spring.cloud.vault.aws-ec2.use-noncetrueFlag whether to generate and send a nonce. @deprecated not used, will be removed in a future version.
spring.cloud.vault.aws-iam.aws-pathawsMount path of the AWS authentication backend.
spring.cloud.vault.aws-iam.role Name of the role, optional. Defaults to the friendly IAM name if not set.
spring.cloud.vault.aws-iam.server-name Name of the server used to set {@code X-Vault-AWS-IAM-Server-ID} header in the headers of login requests.
spring.cloud.vault.aws.access-key-propertycloud.aws.credentials.accessKeyTarget property for the obtained access key.
spring.cloud.vault.aws.backendawsaws backend path.
spring.cloud.vault.aws.enabledfalseEnable aws backend usage.
spring.cloud.vault.aws.role Role name for credentials.
spring.cloud.vault.aws.secret-key-propertycloud.aws.credentials.secretKeyTarget property for the obtained secret key.
spring.cloud.vault.cassandra.backendcassandraCassandra backend path.
spring.cloud.vault.cassandra.enabledfalseEnable cassandra backend usage.
spring.cloud.vault.cassandra.password-propertyspring.data.cassandra.passwordTarget property for the obtained password.
spring.cloud.vault.cassandra.role Role name for credentials.
spring.cloud.vault.cassandra.username-propertyspring.data.cassandra.usernameTarget property for the obtained username.
spring.cloud.vault.config.lifecycle
spring.cloud.vault.config.order0Used to set a {@link org.springframework.core.env.PropertySource} priority. This is useful to use Vault as an override on other property sources. @see org.springframework.core.PriorityOrdered
spring.cloud.vault.connection-timeout5000Connection timeout;
spring.cloud.vault.consul.backendconsulConsul backend path.
spring.cloud.vault.consul.enabledfalseEnable consul backend usage.
spring.cloud.vault.consul.role Role name for credentials.
spring.cloud.vault.consul.token-propertyspring.cloud.consul.tokenTarget property for the obtained token.
spring.cloud.vault.discovery.enabledfalseFlag to indicate that Vault server discovery is enabled (vault server URL will be looked up via discovery).
spring.cloud.vault.discovery.service-idvaultService id to locate Vault.
spring.cloud.vault.enabledtrueEnable Vault config server.
spring.cloud.vault.fail-fastfalseFail fast if data cannot be obtained from Vault.
spring.cloud.vault.generic.application-nameapplicationApplication name to be used for the context.
spring.cloud.vault.generic.backendsecretName of the default backend.
spring.cloud.vault.generic.default-contextapplicationName of the default context.
spring.cloud.vault.generic.enabledtrueEnable the generic backend.
spring.cloud.vault.generic.profile-separator/Profile-separator to combine application name and profile.
spring.cloud.vault.hostlocalhostVault server host.
spring.cloud.vault.kubernetes.kubernetes-pathkubernetesMount path of the Kubernetes authentication backend.
spring.cloud.vault.kubernetes.role Name of the role against which the login is being attempted.
spring.cloud.vault.kubernetes.service-account-token-file/var/run/secrets/kubernetes.io/serviceaccount/tokenPath to the service account token file.
spring.cloud.vault.mongodb.backendmongodbCassandra backend path.
spring.cloud.vault.mongodb.enabledfalseEnable mongodb backend usage.
spring.cloud.vault.mongodb.password-propertyspring.data.mongodb.passwordTarget property for the obtained password.
spring.cloud.vault.mongodb.role Role name for credentials.
spring.cloud.vault.mongodb.username-propertyspring.data.mongodb.usernameTarget property for the obtained username.
spring.cloud.vault.mysql.backendmysqlmysql backend path.
spring.cloud.vault.mysql.enabledfalseEnable mysql backend usage.
spring.cloud.vault.mysql.password-propertyspring.datasource.passwordTarget property for the obtained username.
spring.cloud.vault.mysql.role Role name for credentials.
spring.cloud.vault.mysql.username-propertyspring.datasource.usernameTarget property for the obtained username.
spring.cloud.vault.port8200Vault server port.
spring.cloud.vault.postgresql.backendpostgresqlpostgresql backend path.
spring.cloud.vault.postgresql.enabledfalseEnable postgresql backend usage.
spring.cloud.vault.postgresql.password-propertyspring.datasource.passwordTarget property for the obtained username.
spring.cloud.vault.postgresql.role Role name for credentials.
spring.cloud.vault.postgresql.username-propertyspring.datasource.usernameTarget property for the obtained username.
spring.cloud.vault.rabbitmq.backendrabbitmqrabbitmq backend path.
spring.cloud.vault.rabbitmq.enabledfalseEnable rabbitmq backend usage.
spring.cloud.vault.rabbitmq.password-propertyspring.rabbitmq.passwordTarget property for the obtained password.
spring.cloud.vault.rabbitmq.role Role name for credentials.
spring.cloud.vault.rabbitmq.username-propertyspring.rabbitmq.usernameTarget property for the obtained username.
spring.cloud.vault.read-timeout15000Read timeout;
spring.cloud.vault.schemehttpsProtocol scheme. Can be either "http" or "https".
spring.cloud.vault.ssl.cert-auth-pathcertMount path of the TLS cert authentication backend.
spring.cloud.vault.ssl.key-store Trust store that holds certificates and private keys.
spring.cloud.vault.ssl.key-store-password Password used to access the key store.
spring.cloud.vault.ssl.trust-store Trust store that holds SSL certificates.
spring.cloud.vault.ssl.trust-store-password Password used to access the trust store.
spring.cloud.vault.token Static vault token. Required if {@link #authentication} is {@code TOKEN}.
spring.cloud.vault.uri Vault URI. Can be set with scheme, host and port.
spring.cloud.zookeeper.base-sleep-time-ms50Initial amount of time to wait between retries
spring.cloud.zookeeper.block-until-connected-unit The unit of time related to blocking on connection to Zookeeper
spring.cloud.zookeeper.block-until-connected-wait10Wait time to block on connection to Zookeeper
spring.cloud.zookeeper.connect-stringlocalhost:2181Connection string to the Zookeeper cluster
spring.cloud.zookeeper.default-health-endpoint Default health endpoint that will be checked to verify that a dependency is alive
spring.cloud.zookeeper.dependencies Mapping of alias to ZookeeperDependency. From Ribbon perspective the alias is actually serviceID since Ribbon can’t accept nested structures in serviceID
spring.cloud.zookeeper.dependency-configurations
spring.cloud.zookeeper.dependency-names
spring.cloud.zookeeper.discovery.enabledtrue
spring.cloud.zookeeper.discovery.initial-status The initial status of this instance (defaults to {@link StatusConstants#STATUS_UP}).
spring.cloud.zookeeper.discovery.instance-host Predefined host with which a service can register itself in Zookeeper. Corresponds to the from the URI spec.
spring.cloud.zookeeper.discovery.instance-id Id used to register with zookeeper. Defaults to a random UUID.
spring.cloud.zookeeper.discovery.instance-port Port to register the service under (defaults to listening port)
spring.cloud.zookeeper.discovery.instance-ssl-port Ssl port of the registered service.
spring.cloud.zookeeper.discovery.metadata Gets the metadata name/value pairs associated with this instance. This information is sent to zookeeper and can be used by other instances.
spring.cloud.zookeeper.discovery.registertrueRegister as a service in zookeeper.
spring.cloud.zookeeper.discovery.root/servicesRoot Zookeeper folder in which all instances are registered
spring.cloud.zookeeper.discovery.uri-spec://:The URI specification to resolve during service registration in Zookeeper
spring.cloud.zookeeper.enabledtrueIs Zookeeper enabled
spring.cloud.zookeeper.max-retries10Max number of times to retry
spring.cloud.zookeeper.max-sleep-ms500Max time in ms to sleep on each retry
spring.cloud.zookeeper.prefix Common prefix that will be applied to all Zookeeper dependencies' paths
spring.integration.poller.fixed-delay1000Fixed delay for default poller.
spring.integration.poller.max-messages-per-poll1Maximum messages per poll for the default poller.
spring.sleuth.annotation.enabledtrue
spring.sleuth.async.configurer.enabledtrueEnable default AsyncConfigurer.
spring.sleuth.async.enabledtrueEnable instrumenting async related components so that the tracing information is passed between threads.
spring.sleuth.enabledtrue
spring.sleuth.feign.enabledtrueEnable span information propagation when using Feign.
spring.sleuth.feign.processor.enabledtrueEnable post processor that wraps Feign Context in its tracing representations.
spring.sleuth.hystrix.strategy.enabledtrueEnable custom HystrixConcurrencyStrategy that wraps all Callable instances into their Sleuth representative - the TraceCallable.
spring.sleuth.integration.enabledtrueEnable Spring Integration sleuth instrumentation.
spring.sleuth.integration.patterns*An array of simple patterns against which channel names will be matched. Default is * (all channels). See org.springframework.util.PatternMatchUtils.simpleMatch(String, String).
spring.sleuth.integration.websockets.enabledtrueEnable tracing for WebSockets.
spring.sleuth.keys.async.class-name-keyclassSimple name of the class with a method annotated with {@code @Async} from which the asynchronous process started @see org.springframework.scheduling.annotation.Async
spring.sleuth.keys.async.method-name-keymethodName of the method annotated with {@code @Async} @see org.springframework.scheduling.annotation.Async
spring.sleuth.keys.async.prefix Prefix for header names if they are added as tags.
spring.sleuth.keys.async.thread-name-keythreadName of the thread that executed the async method @see org.springframework.scheduling.annotation.Async
spring.sleuth.keys.http.headers Additional headers that should be added as tags if they exist. If the header value is multi-valued, the tag value will be a comma-separated, single-quoted list.
spring.sleuth.keys.http.hosthttp.hostThe domain portion of the URL or host header. Example: "mybucket.s3.amazonaws.com". Used to filter by host as opposed to ip address.
spring.sleuth.keys.http.methodhttp.methodThe HTTP method, or verb, such as "GET" or "POST". Used to filter against an http route.
spring.sleuth.keys.http.pathhttp.pathThe absolute http path, without any query parameters. Example: "/objects/abcd-ff". Used to filter against an http route, portably with zipkin v1. In zipkin v1, only equals filters are supported. Dropping query parameters makes the number of distinct URIs less. For example, one can query for the same resource, regardless of signing parameters encoded in the query line. This does not reduce cardinality to a HTTP single route. For example, it is common to express a route as an http URI template like "/resource/". In systems where only equals queries are available, searching for {@code http.uri=/resource} won’t match if the actual request was "/resource/abcd-ff". Historical note: This was commonly expressed as "http.uri" in zipkin, eventhough it was most often just a path.
spring.sleuth.keys.http.prefixhttp.Prefix for header names if they are added as tags.
spring.sleuth.keys.http.request-sizehttp.request.sizeThe size of the non-empty HTTP request body, in bytes. Ex. "16384" <p>Large uploads can exceed limits or contribute directly to latency.
spring.sleuth.keys.http.response-sizehttp.response.sizeThe size of the non-empty HTTP response body, in bytes. Ex. "16384" <p>Large downloads can exceed limits or contribute directly to latency.
spring.sleuth.keys.http.status-codehttp.status_codeThe HTTP response code, when not in 2xx range. Ex. "503" Used to filter for error status. 2xx range are not logged as success codes are less interesting for latency troubleshooting. Omitting saves at least 20 bytes per span.
spring.sleuth.keys.http.urlhttp.urlThe entire URL, including the scheme, host and query parameters if available. Ex. "https://mybucket.s3.amazonaws.com/objects/abcd-ff?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Algorithm=AWS4-HMAC-SHA256…" Combined with {@link #method}, you can understand the fully-qualified request line. This is optional as it may include private data or be of considerable length.
spring.sleuth.keys.hystrix.command-groupcommandGroupName of the command group. Hystrix uses the command group key to group together commands such as for reporting, alerting, dashboards, or team/library ownership. @see com.netflix.hystrix.HystrixCommandGroupKey
spring.sleuth.keys.hystrix.command-keycommandKeyName of the command key. Describes the name for the given command. A key to represent a {@link com.netflix.hystrix.HystrixCommand} for monitoring, circuit-breakers, metrics publishing, caching and other such uses. @see com.netflix.hystrix.HystrixCommandKey
spring.sleuth.keys.hystrix.prefix Prefix for header names if they are added as tags.
spring.sleuth.keys.hystrix.thread-pool-keythreadPoolKeyName of the thread pool key. The thread-pool key represents a {@link com.netflix.hystrix.HystrixThreadPool} for monitoring, metrics publishing, caching, and other such uses. A {@link com.netflix.hystrix.HystrixCommand} is associated with a single {@link com.netflix.hystrix.HystrixThreadPool} as retrieved by the {@link com.netflix.hystrix.HystrixThreadPoolKey} injected into it, or it defaults to one created using the {@link com.netflix.hystrix.HystrixCommandGroupKey} it is created with. @see com.netflix.hystrix.HystrixThreadPoolKey
spring.sleuth.keys.message.headers Additional headers that should be added as tags if they exist. If the header value is not a String it will be converted to a String using its toString() method.
spring.sleuth.keys.message.payload.sizemessage/payload-sizeAn estimate of the size of the payload if available.
spring.sleuth.keys.message.payload.typemessage/payload-typeThe type of the payload.
spring.sleuth.keys.message.prefixmessage/Prefix for header names if they are added as tags.
spring.sleuth.keys.mvc.controller-classmvc.controller.classThe lower case, hyphen delimited name of the class that processes the request. Ex. class named "BookController" will result in "book-controller" tag value.
spring.sleuth.keys.mvc.controller-methodmvc.controller.methodThe lower case, hyphen delimited name of the class that processes the request. Ex. method named "listOfBooks" will result in "list-of-books" tag value.
spring.sleuth.log.slf4j.enabledtrueEnable a {@link Slf4jSpanLogger} that prints tracing information in the logs.
spring.sleuth.log.slf4j.name-skip-pattern Name pattern for which span should not be printed in the logs.
spring.sleuth.metric.enabledtrueEnable calculation of accepted and dropped spans through {@link org.springframework.boot.actuate.metrics.CounterService}
spring.sleuth.metric.span.accepted-namecounter.span.accepted
spring.sleuth.metric.span.dropped-namecounter.span.dropped
spring.sleuth.rxjava.schedulers.hook.enabledtrueEnable support for RxJava via RxJavaSchedulersHook.
spring.sleuth.rxjava.schedulers.ignoredthreads[HystrixMetricPoller, ^RxComputation.*$]Thread names for which spans will not be sampled.
spring.sleuth.sampler.percentage0.1Percentage of requests that should be sampled. E.g. 1.0 - 100% requests should be sampled. The precision is whole-numbers only (i.e. there’s no support for 0.1% of the traces).
spring.sleuth.scheduled.enabledtrueEnable tracing for {@link org.springframework.scheduling.annotation.Scheduled}.
spring.sleuth.scheduled.skip-pattern Pattern for the fully qualified name of a class that should be skipped.
spring.sleuth.supports-jointrueWhen true, your tracing system allows sharing a span ID between a client and server span
spring.sleuth.trace-id128falseWhen true, generate 128-bit trace IDs instead of 64-bit ones.
spring.sleuth.web.client.enabledtrueEnable interceptor injecting into {@link org.springframework.web.client.RestTemplate}
spring.sleuth.web.enabledtrueWhen true enables instrumentation for web applications
spring.sleuth.web.filter-order Order in which the {@link TraceFilter} should be registered. Defaults to {@link TraceFilter#ORDER}
spring.sleuth.web.skip-pattern/api-docs.*/autoconfig
/configprops/dump/health
/info/metrics.*/mappings
/trace/swagger.*.*.png
.*.css.*.js.*.html
/favicon.ico/hystrix.streamPattern for URLs that should be skipped in tracing
spring.sleuth.zuul.enabledtrueEnable span information propagation when using Zuul.
stubrunner.classifierstubsThe classifier to use by default in ivy co-ordinates for a stub.
stubrunner.consumer-name You can override the default {@code spring.application.name} of this field by setting a value to this parameter.
stubrunner.ids[]The ids of the stubs to run in "ivy" notation ([groupId]:artifactId:[version]:[classifier][:port]). {@code groupId}, {@code classifier}, {@code version} and {@code port} can be optional.
stubrunner.ids-to-service-ids Mapping of Ivy notation based ids to serviceIds inside your application Example "a:b" → "myService" "artifactId" → "myOtherService"
stubrunner.mappings-output-folder Dumps the mappings of each HTTP server to the selected folder
stubrunner.max-port15000Max value of a port for the automatically started WireMock server
stubrunner.min-port10000Min value of a port for the automatically started WireMock server
stubrunner.password Repository password
stubrunner.proxy-host Repository proxy host
stubrunner.proxy-port Repository proxy port
stubrunner.repository-root The repository root to use (where the stubs should be downloaded from)
stubrunner.stubs-per-consumerfalseShould only stubs for this particular consumer get registered in HTTP server stub.
stubrunner.username Repository username
stubrunner.work-offlinefalseShould the stubs be checked for presence only locally
turbine.stream.enabledtrueEnables Autoconfiguration for a Spring Cloud Turbine using Spring Cloud Stream.
zuul.add-host-headerfalseFlag to determine whether the proxy forwards the Host header.
zuul.add-proxy-headerstrueFlag to determine whether the proxy adds X-Forwarded-* headers.
zuul.force-original-query-string-encodingfalseFlag to force the original query string encoding when building the backend URI in SimpleHostRoutingFilter. When activated, query string will be built using HttpServletRequest getQueryString() method instead of UriTemplate. Note that this flag is not used in RibbonRoutingFilter with services found via DiscoveryClient (like Eureka).
zuul.host.connect-timeout-millis2000The connection timeout in millis. Defaults to 2000.
zuul.host.max-per-route-connections20The maximum number of connections that can be used by a single route.
zuul.host.max-total-connections200The maximum number of total connections the proxy can hold open to backends.
zuul.host.socket-timeout-millis10000The socket timeout in millis. Defaults to 10000.
zuul.host.time-to-live-1The lifetime for the connection pool.
zuul.host.time-unit The time unit for timeToLive.
zuul.ignore-local-servicetrue
zuul.ignore-security-headerstrueFlag to say that SECURITY_HEADERS are added to ignored headers if spring security is on the classpath. By setting ignoreSecurityHeaders to false we can switch off this default behaviour. This should be used together with disabling the default spring security headers see https://docs.spring.io/spring-security/site/docs/current/reference/html/headers.html#default-security-headers
zuul.ignored-headers Names of HTTP headers to ignore completely (i.e. leave them out of downstream requests and drop them from downstream responses).
zuul.ignored-patterns
zuul.ignored-services Set of service names not to consider for proxying automatically. By default all services in the discovery client will be proxied.
zuul.include-debug-headerfalseSetting for SendResponseFilter to conditionally include X-Zuul-Debug-Header header.
zuul.initial-stream-buffer-size8192Setting for SendResponseFilter for the initial stream buffer size.
zuul.prefix A common prefix for all routes.
zuul.remove-semicolon-contenttrueFlag to say that path elements past the first semicolon can be dropped.
zuul.retryablefalseFlag for whether retry is supported by default (assuming the routes themselves support it).
zuul.ribbon-isolation-strategy
zuul.ribbon.eager-load.enabledfalseEnables eager loading of Ribbon clients on startup.
zuul.routes Map of route names to properties.
zuul.semaphore.max-semaphores100The maximum number of total semaphores for Hystrix.
zuul.sensitive-headers List of sensitive headers that are not passed to downstream requests. Defaults to a "safe" set of headers that commonly contain user credentials. It’s OK to remove those from the list if the downstream service is part of the same system as the proxy, so they are sharing authentication data. If using a physical URL outside your own domain, then generally it would be a bad idea to leak user credentials.
zuul.servlet-path/zuulPath to install Zuul as a servlet (not part of Spring MVC). The servlet is more memory efficient for requests with large bodies, e.g. file uploads.
zuul.set-content-lengthfalseSetting for SendResponseFilter to conditionally set Content-Length header.
zuul.ssl-hostname-validation-enabledtrueFlag to say whether the hostname for ssl connections should be verified or not. Default is true. This should only be used in test setups!
zuul.strip-prefixtrueFlag saying whether to strip the prefix from the path before forwarding.
zuul.thread-pool.thread-pool-key-prefix A prefix for HystrixThreadPoolKey of hystrix’s thread pool that is allocated to each service Id. This property is only applicable when using THREAD as ribbonIsolationStrategy and useSeparateThreadPools = true
zuul.thread-pool.use-separate-thread-poolsfalseFlag to determine whether RibbonCommands should use separate thread pools for hystrix. By setting to true, RibbonCommands will be executed in a hystrix’s thread pool that it is associated with. Each RibbonCommand will be associated with a thread pool according to its commandKey (serviceId). As default, all commands will be executed in a single thread pool whose threadPoolKey is "RibbonCommand". This property is only applicable when using THREAD as ribbonIsolationStrategy
zuul.trace-request-bodytrueFlag to say that request bodies can be traced.