Micronaut Discovery Client Configuration Reference

Every documented configuration property of Micronaut Discovery Client, with types, descriptions, and defaults.

Micronaut Discovery Client documentation

349 properties across 1 section

Micronaut Discovery Client Config Properties

Configuration properties for ConsulConfiguration

PropertyTypeDescription
consul.client.http-versionHttpVersion
consul.client.log-levelLogLevel
consul.client.event-loop-groupjava.lang.String
consul.client.ssl-configurationSslConfiguration
consul.client.follow-redirectsboolean
consul.client.exception-on-error-statusboolean
consul.client.decompression-enabledboolean
consul.client.logger-namejava.lang.String
consul.client.redirect-always-filtered-headersjava.util.Set
consul.client.redirect-additional-non-preserve-body-filtered-headersjava.util.Set
consul.client.redirect-cross-origin-filtered-headersjava.util.Set
consul.client.max-redirectsint
consul.client.default-charsetjava.nio.charset.Charset
consul.client.channel-optionsjava.util.Map
consul.client.read-timeoutjava.time.Duration
consul.client.request-timeoutjava.time.Duration
consul.client.read-idle-timeoutjava.time.Duration
consul.client.connection-pool-idle-timeoutjava.time.Duration
consul.client.connect-timeoutjava.time.Duration
consul.client.connect-ttljava.time.Duration
consul.client.shutdown-quiet-periodjava.time.Duration
consul.client.shutdown-timeoutjava.time.Duration
consul.client.num-of-threadsjava.lang.Integer
consul.client.thread-factoryjava.lang.Class
consul.client.max-content-lengthint
consul.client.max-header-sizeint
consul.client.max-initial-line-lengthint
consul.client.max-chunk-sizeint
consul.client.proxy-typejava.net.Proxy$Type
consul.client.proxy-addressjava.net.SocketAddress
consul.client.proxy-usernamejava.lang.String
consul.client.proxy-passwordjava.lang.String
consul.client.proxy-selectorjava.net.ProxySelector
consul.client.plaintext-modeHttpVersionSelection$PlaintextMode
consul.client.alpn-modesjava.util.List
consul.client.allow-block-event-loopboolean
consul.client.dns-resolution-modeHttpClientConfiguration$DnsResolutionMode
consul.client.address-resolver-group-namejava.lang.String
consul.client.pcap-logging-path-patternjava.lang.String
consul.client.should-use-dnsbooleanWhether DNS should be used to resolve the discovery servers.
consul.client.context-pathjava.lang.StringSets the context path.
consul.client.default-zonejava.util.ListSets the Discovery servers to use for the default zone.
consul.client.zonesjava.util.MapConfigures Discovery servers in other zones.
consul.client.securebooleanIs the discovery server exposed over HTTPS (defaults to false)
consul.client.hostjava.lang.StringThe Discovery server instance host name. Defaults to 'localhost'.
consul.client.portintThe default Discovery server port
consul.client.health-checkbooleanSets whether the Consul server should be considered for health checks.
consul.client.asl-tokenjava.lang.StringThe token to include in all requests as the {@code X-Consul-Token} header
consul.client.acl-tokenjava.lang.StringThe token to include in all requests as the {@code X-Consul-Token} header

Configuration properties for BlockingQueriesConfiguration

