Configuration Reference

Version:5.0.0-SNAPSHOT

Micronaut Discovery Client Config Properties

🔗
Table 1. Configuration Properties for ConsulConfiguration
Property Type Description Default value

consul.client.http-version

HttpVersion

consul.client.log-level

LogLevel

consul.client.event-loop-group

java.lang.String

consul.client.ssl-configuration

SslConfiguration

consul.client.follow-redirects

boolean

consul.client.exception-on-error-status

boolean

consul.client.logger-name

java.lang.String

consul.client.default-charset

java.nio.charset.Charset

consul.client.channel-options

java.util.Map

consul.client.read-timeout

java.time.Duration

consul.client.request-timeout

java.time.Duration

consul.client.read-idle-timeout

java.time.Duration

consul.client.connection-pool-idle-timeout

java.time.Duration

consul.client.connect-timeout

java.time.Duration

consul.client.connect-ttl

java.time.Duration

consul.client.shutdown-quiet-period

java.time.Duration

consul.client.shutdown-timeout

java.time.Duration

consul.client.num-of-threads

java.lang.Integer

consul.client.thread-factory

java.lang.Class

consul.client.max-content-length

int

consul.client.proxy-type

java.net.Proxy$Type

consul.client.proxy-address

java.net.SocketAddress

consul.client.proxy-username

java.lang.String

consul.client.proxy-password

java.lang.String

consul.client.proxy-selector

java.net.ProxySelector

consul.client.plaintext-mode

HttpVersionSelection$PlaintextMode

consul.client.alpn-modes

java.util.List

consul.client.allow-block-event-loop

boolean

consul.client.dns-resolution-mode

HttpClientConfiguration$DnsResolutionMode

consul.client.address-resolver-group-name

java.lang.String

consul.client.pcap-logging-path-pattern

java.lang.String

consul.client.should-use-dns

boolean

Whether DNS should be used to resolve the discovery servers.

consul.client.context-path

java.lang.String

Sets the context path.

consul.client.default-zone

java.util.List

Sets the Discovery servers to use for the default zone.

consul.client.zones

java.util.Map

Configures Discovery servers in other zones.

consul.client.secure

boolean

Is the discovery server exposed over HTTPS (defaults to false)

consul.client.host

java.lang.String

The Discovery server instance host name. Defaults to 'localhost'.

consul.client.port

int

The default Discovery server port

consul.client.health-check

boolean

Sets whether the Consul server should be considered for health checks.

consul.client.asl-token

java.lang.String

The token to include in all requests as the {@code X-Consul-Token} header

🔗
Table 2. Configuration Properties for BlockingQueriesConfiguration
Property Type Description Default value

consul.client.blocking-queries.http-version

HttpVersion

consul.client.blocking-queries.log-level

LogLevel

consul.client.blocking-queries.event-loop-group

java.lang.String

consul.client.blocking-queries.ssl-configuration

SslConfiguration

consul.client.blocking-queries.follow-redirects

boolean

consul.client.blocking-queries.exception-on-error-status

boolean

consul.client.blocking-queries.logger-name

java.lang.String

consul.client.blocking-queries.default-charset

java.nio.charset.Charset

consul.client.blocking-queries.channel-options

java.util.Map

consul.client.blocking-queries.request-timeout

java.time.Duration

consul.client.blocking-queries.read-idle-timeout

java.time.Duration

consul.client.blocking-queries.connection-pool-idle-timeout

java.time.Duration

consul.client.blocking-queries.connect-timeout

java.time.Duration

consul.client.blocking-queries.connect-ttl

java.time.Duration

consul.client.blocking-queries.shutdown-quiet-period

java.time.Duration

consul.client.blocking-queries.shutdown-timeout

java.time.Duration

consul.client.blocking-queries.read-timeout

java.time.Duration

The read timeout, depending on the {@link #maxWaitDuration} value.

consul.client.blocking-queries.num-of-threads

java.lang.Integer

consul.client.blocking-queries.thread-factory

java.lang.Class

consul.client.blocking-queries.max-content-length

int

consul.client.blocking-queries.proxy-type

java.net.Proxy$Type

consul.client.blocking-queries.proxy-address

java.net.SocketAddress

consul.client.blocking-queries.proxy-username

java.lang.String

consul.client.blocking-queries.proxy-password

java.lang.String

consul.client.blocking-queries.proxy-selector

java.net.ProxySelector

consul.client.blocking-queries.plaintext-mode

HttpVersionSelection$PlaintextMode

consul.client.blocking-queries.alpn-modes

java.util.List

consul.client.blocking-queries.allow-block-event-loop

boolean

consul.client.blocking-queries.dns-resolution-mode

HttpClientConfiguration$DnsResolutionMode

consul.client.blocking-queries.address-resolver-group-name

java.lang.String

consul.client.blocking-queries.pcap-logging-path-pattern

java.lang.String

consul.client.blocking-queries.max-wait-duration

java.lang.String

Specify the maximum duration for the blocking request. Default value ("10m").

consul.client.blocking-queries.delay-duration

java.time.Duration

Sets the delay before each call to avoid flooding. Default value (50 milliseconds).

🔗
Table 3. Configuration Properties for ConsulConfiguration$ConsulConfigDiscoveryConfiguration
Property Type Description Default value

consul.client.config.enabled

boolean

consul.client.config.path

java.lang.String

consul.client.config.format

ConfigDiscoveryConfiguration$Format

consul.client.config.datacenter

java.lang.String

The data center name

🔗
Table 4. Configuration Properties for ConsulConfiguration$ConsulDiscoveryConfiguration
Property Type Description Default value

consul.client.discovery.enabled

boolean

consul.client.discovery.passing

boolean

True if only passing services should be returned (defaults to false)

consul.client.discovery.tags

java.util.Map

The tags

consul.client.discovery.datacenters

java.util.Map

The map to query

consul.client.discovery.schemes

java.util.Map

A map of schemes

🔗
Table 5. Configuration Properties for ConsulConfiguration$ConsulConnectionPoolConfiguration
Property Type Description Default value

consul.client.pool.enabled

boolean

consul.client.pool.max-pending-acquires

int

consul.client.pool.acquire-timeout

java.time.Duration

consul.client.pool.max-pending-connections

int

consul.client.pool.max-concurrent-requests-per-http2-connection

int

consul.client.pool.max-concurrent-http1-connections

int

consul.client.pool.max-concurrent-http2-connections

int

consul.client.pool.connection-locality

HttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality

consul.client.pool.version

HttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion

🔗
Table 6. Configuration Properties for ConsulConfiguration$ConsulRegistrationConfiguration
Property Type Description Default value

consul.client.registration.ip-addr

java.lang.String

consul.client.registration.prefer-ip-address

boolean

consul.client.registration.timeout

java.time.Duration

consul.client.registration.fail-fast

boolean

consul.client.registration.deregister

boolean

consul.client.registration.enabled

boolean

consul.client.registration.retry-count

int

consul.client.registration.retry-delay

java.time.Duration

consul.client.registration.health-path

java.lang.String

consul.client.registration.tags

java.util.List

That tags to use for registering the service

consul.client.registration.meta

java.util.Map

That metadata to use for registering the service

🔗
Table 7. Configuration Properties for ConsulConfiguration$ConsulRegistrationConfiguration$CheckConfiguration
Property Type Description Default value

consul.client.registration.check.interval

java.time.Duration

Default value (15).

consul.client.registration.check.http

boolean

Default value (false).

consul.client.registration.check.enabled

boolean

Default value (true).

consul.client.registration.check.deregister-critical-service-after

java.time.Duration

Specifies that checks associated with a service should deregister after this time

consul.client.registration.check.id

java.lang.String

Specifies a unique ID for this check on the node

consul.client.registration.check.notes

java.lang.String

Arbitrary information for humans. Not used by Consult

consul.client.registration.check.tls-skip-verify

java.lang.Boolean

Specifies if the certificate for an HTTPS check should not be verified

consul.client.registration.check.method

HttpMethod

Specifies a different HTTP method to be used for an HTTP check.

consul.client.registration.check.headers

java.util.Map

Specifies a set of headers that should be set for HTTP checks

🔗
Table 8. Configuration Properties for WatchConfiguration
Property Type Description Default value

consul.client.watch.enabled

boolean

Sets whether Configuration watching is enabled. Default value (false).

🔗
Table 9. Configuration Properties for EurekaConfiguration
Property Type Description Default value

eureka.client.http-version

HttpVersion

eureka.client.log-level

LogLevel

eureka.client.event-loop-group

java.lang.String

eureka.client.ssl-configuration

SslConfiguration

eureka.client.follow-redirects

boolean

eureka.client.exception-on-error-status

boolean

eureka.client.logger-name

java.lang.String

eureka.client.default-charset

java.nio.charset.Charset

eureka.client.channel-options

java.util.Map

eureka.client.read-timeout

java.time.Duration

eureka.client.request-timeout

java.time.Duration

eureka.client.read-idle-timeout

java.time.Duration

eureka.client.connection-pool-idle-timeout

java.time.Duration

eureka.client.connect-timeout

java.time.Duration

eureka.client.connect-ttl

java.time.Duration

eureka.client.shutdown-quiet-period

java.time.Duration

eureka.client.shutdown-timeout

java.time.Duration

eureka.client.num-of-threads

java.lang.Integer

eureka.client.thread-factory

java.lang.Class

eureka.client.max-content-length

int

eureka.client.proxy-type

java.net.Proxy$Type

eureka.client.proxy-address

java.net.SocketAddress

eureka.client.proxy-username

java.lang.String

eureka.client.proxy-password

java.lang.String

eureka.client.proxy-selector

java.net.ProxySelector

eureka.client.plaintext-mode

HttpVersionSelection$PlaintextMode

eureka.client.alpn-modes

java.util.List

eureka.client.allow-block-event-loop

boolean

eureka.client.dns-resolution-mode

HttpClientConfiguration$DnsResolutionMode

eureka.client.address-resolver-group-name

java.lang.String

eureka.client.pcap-logging-path-pattern

java.lang.String

eureka.client.should-use-dns

boolean

Whether DNS should be used to resolve the discovery servers.

eureka.client.context-path

java.lang.String

Sets the context path.

eureka.client.default-zone

java.util.List

Sets the Discovery servers to use for the default zone.

eureka.client.zones

java.util.Map

Configures Discovery servers in other zones.

eureka.client.secure

boolean

Is the discovery server exposed over HTTPS (defaults to false)

eureka.client.host

java.lang.String

The Discovery server instance host name. Defaults to 'localhost'.

eureka.client.port

int

The default Discovery server port

🔗
Table 10. Configuration Properties for EurekaConfiguration$EurekaDiscoveryConfiguration
Property Type Description Default value

eureka.client.discovery.enabled

boolean

eureka.client.discovery.use-secure-port

boolean

Sets whether the secure port is used for communication.

🔗
Table 11. Configuration Properties for EurekaConfiguration$EurekaConnectionPoolConfiguration
Property Type Description Default value

eureka.client.pool.enabled

boolean

eureka.client.pool.max-pending-acquires

int

eureka.client.pool.acquire-timeout

java.time.Duration

eureka.client.pool.max-pending-connections

int

eureka.client.pool.max-concurrent-requests-per-http2-connection

int

eureka.client.pool.max-concurrent-http1-connections

int

eureka.client.pool.max-concurrent-http2-connections

int

eureka.client.pool.connection-locality

HttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality

eureka.client.pool.version

HttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion

🔗
Table 12. Configuration Properties for EurekaConfiguration$EurekaRegistrationConfiguration
Property Type Description Default value

eureka.client.registration.ip-addr

java.lang.String

eureka.client.registration.prefer-ip-address

boolean

eureka.client.registration.timeout

java.time.Duration

eureka.client.registration.fail-fast

boolean

eureka.client.registration.deregister

boolean

eureka.client.registration.enabled

boolean

eureka.client.registration.retry-count

int

eureka.client.registration.retry-delay

java.time.Duration

eureka.client.registration.health-path

java.lang.String

🔗
Table 13. Configuration Properties for InstanceInfo
Property Type Description Default value

eureka.client.registration.port

int

eureka.client.registration.secure-port

int

eureka.client.registration.app-group-name

java.lang.String

eureka.client.registration.instance-id

java.lang.String

eureka.client.registration.country-id

int

eureka.client.registration.status

InstanceInfo$Status

eureka.client.registration.data-center-info

DataCenterInfo

eureka.client.registration.lease-info

LeaseInfo

eureka.client.registration.metadata

java.util.Map

eureka.client.registration.status-page-url

java.lang.String

eureka.client.registration.home-page-url

java.lang.String

eureka.client.registration.health-check-url

java.lang.String

eureka.client.registration.vip-address

java.lang.String

eureka.client.registration.secure-vip-address

java.lang.String

eureka.client.registration.secure-health-check-url

java.lang.String

eureka.client.registration.asg-name

java.lang.String

🔗
Table 14. Configuration Properties for InstanceInfo
Property Type Description Default value

eureka.client.registration.port

int

eureka.client.registration.secure-port

int

eureka.client.registration.app-group-name

java.lang.String

eureka.client.registration.instance-id

java.lang.String

eureka.client.registration.country-id

int

eureka.client.registration.status

InstanceInfo$Status

eureka.client.registration.data-center-info

DataCenterInfo

eureka.client.registration.lease-info

LeaseInfo

eureka.client.registration.metadata

java.util.Map

eureka.client.registration.status-page-url

java.lang.String

eureka.client.registration.home-page-url

java.lang.String

eureka.client.registration.health-check-url

java.lang.String

eureka.client.registration.vip-address

java.lang.String

eureka.client.registration.secure-vip-address

java.lang.String

eureka.client.registration.secure-health-check-url

java.lang.String

eureka.client.registration.asg-name

java.lang.String

🔗
Table 15. Configuration Properties for LeaseInfo$Builder
Property Type Description Default value

eureka.client.registration.lease-info.registration-timestamp

long

eureka.client.registration.lease-info.renewal-timestamp

long

eureka.client.registration.lease-info.eviction-timestamp

long

eureka.client.registration.lease-info.service-up-timestamp

long

eureka.client.registration.lease-info.duration-in-secs

int

eureka.client.registration.lease-info.renewal-interval-in-secs

int

🔗
Table 16. Configuration Properties for SpringCloudClientConfiguration
Property Type Description Default value

spring.cloud.config.http-version

HttpVersion

spring.cloud.config.log-level

LogLevel

spring.cloud.config.event-loop-group

java.lang.String

spring.cloud.config.ssl-configuration

SslConfiguration

spring.cloud.config.follow-redirects

boolean

spring.cloud.config.exception-on-error-status

boolean

spring.cloud.config.logger-name

java.lang.String

spring.cloud.config.default-charset

java.nio.charset.Charset

spring.cloud.config.channel-options

java.util.Map

spring.cloud.config.read-timeout

java.time.Duration

spring.cloud.config.request-timeout

java.time.Duration

spring.cloud.config.read-idle-timeout

java.time.Duration

spring.cloud.config.connection-pool-idle-timeout

java.time.Duration

spring.cloud.config.connect-timeout

java.time.Duration

spring.cloud.config.connect-ttl

java.time.Duration

spring.cloud.config.shutdown-quiet-period

java.time.Duration

spring.cloud.config.shutdown-timeout

java.time.Duration

spring.cloud.config.num-of-threads

java.lang.Integer

spring.cloud.config.thread-factory

java.lang.Class

spring.cloud.config.max-content-length

int

spring.cloud.config.proxy-type

java.net.Proxy$Type

spring.cloud.config.proxy-address

java.net.SocketAddress

spring.cloud.config.proxy-username

java.lang.String

spring.cloud.config.proxy-password

java.lang.String

spring.cloud.config.proxy-selector

java.net.ProxySelector

spring.cloud.config.plaintext-mode

HttpVersionSelection$PlaintextMode

spring.cloud.config.alpn-modes

java.util.List

spring.cloud.config.allow-block-event-loop

boolean

spring.cloud.config.dns-resolution-mode

HttpClientConfiguration$DnsResolutionMode

spring.cloud.config.address-resolver-group-name

java.lang.String

spring.cloud.config.pcap-logging-path-pattern

java.lang.String

spring.cloud.config.uri

java.lang.String

Set the Spring Cloud config server uri. Default value ("http://localhost:8888").

spring.cloud.config.label

java.lang.String

Set the Spring Cloud config server label.

spring.cloud.config.name

java.lang.String

Set the Spring Cloud config server name.

spring.cloud.config.username

java.lang.String

Set the Spring cloud config username.

spring.cloud.config.password

java.lang.String

Set the Spring cloud config password.

spring.cloud.config.fail-fast

boolean

If set to true an exception will be thrown if configuration is not found. Default value (false).

🔗
Table 17. Configuration Properties for SpringCloudClientConfiguration$SpringConfigDiscoveryConfiguration
Property Type Description Default value

spring.cloud.config.config.enabled

boolean

spring.cloud.config.config.path

java.lang.String

spring.cloud.config.config.format

ConfigDiscoveryConfiguration$Format

🔗
Table 18. Configuration Properties for SpringCloudClientConfiguration$SpringCloudConnectionPoolConfiguration
Property Type Description Default value

spring.cloud.config.pool.enabled

boolean

spring.cloud.config.pool.max-pending-acquires

int

spring.cloud.config.pool.acquire-timeout

java.time.Duration

spring.cloud.config.pool.max-pending-connections

int

spring.cloud.config.pool.max-concurrent-requests-per-http2-connection

int

spring.cloud.config.pool.max-concurrent-http1-connections

int

spring.cloud.config.pool.max-concurrent-http2-connections

int

spring.cloud.config.pool.connection-locality

HttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality

spring.cloud.config.pool.version

HttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion

🔗
Table 19. Configuration Properties for VaultClientConfiguration
Property Type Description Default value

vault.client.http-version

HttpVersion

vault.client.log-level

LogLevel

vault.client.event-loop-group

java.lang.String

vault.client.ssl-configuration

SslConfiguration

vault.client.follow-redirects

boolean

vault.client.exception-on-error-status

boolean

vault.client.logger-name

java.lang.String

vault.client.default-charset

java.nio.charset.Charset

vault.client.channel-options

java.util.Map

vault.client.read-timeout

java.time.Duration

vault.client.request-timeout

java.time.Duration

vault.client.read-idle-timeout

java.time.Duration

vault.client.connection-pool-idle-timeout

java.time.Duration

vault.client.connect-timeout

java.time.Duration

vault.client.connect-ttl

java.time.Duration

vault.client.shutdown-quiet-period

java.time.Duration

vault.client.shutdown-timeout

java.time.Duration

vault.client.num-of-threads

java.lang.Integer

vault.client.thread-factory

java.lang.Class

vault.client.max-content-length

int

vault.client.proxy-type

java.net.Proxy$Type

vault.client.proxy-address

java.net.SocketAddress

vault.client.proxy-username

java.lang.String

vault.client.proxy-password

java.lang.String

vault.client.proxy-selector

java.net.ProxySelector

vault.client.plaintext-mode

HttpVersionSelection$PlaintextMode

vault.client.alpn-modes

java.util.List

vault.client.allow-block-event-loop

boolean

vault.client.dns-resolution-mode

HttpClientConfiguration$DnsResolutionMode

vault.client.address-resolver-group-name

java.lang.String

vault.client.pcap-logging-path-pattern

java.lang.String

vault.client.uri

java.lang.String

Set the Vault Server Uri. Default value ("http://locahost:8200").

vault.client.token

java.lang.String

Set the Vault authentication token.

vault.client.kv-version

VaultClientConfiguration$VaultKvVersion

Set the version of the Vault Secret engine. V1 or V2. Default value (V2).

vault.client.secret-engine-name

java.lang.String

Set the name of the Vault Secret engine name. Default value ("secret").

vault.client.path-prefix

java.lang.String

Set the prefix for the keys used to get vault properties. Default value is empty string

vault.client.fail-fast

boolean

If set to true an exception will be thrown if configuration is not found for the application or any of its environments. Default value (false).

🔗
Table 20. Configuration Properties for VaultClientConfiguration$VaultClientDiscoveryConfiguration
Property Type Description Default value

vault.client.config.enabled

boolean

vault.client.config.path

java.lang.String

vault.client.config.format

ConfigDiscoveryConfiguration$Format

🔗
Table 21. Configuration Properties for VaultClientConfiguration$VaultClientConnectionPoolConfiguration
Property Type Description Default value

vault.client.pool.enabled

boolean

vault.client.pool.max-pending-acquires

int

vault.client.pool.acquire-timeout

java.time.Duration

vault.client.pool.max-pending-connections

int

vault.client.pool.max-concurrent-requests-per-http2-connection

int

vault.client.pool.max-concurrent-http1-connections

int

vault.client.pool.max-concurrent-http2-connections

int

vault.client.pool.connection-locality

HttpClientConfiguration$ConnectionPoolConfiguration$ConnectionLocality

vault.client.pool.version

HttpClientConfiguration$ConnectionPoolConfiguration$PoolVersion