PropertyTypeDescription
consul.client.blocking-queries.http-versionHttpVersion
consul.client.blocking-queries.log-levelLogLevel
consul.client.blocking-queries.event-loop-groupjava.lang.String
consul.client.blocking-queries.ssl-configurationSslConfiguration
consul.client.blocking-queries.follow-redirectsboolean
consul.client.blocking-queries.exception-on-error-statusboolean
consul.client.blocking-queries.decompression-enabledboolean
consul.client.blocking-queries.logger-namejava.lang.String
consul.client.blocking-queries.redirect-always-filtered-headersjava.util.Set
consul.client.blocking-queries.redirect-additional-non-preserve-body-filtered-headersjava.util.Set
consul.client.blocking-queries.redirect-cross-origin-filtered-headersjava.util.Set
consul.client.blocking-queries.max-redirectsint
consul.client.blocking-queries.default-charsetjava.nio.charset.Charset
consul.client.blocking-queries.channel-optionsjava.util.Map
consul.client.blocking-queries.request-timeoutjava.time.Duration
consul.client.blocking-queries.read-idle-timeoutjava.time.Duration
consul.client.blocking-queries.connection-pool-idle-timeoutjava.time.Duration
consul.client.blocking-queries.connect-timeoutjava.time.Duration
consul.client.blocking-queries.connect-ttljava.time.Duration
consul.client.blocking-queries.shutdown-quiet-periodjava.time.Duration
consul.client.blocking-queries.shutdown-timeoutjava.time.Duration
consul.client.blocking-queries.read-timeoutjava.time.DurationThe read timeout, depending on the {@link #maxWaitDuration} value.
consul.client.blocking-queries.num-of-threadsjava.lang.Integer
consul.client.blocking-queries.thread-factoryjava.lang.Class
consul.client.blocking-queries.max-content-lengthint
consul.client.blocking-queries.max-header-sizeint
consul.client.blocking-queries.max-initial-line-lengthint
consul.client.blocking-queries.max-chunk-sizeint
consul.client.blocking-queries.proxy-typejava.net.Proxy$Type
consul.client.blocking-queries.proxy-addressjava.net.SocketAddress
consul.client.blocking-queries.proxy-usernamejava.lang.String
consul.client.blocking-queries.proxy-passwordjava.lang.String
consul.client.blocking-queries.proxy-selectorjava.net.ProxySelector
consul.client.blocking-queries.plaintext-modeHttpVersionSelection$PlaintextMode
consul.client.blocking-queries.alpn-modesjava.util.List
consul.client.blocking-queries.allow-block-event-loopboolean
consul.client.blocking-queries.dns-resolution-modeHttpClientConfiguration$DnsResolutionMode
consul.client.blocking-queries.address-resolver-group-namejava.lang.String
consul.client.blocking-queries.pcap-logging-path-patternjava.lang.String
consul.client.blocking-queries.max-wait-durationjava.lang.StringSpecify the maximum duration for the blocking request. Default value ("10m").
consul.client.blocking-queries.delay-durationjava.time.DurationSets the delay before each call to avoid flooding. Default value (50 milliseconds).

Configuration properties for ConsulConfiguration$ConsulConfigDiscoveryConfiguration

PropertyTypeDescription
consul.client.config.enabledboolean
consul.client.config.pathjava.lang.String
consul.client.config.formatConfigDiscoveryConfiguration$Format
consul.client.config.datacenterjava.lang.StringThe data center name

Configuration properties for ConsulConfiguration$ConsulDiscoveryConfiguration

PropertyTypeDescription
consul.client.discovery.enabledboolean
consul.client.discovery.passingbooleanTrue if only passing services should be returned (defaults to false)
consul.client.discovery.tagsjava.util.MapThe tags
consul.client.discovery.datacentersjava.util.MapThe map to query
consul.client.discovery.schemesjava.util.MapA map of schemes

Configuration properties for ConsulConfiguration$ConsulConnectionPoolConfiguration

PropertyTypeDescription
consul.client.pool.enabledboolean
consul.client.pool.max-pending-acquiresint
consul.client.pool.acquire-timeoutjava.time.Duration
consul.client.pool.max-pending-connectionsint
consul.client.pool.max-concurrent-requests-per-http2-connectionint
consul.client.pool.max-concurrent-http1-connectionsint
consul.client.pool.max-concurrent-http2-connectionsint
consul.client.pool.connection-localityHttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality
consul.client.pool.versionHttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion

Configuration properties for ConsulConfiguration$ConsulRegistrationConfiguration

PropertyTypeDescription
consul.client.registration.ip-addrjava.lang.String
consul.client.registration.prefer-ip-addressboolean
consul.client.registration.timeoutjava.time.Duration
consul.client.registration.fail-fastboolean
consul.client.registration.deregisterboolean
consul.client.registration.enabledboolean
consul.client.registration.retry-countint
consul.client.registration.retry-delayjava.time.Duration
consul.client.registration.health-pathjava.lang.String
consul.client.registration.tagsjava.util.ListThat tags to use for registering the service
consul.client.registration.metajava.util.MapThat metadata to use for registering the service

Configuration properties for ConsulConfiguration$ConsulRegistrationConfiguration$CheckConfiguration

PropertyTypeDescription
consul.client.registration.check.intervaljava.time.DurationDefault value (15).
consul.client.registration.check.httpbooleanDefault value (false).
consul.client.registration.check.enabledbooleanDefault value (true).
consul.client.registration.check.deregister-critical-service-afterjava.time.DurationSpecifies that checks associated with a service should deregister after this time
consul.client.registration.check.idjava.lang.StringSpecifies a unique ID for this check on the node
consul.client.registration.check.notesjava.lang.StringArbitrary information for humans. Not used by Consult
consul.client.registration.check.tls-skip-verifyjava.lang.BooleanSpecifies if the certificate for an HTTPS check should not be verified
consul.client.registration.check.methodHttpMethodSpecifies a different HTTP method to be used for an HTTP check.
consul.client.registration.check.headersjava.util.MapSpecifies a set of headers that should be set for HTTP checks

Configuration properties for WatchConfiguration

PropertyTypeDescription
consul.client.watch.enabledbooleanSets whether Configuration watching is enabled. Default value (false).
consul.client.watch.imported-pathsjava.lang.StringSets the explicit Consul KV paths supplied by importer metadata.
consul.client.watch.imported-formatjava.lang.StringSets the Consul configuration format supplied by importer metadata.

Configuration properties for EurekaConfiguration

PropertyTypeDescription
eureka.client.http-versionHttpVersion
eureka.client.log-levelLogLevel
eureka.client.event-loop-groupjava.lang.String
eureka.client.ssl-configurationSslConfiguration
eureka.client.follow-redirectsboolean
eureka.client.exception-on-error-statusboolean
eureka.client.decompression-enabledboolean
eureka.client.logger-namejava.lang.String
eureka.client.redirect-always-filtered-headersjava.util.Set
eureka.client.redirect-additional-non-preserve-body-filtered-headersjava.util.Set
eureka.client.redirect-cross-origin-filtered-headersjava.util.Set
eureka.client.max-redirectsint
eureka.client.default-charsetjava.nio.charset.Charset
eureka.client.channel-optionsjava.util.Map
eureka.client.read-timeoutjava.time.Duration
eureka.client.request-timeoutjava.time.Duration
eureka.client.read-idle-timeoutjava.time.Duration
eureka.client.connection-pool-idle-timeoutjava.time.Duration
eureka.client.connect-timeoutjava.time.Duration
eureka.client.connect-ttljava.time.Duration
eureka.client.shutdown-quiet-periodjava.time.Duration
eureka.client.shutdown-timeoutjava.time.Duration
eureka.client.num-of-threadsjava.lang.Integer
eureka.client.thread-factoryjava.lang.Class
eureka.client.max-content-lengthint
eureka.client.max-header-sizeint
eureka.client.max-initial-line-lengthint
eureka.client.max-chunk-sizeint
eureka.client.proxy-typejava.net.Proxy$Type
eureka.client.proxy-addressjava.net.SocketAddress
eureka.client.proxy-usernamejava.lang.String
eureka.client.proxy-passwordjava.lang.String
eureka.client.proxy-selectorjava.net.ProxySelector
eureka.client.plaintext-modeHttpVersionSelection$PlaintextMode
eureka.client.alpn-modesjava.util.List
eureka.client.allow-block-event-loopboolean
eureka.client.dns-resolution-modeHttpClientConfiguration$DnsResolutionMode
eureka.client.address-resolver-group-namejava.lang.String
eureka.client.pcap-logging-path-patternjava.lang.String
eureka.client.should-use-dnsbooleanWhether DNS should be used to resolve the discovery servers.
eureka.client.context-pathjava.lang.StringSets the context path.
eureka.client.default-zonejava.util.ListSets the Discovery servers to use for the default zone.
eureka.client.zonesjava.util.MapConfigures Discovery servers in other zones.
eureka.client.securebooleanIs the discovery server exposed over HTTPS (defaults to false)
eureka.client.hostjava.lang.StringThe Discovery server instance host name. Defaults to 'localhost'.
eureka.client.portintThe default Discovery server port

Configuration properties for EurekaConfiguration$EurekaDiscoveryConfiguration

PropertyTypeDescription
eureka.client.discovery.enabledboolean
eureka.client.discovery.use-secure-portbooleanSets whether the secure port is used for communication.

Configuration properties for EurekaConfiguration$EurekaConnectionPoolConfiguration

PropertyTypeDescription
eureka.client.pool.enabledboolean
eureka.client.pool.max-pending-acquiresint
eureka.client.pool.acquire-timeoutjava.time.Duration
eureka.client.pool.max-pending-connectionsint
eureka.client.pool.max-concurrent-requests-per-http2-connectionint
eureka.client.pool.max-concurrent-http1-connectionsint
eureka.client.pool.max-concurrent-http2-connectionsint
eureka.client.pool.connection-localityHttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality
eureka.client.pool.versionHttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion

Configuration properties for EurekaConfiguration$EurekaRegistrationConfiguration

PropertyTypeDescription
eureka.client.registration.ip-addrjava.lang.String
eureka.client.registration.prefer-ip-addressboolean
eureka.client.registration.timeoutjava.time.Duration
eureka.client.registration.fail-fastboolean
eureka.client.registration.deregisterboolean
eureka.client.registration.enabledboolean
eureka.client.registration.retry-countint
eureka.client.registration.retry-delayjava.time.Duration
eureka.client.registration.health-pathjava.lang.String

Configuration properties for InstanceInfo

PropertyTypeDescription
eureka.client.registration.portint
eureka.client.registration.secure-portint
eureka.client.registration.app-group-namejava.lang.String
eureka.client.registration.instance-idjava.lang.String
eureka.client.registration.country-idint
eureka.client.registration.statusInstanceInfo$Status
eureka.client.registration.data-center-infoDataCenterInfo
eureka.client.registration.lease-infoLeaseInfo
eureka.client.registration.metadatajava.util.Map
eureka.client.registration.status-page-urljava.lang.String
eureka.client.registration.home-page-urljava.lang.String
eureka.client.registration.health-check-urljava.lang.String
eureka.client.registration.vip-addressjava.lang.String
eureka.client.registration.secure-vip-addressjava.lang.String
eureka.client.registration.secure-health-check-urljava.lang.String
eureka.client.registration.asg-namejava.lang.String

Configuration properties for InstanceInfo

PropertyTypeDescription
eureka.client.registration.portint
eureka.client.registration.secure-portint
eureka.client.registration.app-group-namejava.lang.String
eureka.client.registration.instance-idjava.lang.String
eureka.client.registration.country-idint
eureka.client.registration.statusInstanceInfo$Status
eureka.client.registration.data-center-infoDataCenterInfo
eureka.client.registration.lease-infoLeaseInfo
eureka.client.registration.metadatajava.util.Map
eureka.client.registration.status-page-urljava.lang.String
eureka.client.registration.home-page-urljava.lang.String
eureka.client.registration.health-check-urljava.lang.String
eureka.client.registration.vip-addressjava.lang.String
eureka.client.registration.secure-vip-addressjava.lang.String
eureka.client.registration.secure-health-check-urljava.lang.String
eureka.client.registration.asg-namejava.lang.String

Configuration properties for LeaseInfo$Builder

PropertyTypeDescription
eureka.client.registration.lease-info.registration-timestamplong
eureka.client.registration.lease-info.renewal-timestamplong
eureka.client.registration.lease-info.eviction-timestamplong
eureka.client.registration.lease-info.service-up-timestamplong
eureka.client.registration.lease-info.duration-in-secsint
eureka.client.registration.lease-info.renewal-interval-in-secsint

Configuration properties for SpringCloudClientConfiguration

PropertyTypeDescription
spring.cloud.config.http-versionHttpVersion
spring.cloud.config.log-levelLogLevel
spring.cloud.config.event-loop-groupjava.lang.String
spring.cloud.config.ssl-configurationSslConfiguration
spring.cloud.config.follow-redirectsboolean
spring.cloud.config.exception-on-error-statusboolean
spring.cloud.config.decompression-enabledboolean
spring.cloud.config.logger-namejava.lang.String
spring.cloud.config.redirect-always-filtered-headersjava.util.Set
spring.cloud.config.redirect-additional-non-preserve-body-filtered-headersjava.util.Set
spring.cloud.config.redirect-cross-origin-filtered-headersjava.util.Set
spring.cloud.config.max-redirectsint
spring.cloud.config.default-charsetjava.nio.charset.Charset
spring.cloud.config.channel-optionsjava.util.Map
spring.cloud.config.read-timeoutjava.time.Duration
spring.cloud.config.request-timeoutjava.time.Duration
spring.cloud.config.read-idle-timeoutjava.time.Duration
spring.cloud.config.connection-pool-idle-timeoutjava.time.Duration
spring.cloud.config.connect-timeoutjava.time.Duration
spring.cloud.config.connect-ttljava.time.Duration
spring.cloud.config.shutdown-quiet-periodjava.time.Duration
spring.cloud.config.shutdown-timeoutjava.time.Duration
spring.cloud.config.num-of-threadsjava.lang.Integer
spring.cloud.config.thread-factoryjava.lang.Class
spring.cloud.config.max-content-lengthint
spring.cloud.config.max-header-sizeint
spring.cloud.config.max-initial-line-lengthint
spring.cloud.config.max-chunk-sizeint
spring.cloud.config.proxy-typejava.net.Proxy$Type
spring.cloud.config.proxy-addressjava.net.SocketAddress
spring.cloud.config.proxy-usernamejava.lang.String
spring.cloud.config.proxy-passwordjava.lang.String
spring.cloud.config.proxy-selectorjava.net.ProxySelector
spring.cloud.config.plaintext-modeHttpVersionSelection$PlaintextMode
spring.cloud.config.alpn-modesjava.util.List
spring.cloud.config.allow-block-event-loopboolean
spring.cloud.config.dns-resolution-modeHttpClientConfiguration$DnsResolutionMode
spring.cloud.config.address-resolver-group-namejava.lang.String
spring.cloud.config.pcap-logging-path-patternjava.lang.String
spring.cloud.config.urijava.lang.StringSet the Spring Cloud config server uri. Default value ("http://localhost:8888").
spring.cloud.config.labeljava.lang.StringSet the Spring Cloud config server label.
spring.cloud.config.namejava.lang.StringSet the Spring Cloud config server name.
spring.cloud.config.usernamejava.lang.StringSet the Spring cloud config username.
spring.cloud.config.passwordjava.lang.StringSet the Spring cloud config password.
spring.cloud.config.fail-fastbooleanIf set to true an exception will be thrown if configuration is not found. Default value (false).

Configuration properties for SpringCloudClientConfiguration$SpringConfigDiscoveryConfiguration

PropertyTypeDescription
spring.cloud.config.config.enabledboolean
spring.cloud.config.config.pathjava.lang.String
spring.cloud.config.config.formatConfigDiscoveryConfiguration$Format

Configuration properties for SpringCloudClientConfiguration$SpringCloudConnectionPoolConfiguration

PropertyTypeDescription
spring.cloud.config.pool.enabledboolean
spring.cloud.config.pool.max-pending-acquiresint
spring.cloud.config.pool.acquire-timeoutjava.time.Duration
spring.cloud.config.pool.max-pending-connectionsint
spring.cloud.config.pool.max-concurrent-requests-per-http2-connectionint
spring.cloud.config.pool.max-concurrent-http1-connectionsint
spring.cloud.config.pool.max-concurrent-http2-connectionsint
spring.cloud.config.pool.connection-localityHttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality
spring.cloud.config.pool.versionHttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion

Configuration properties for VaultClientConfiguration

PropertyTypeDescription
vault.client.http-versionHttpVersion
vault.client.log-levelLogLevel
vault.client.event-loop-groupjava.lang.String
vault.client.ssl-configurationSslConfiguration
vault.client.follow-redirectsboolean
vault.client.exception-on-error-statusboolean
vault.client.decompression-enabledboolean
vault.client.logger-namejava.lang.String
vault.client.redirect-always-filtered-headersjava.util.Set
vault.client.redirect-additional-non-preserve-body-filtered-headersjava.util.Set
vault.client.redirect-cross-origin-filtered-headersjava.util.Set
vault.client.max-redirectsint
vault.client.default-charsetjava.nio.charset.Charset
vault.client.channel-optionsjava.util.Map
vault.client.read-timeoutjava.time.Duration
vault.client.request-timeoutjava.time.Duration
vault.client.read-idle-timeoutjava.time.Duration
vault.client.connection-pool-idle-timeoutjava.time.Duration
vault.client.connect-timeoutjava.time.Duration
vault.client.connect-ttljava.time.Duration
vault.client.shutdown-quiet-periodjava.time.Duration
vault.client.shutdown-timeoutjava.time.Duration
vault.client.num-of-threadsjava.lang.Integer
vault.client.thread-factoryjava.lang.Class
vault.client.max-content-lengthint
vault.client.max-header-sizeint
vault.client.max-initial-line-lengthint
vault.client.max-chunk-sizeint
vault.client.proxy-typejava.net.Proxy$Type
vault.client.proxy-addressjava.net.SocketAddress
vault.client.proxy-usernamejava.lang.String
vault.client.proxy-passwordjava.lang.String
vault.client.proxy-selectorjava.net.ProxySelector
vault.client.plaintext-modeHttpVersionSelection$PlaintextMode
vault.client.alpn-modesjava.util.List
vault.client.allow-block-event-loopboolean
vault.client.dns-resolution-modeHttpClientConfiguration$DnsResolutionMode
vault.client.address-resolver-group-namejava.lang.String
vault.client.pcap-logging-path-patternjava.lang.String
vault.client.urijava.lang.StringSet the Vault Server Uri. Default value ("http://locahost:8200").
vault.client.tokenjava.lang.StringSet the Vault authentication token.
vault.client.kv-versionVaultClientConfiguration$VaultKvVersionSet the version of the Vault Secret engine. V1 or V2. Default value (V2).
vault.client.secret-engine-namejava.lang.StringSet the name of the Vault Secret engine name. Default value ("secret").
vault.client.path-prefixjava.lang.StringSet the prefix for the keys used to get vault properties. Default value is empty string
vault.client.fail-fastbooleanIf set to true an exception will be thrown if configuration is not found for the application or any of its environments. Default value (false).

Configuration properties for VaultClientConfiguration$VaultClientDiscoveryConfiguration

PropertyTypeDescription
vault.client.config.enabledboolean
vault.client.config.pathjava.lang.String
vault.client.config.formatConfigDiscoveryConfiguration$Format

Configuration properties for VaultClientConfiguration$VaultClientConnectionPoolConfiguration

PropertyTypeDescription
vault.client.pool.enabledboolean
vault.client.pool.max-pending-acquiresint
vault.client.pool.acquire-timeoutjava.time.Duration
vault.client.pool.max-pending-connectionsint
vault.client.pool.max-concurrent-requests-per-http2-connectionint
vault.client.pool.max-concurrent-http1-connectionsint
vault.client.pool.max-concurrent-http2-connectionsint
vault.client.pool.connection-localityHttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality
vault.client.pool.versionHttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion