Configuration Reference

Version:3.0.0-SNAPSHOT

Context Config Properties

🔗
Table 1. Configuration Properties for UserExecutorConfiguration
Property Type Description

micronaut.executors.*.n-threads

java.lang.Integer

micronaut.executors.*.type

ExecutorType

micronaut.executors.*.parallelism

java.lang.Integer

micronaut.executors.*.core-pool-size

java.lang.Integer

micronaut.executors.*.thread-factory-class

java.lang.Class

micronaut.executors.*.name

java.lang.String

Sets the executor name.

micronaut.executors.*.number-of-threads

java.lang.Integer

Sets the number of threads for FIXED. Default value (2 * Number of processors available to the Java virtual machine).

🔗
Table 2. Configuration Properties for FileWatchConfiguration
Property Type Description

micronaut.io.watch.enabled

boolean

Whether watch is enabled.

micronaut.io.watch.restart

boolean

Set whether restart is enabled.

micronaut.io.watch.paths

java.util.List

Sets the watch paths to use.

micronaut.io.watch.check-interval

java.time.Duration

Sets the interval to wait between file watch polls.

🔗
Table 3. Configuration Properties for InstanceConfiguration
Property Type Description

micronaut.application.instance

ApplicationConfiguration$InstanceConfiguration

The instance configuration

micronaut.application.instance.id

java.lang.String

The instance identifier

micronaut.application.instance.group

java.lang.String

The instance auto scaling group

micronaut.application.instance.zone

java.lang.String

The instance availability zone

micronaut.application.instance.metadata

java.util.Map

The metadata to associate with the instance

🔗
Table 4. Configuration Properties for ApplicationConfiguration
Property Type Description

micronaut.application.default-charset

java.nio.charset.Charset

Default value (UTF-8).

micronaut.application.name

java.lang.String

Set the application name

Http Client Core Config Properties

🔗
Table 5. Configuration Properties for DefaultKeyStoreConfiguration
Property Type Description

micronaut.http.services.*.ssl.key-store

SslConfiguration$KeyStoreConfiguration

micronaut.http.services.*.ssl.key-store.path

java.lang.String

micronaut.http.services.*.ssl.key-store.password

java.lang.String

micronaut.http.services.*.ssl.key-store.type

java.lang.String

micronaut.http.services.*.ssl.key-store.provider

java.lang.String

🔗
Table 6. Configuration Properties for DefaultHttpClientConfiguration
Property Type Description

micronaut.http.client.http-version

HttpVersion

Sets the HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.

micronaut.http.client.log-level

LogLevel

Sets the level to enable trace logging at. Depending on the implementation this may activate additional handlers. For example in Netty this will activate {@code LoggingHandler} at the given level.

micronaut.http.client.event-loop-group

java.lang.String

Sets the event loop group to use for the client.

micronaut.http.client.ssl-configuration

SslConfiguration

Sets the SSL configuration for the client.

micronaut.http.client.exception-on-error-status

boolean

Sets whether throwing an exception upon HTTP error status (>= 400) is preferred. Default value (DEFAULT_EXCEPTION_ON_ERROR_STATUS)

micronaut.http.client.logger-name

java.lang.String

Sets the client-specific logger name.

micronaut.http.client.follow-redirects

boolean

Sets whether redirects should be followed. Default value (DEFAULT_FOLLOW_REDIRECTS).

micronaut.http.client.default-charset

java.nio.charset.Charset

Sets the default charset to use. Default value (UTF-8);

micronaut.http.client.channel-options

java.util.Map

The Client channel options

micronaut.http.client.shutdown-quiet-period

java.time.Duration

Sets the amount of quiet period for shutdown of client thread pools. Default value (1 milliseconds).

If a task is submitted during the quiet period, it will be accepted and the quiet period will start over.

micronaut.http.client.shutdown-timeout

java.time.Duration

Sets the amount of time to wait for shutdown of client thread pools. Default value (100 milliseconds).

micronaut.http.client.read-timeout

java.time.Duration

Sets the read timeout. Default value (10 seconds).

micronaut.http.client.read-idle-timeout

java.time.Duration

Sets the max read idle time for streaming requests. Default value (5 seconds).

micronaut.http.client.connection-pool-idle-timeout

java.time.Duration

Sets the idle timeout for connection in the client connection pool. Defaults to 0.

micronaut.http.client.connect-timeout

java.time.Duration

Sets the connect timeout.

micronaut.http.client.connect-ttl

java.time.Duration

Sets the connect timeout.

micronaut.http.client.num-of-threads

java.lang.Integer

Sets the number of threads the client should use for requests.

micronaut.http.client.thread-factory

java.lang.Class

Sets a thread factory.

micronaut.http.client.max-content-length

int

Sets the maximum content length the client can consume. Default value (1024 * 1024 * 10 ⇒ 10MB).

micronaut.http.client.proxy-type

java.net.Proxy$Type

The proxy type

micronaut.http.client.proxy-address

java.net.SocketAddress

Sets a proxy address.

micronaut.http.client.proxy-username

java.lang.String

Sets the proxy user name to use.

micronaut.http.client.proxy-password

java.lang.String

Sets the proxy password.

micronaut.http.client.proxy-selector

java.net.ProxySelector

Sets the proxy selector. ProxySelector decides what proxy to use and take precedence over {@link #setProxyAddress(SocketAddress)} and {@link #setProxyType(Proxy.Type)}.

🔗
Table 7. Configuration Properties for ServiceSslClientConfiguration
Property Type Description

micronaut.http.services.*.ssl-configuration

SslConfiguration

Sets the SSL configuration for the client.

micronaut.http.services.*.ssl.enabled

boolean

micronaut.http.services.*.ssl.port

int

micronaut.http.services.*.ssl.build-self-signed

boolean

micronaut.http.services.*.ssl.client-authentication

ClientAuthentication

micronaut.http.services.*.ssl.ciphers

java.lang.String

micronaut.http.services.*.ssl.protocols

java.lang.String

micronaut.http.services.*.ssl.protocol

java.lang.String

🔗
Table 8. Configuration Properties for DefaultTrustStoreConfiguration
Property Type Description

micronaut.http.services.*.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

micronaut.http.services.*.ssl.trust-store.path

java.lang.String

micronaut.http.services.*.ssl.trust-store.password

java.lang.String

micronaut.http.services.*.ssl.trust-store.type

java.lang.String

micronaut.http.services.*.ssl.trust-store.provider

java.lang.String

🔗
Table 9. Configuration Properties for NamedClientVersioningConfiguration
Property Type Description

micronaut.http.client.versioning.*.headers

java.util.List

The list of request header names.

micronaut.http.client.versioning.*.parameters

java.util.List

The list of request query parameter names.

🔗
Table 10. Configuration Properties for ServiceConnectionPoolConfiguration
Property Type Description

micronaut.http.services.*.pool.enabled

boolean

Sets whether connection pooling is enabled. Default value (false).

micronaut.http.services.*.pool.max-connections

int

Sets the maximum number of connections. Defaults to no maximum.

micronaut.http.services.*.pool.max-pending-acquires

int

Sets the max pending acquires.

micronaut.http.services.*.pool.acquire-timeout

java.time.Duration

Sets the timeout to wait for a connection.

🔗
Table 11. Configuration Properties for DefaultKeyConfiguration
Property Type Description

micronaut.http.services.*.ssl.key

SslConfiguration$KeyConfiguration

micronaut.http.services.*.ssl.key.password

java.lang.String

micronaut.http.services.*.ssl.key.alias

java.lang.String

🔗
Table 12. Configuration Properties for DefaultConnectionPoolConfiguration
Property Type Description

micronaut.http.client.pool.enabled

boolean

Sets whether connection pooling is enabled. Default value (false).

micronaut.http.client.pool.max-connections

int

Sets the maximum number of connections. Defaults to no maximum.

micronaut.http.client.pool.max-pending-acquires

int

Sets the max pending acquires.

micronaut.http.client.pool.acquire-timeout

java.time.Duration

Sets the timeout to wait for a connection.

🔗
Table 13. Configuration Properties for ServiceHttpClientConfiguration
Property Type Description

micronaut.http.services.*.http-version

HttpVersion

Sets the HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.

micronaut.http.services.*.log-level

LogLevel

Sets the level to enable trace logging at. Depending on the implementation this may activate additional handlers. For example in Netty this will activate {@code LoggingHandler} at the given level.

micronaut.http.services.*.event-loop-group

java.lang.String

Sets the event loop group to use for the client.

micronaut.http.services.*.exception-on-error-status

boolean

Sets whether throwing an exception upon HTTP error status (>= 400) is preferred. Default value (DEFAULT_EXCEPTION_ON_ERROR_STATUS)

micronaut.http.services.*.logger-name

java.lang.String

Sets the client-specific logger name.

micronaut.http.services.*.follow-redirects

boolean

Sets whether redirects should be followed. Default value (DEFAULT_FOLLOW_REDIRECTS).

micronaut.http.services.*.default-charset

java.nio.charset.Charset

Sets the default charset to use. Default value (UTF-8);

micronaut.http.services.*.channel-options

java.util.Map

The Client channel options

micronaut.http.services.*.shutdown-quiet-period

java.time.Duration

Sets the amount of quiet period for shutdown of client thread pools. Default value (1 milliseconds).

If a task is submitted during the quiet period, it will be accepted and the quiet period will start over.

micronaut.http.services.*.shutdown-timeout

java.time.Duration

Sets the amount of time to wait for shutdown of client thread pools. Default value (100 milliseconds).

micronaut.http.services.*.read-timeout

java.time.Duration

Sets the read timeout. Default value (10 seconds).

micronaut.http.services.*.read-idle-timeout

java.time.Duration

Sets the max read idle time for streaming requests. Default value (5 seconds).

micronaut.http.services.*.connection-pool-idle-timeout

java.time.Duration

Sets the idle timeout for connection in the client connection pool. Defaults to 0.

micronaut.http.services.*.connect-timeout

java.time.Duration

Sets the connect timeout.

micronaut.http.services.*.connect-ttl

java.time.Duration

Sets the connect timeout.

micronaut.http.services.*.num-of-threads

java.lang.Integer

Sets the number of threads the client should use for requests.

micronaut.http.services.*.thread-factory

java.lang.Class

Sets a thread factory.

micronaut.http.services.*.max-content-length

int

Sets the maximum content length the client can consume. Default value (1024 * 1024 * 10 ⇒ 10MB).

micronaut.http.services.*.proxy-type

java.net.Proxy$Type

The proxy type

micronaut.http.services.*.proxy-address

java.net.SocketAddress

Sets a proxy address.

micronaut.http.services.*.proxy-username

java.lang.String

Sets the proxy user name to use.

micronaut.http.services.*.proxy-password

java.lang.String

Sets the proxy password.

micronaut.http.services.*.proxy-selector

java.net.ProxySelector

Sets the proxy selector. ProxySelector decides what proxy to use and take precedence over {@link #setProxyAddress(SocketAddress)} and {@link #setProxyType(Proxy.Type)}.

micronaut.http.services.*.urls

java.util.List

Sets the URIs of the service.

micronaut.http.services.*.health-check-uri

java.lang.String

Sets the health check URI. Default value ("/health").

micronaut.http.services.*.health-check

boolean

Sets whether the service health should be checked. Default value (false).

micronaut.http.services.*.health-check-interval

java.time.Duration

Sets the default duration to check health status. Default value (30 seconds).

micronaut.http.services.*.path

java.lang.String

Sets the context path to use for requests.

micronaut.http.services.*.url

java.net.URI

Sets the URL of the service.

🔗
Table 14. Configuration Properties for DefaultClientVersioningConfiguration
Property Type Description

micronaut.http.client.versioning.default.headers

java.util.List

The list of request header names.

micronaut.http.client.versioning.default.parameters

java.util.List

The list of request query parameter names.

Http Config Properties

🔗
Table 15. Configuration Properties for DefaultTrustStoreConfiguration
Property Type Description

micronaut.server.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

Sets the trust store configuration.

micronaut.server.ssl.trust-store.path

java.lang.String

Sets the path.

micronaut.server.ssl.trust-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.server.ssl.trust-store.type

java.lang.String

Sets the type of keystore.

micronaut.server.ssl.trust-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 16. Configuration Properties for DefaultTrustStoreConfiguration
Property Type Description

micronaut.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

Sets the trust store configuration.

micronaut.ssl.trust-store.path

java.lang.String

Sets the path.

micronaut.ssl.trust-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.ssl.trust-store.type

java.lang.String

Sets the type of keystore.

micronaut.ssl.trust-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 17. Configuration Properties for DefaultKeyStoreConfiguration
Property Type Description

micronaut.ssl.key-store

SslConfiguration$KeyStoreConfiguration

Sets the keystore configuration.

micronaut.ssl.key-store.path

java.lang.String

Sets the path.

micronaut.ssl.key-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.ssl.key-store.type

java.lang.String

Sets the type of keystore.

micronaut.ssl.key-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 18. Configuration Properties for ClientSslConfiguration
Property Type Description

micronaut.http.client.ssl.enabled

boolean

Whether SSL is enabled. Default value (false).

micronaut.http.client.ssl.port

int

Sets the SSL port. Default value (8443).

micronaut.http.client.ssl.build-self-signed

boolean

Sets whether to build a self signed certificate. Default value (false).

micronaut.http.client.ssl.client-authentication

ClientAuthentication

Sets the client authentication mode.

micronaut.http.client.ssl.ciphers

java.lang.String

Sets the ciphers to use.

micronaut.http.client.ssl.protocols

java.lang.String

Sets the protocols to use.

micronaut.http.client.ssl.protocol

java.lang.String

Sets the protocol to use. Default value ("TLS").

🔗
Table 19. Configuration Properties for CodecConfiguration
Property Type Description

micronaut.codec.*.additional-types

java.util.List

Default value (Empty list).

🔗
Table 20. Configuration Properties for ServerSslConfiguration
Property Type Description

micronaut.server.ssl.enabled

boolean

Whether SSL is enabled. Default value (false).

micronaut.server.ssl.port

int

Sets the SSL port. Default value (8443).

micronaut.server.ssl.build-self-signed

boolean

Sets whether to build a self signed certificate. Default value (false).

micronaut.server.ssl.client-authentication

ClientAuthentication

Sets the client authentication mode.

micronaut.server.ssl.ciphers

java.lang.String

Sets the ciphers to use.

micronaut.server.ssl.protocols

java.lang.String

Sets the protocols to use.

micronaut.server.ssl.protocol

java.lang.String

Sets the protocol to use. Default value ("TLS").

🔗
Table 21. Configuration Properties for DefaultSslConfiguration
Property Type Description

micronaut.ssl.enabled

boolean

Whether SSL is enabled. Default value (false).

micronaut.ssl.port

int

Sets the SSL port. Default value (8443).

micronaut.ssl.build-self-signed

boolean

Sets whether to build a self signed certificate. Default value (false).

micronaut.ssl.client-authentication

ClientAuthentication

Sets the client authentication mode.

micronaut.ssl.ciphers

java.lang.String

Sets the ciphers to use.

micronaut.ssl.protocols

java.lang.String

Sets the protocols to use.

micronaut.ssl.protocol

java.lang.String

Sets the protocol to use. Default value ("TLS").

🔗
Table 22. Configuration Properties for DefaultTrustStoreConfiguration
Property Type Description

micronaut.http.client.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

Sets the trust store configuration.

micronaut.http.client.ssl.trust-store.path

java.lang.String

Sets the path.

micronaut.http.client.ssl.trust-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.http.client.ssl.trust-store.type

java.lang.String

Sets the type of keystore.

micronaut.http.client.ssl.trust-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 23. Configuration Properties for DefaultKeyConfiguration
Property Type Description

micronaut.ssl.key

SslConfiguration$KeyConfiguration

Sets the key configuration.

micronaut.ssl.key.password

java.lang.String

Sets the password.

micronaut.ssl.key.alias

java.lang.String

Sets the alias.

🔗
Table 24. Configuration Properties for DefaultKeyStoreConfiguration
Property Type Description

micronaut.http.client.ssl.key-store

SslConfiguration$KeyStoreConfiguration

Sets the keystore configuration.

micronaut.http.client.ssl.key-store.path

java.lang.String

Sets the path.

micronaut.http.client.ssl.key-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.http.client.ssl.key-store.type

java.lang.String

Sets the type of keystore.

micronaut.http.client.ssl.key-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 25. Configuration Properties for DefaultKeyConfiguration
Property Type Description

micronaut.server.ssl.key

SslConfiguration$KeyConfiguration

Sets the key configuration.

micronaut.server.ssl.key.password

java.lang.String

Sets the password.

micronaut.server.ssl.key.alias

java.lang.String

Sets the alias.

🔗
Table 26. Configuration Properties for DefaultKeyStoreConfiguration
Property Type Description

micronaut.server.ssl.key-store

SslConfiguration$KeyStoreConfiguration

Sets the keystore configuration.

micronaut.server.ssl.key-store.path

java.lang.String

Sets the path.

micronaut.server.ssl.key-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.server.ssl.key-store.type

java.lang.String

Sets the type of keystore.

micronaut.server.ssl.key-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 27. Configuration Properties for DefaultKeyConfiguration
Property Type Description

micronaut.http.client.ssl.key

SslConfiguration$KeyConfiguration

Sets the key configuration.

micronaut.http.client.ssl.key.password

java.lang.String

Sets the password.

micronaut.http.client.ssl.key.alias

java.lang.String

Sets the alias.

Http Netty Config Properties

🔗
Table 28. Configuration Properties for DefaultEventLoopGroupConfiguration
Property Type Description

micronaut.netty.event-loops.*.num-threads

int

micronaut.netty.event-loops.*.io-ratio

java.lang.Integer

micronaut.netty.event-loops.*.prefer-native-transport

boolean

micronaut.netty.event-loops.*.executor

java.lang.String

micronaut.netty.event-loops.*.shutdown-quiet-period

java.time.Duration

micronaut.netty.event-loops.*.shutdown-timeout

java.time.Duration

🔗
Table 29. Configuration Properties for NettyGlobalConfiguration
Property Type Description

netty.resource-leak-detector-level

io.netty.util.ResourceLeakDetector$Level

Sets the resource leak detection level.

Http Server Config Properties

🔗
Table 30. Configuration Properties for CorsConfiguration
Property Type Description

micronaut.server.cors

HttpServerConfiguration$CorsConfiguration

Sets the cors configuration.

micronaut.server.cors.enabled

boolean

Sets whether CORS is enabled. Default value (false)

micronaut.server.cors.single-header

boolean

Sets whether CORS header values should be joined into a single header. Default value (false).

micronaut.server.cors.configurations

java.util.Map

Sets the CORS configurations.

🔗
Table 31. Configuration Properties for HttpServerConfiguration
Property Type Description

micronaut.server.port

java.lang.Integer

Sets the port to bind to. Default value (-1)

micronaut.server.host

java.lang.String

Sets the host to bind to.

micronaut.server.read-timeout

java.lang.Integer

Sets the default read timeout.

micronaut.server.max-request-size

long

Sets the maximum request size. Default value (1024 * 1024 * 10L ⇒ // 10MB)

micronaut.server.read-idle-timeout

java.time.Duration

Sets the amount of time a connection can remain idle without any reads occurring. Default value (5L minutes).

micronaut.server.write-idle-timeout

java.time.Duration

Sets the amount of time a connection can remain idle without any writes occurring. Default value (5L minutes).

micronaut.server.idle-timeout

java.time.Duration

Sets the idle time of connections for the server. Default value (5 minutes).

micronaut.server.server-header

java.lang.String

Sets the name of the server header.

micronaut.server.date-header

boolean

Sets whether a date header should be sent back. Default value (true).

micronaut.server.log-handled-exceptions

boolean

Sets whether exceptions handled by either an error route or exception handler should still be logged. Default value (false).

micronaut.server.client-address-header

java.lang.String

The header that stores the original client address

micronaut.server.context-path

java.lang.String

Sets the context path for the web server.

micronaut.server.dual-protocol

boolean

the dual protocol (http/https) configuration. Default value (false).

micronaut.server.http-to-https-redirect

boolean

Set to true to enable redirecting all http requests to the same URL but with

micronaut.server.http-version

HttpVersion

Sets the HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}.

micronaut.server.default-charset

java.nio.charset.Charset

The default charset to use

micronaut.server.thread-selection

ThreadSelection

Sets the {@link ThreadSelection} model to use for the server.

🔗
Table 32. Configuration Properties for HttpLocaleResolutionConfigurationProperties
Property Type Description

micronaut.server.locale-resolution

HttpServerConfiguration$HttpLocaleResolutionConfigurationProperties

The locale resolution configuration

micronaut.server.locale-resolution.fixed

java.util.Locale

Set the language tag for the locale. Supports BCP 47 language tags (e.g. "en-US") and ISO standard (e.g "en_US").

micronaut.server.locale-resolution.session-attribute

java.lang.String

Sets the key in the session to look for the locale.

micronaut.server.locale-resolution.cookie-name

java.lang.String

Sets the name of the cookie that is used to store the locale.

micronaut.server.locale-resolution.header

boolean

Set to true if the locale should be resolved from the Accept-Language header. Default value (true).

micronaut.server.locale-resolution.default-locale

java.util.Locale

Sets the locale that will be used if the locale cannot be resolved through any means. Defaults to the system default.

🔗
Table 33. Configuration Properties for MultipartConfiguration
Property Type Description

micronaut.server.multipart

HttpServerConfiguration$MultipartConfiguration

Sets the multipart configuration.

micronaut.server.multipart.location

java.io.File

Sets the location to store files.

micronaut.server.multipart.max-file-size

long

Sets the max file size. Default value (1024L * 1024 ⇒ 1MB).

micronaut.server.multipart.enabled

java.lang.Boolean

Sets whether multipart processing is enabled. Default value (false).

micronaut.server.multipart.disk

boolean

Sets whether to buffer data to disk or not. Default value (false).

micronaut.server.multipart.mixed

boolean

Sets whether to buffer data to disk if the size is greater than the threshold. Default value (false).

micronaut.server.multipart.threshold

long

Sets the amount of data that should be received that will trigger the data to be stored to disk. Default value (1024L * 1024 * 10).

🔗
Table 34. Configuration Properties for HostResolutionConfiguration
Property Type Description

micronaut.server.host-resolution

HttpServerConfiguration$HostResolutionConfiguration

The host resolution configuration

micronaut.server.host-resolution.host-header

java.lang.String

The header name that stores the host

micronaut.server.host-resolution.protocol-header

java.lang.String

The header name that stores the protocol

micronaut.server.host-resolution.port-header

java.lang.String

The header name that stores the port

micronaut.server.host-resolution.port-in-host

boolean

True if the host header supports a port

micronaut.server.host-resolution.allowed-hosts

java.util.List

The list of allowed host regex patterns. Any resolved

Http Server Netty Config Properties

🔗
Table 35. Configuration Properties for FileTypeHandlerConfiguration
Property Type Description

netty.responses.file.cache-seconds

int

Cache Seconds. Default value (60).

🔗
Table 36. Configuration Properties for Worker
Property Type Description

micronaut.server.netty.worker

NettyHttpServerConfiguration$Worker

Sets the worker event loop configuration.

micronaut.server.netty.worker.event-loop-group

java.lang.String

Sets the name to use.

micronaut.server.netty.worker.threads

int

Sets the number of threads for the event loop group.

micronaut.server.netty.worker.io-ratio

java.lang.Integer

Sets the I/O ratio.

micronaut.server.netty.worker.executor

java.lang.String

Sets the name of the executor.

micronaut.server.netty.worker.prefer-native-transport

boolean

Set whether to prefer the native transport if available

micronaut.server.netty.worker.shutdown-quiet-period

java.time.Duration

Set the shutdown quiet period

micronaut.server.netty.worker.shutdown-timeout

java.time.Duration

Set the shutdown timeout (must be >= shutdownQuietPeriod)

🔗
Table 37. Configuration Properties for AccessLogger
Property Type Description

micronaut.server.netty.access-logger

NettyHttpServerConfiguration$AccessLogger

Sets the AccessLogger configuration.

micronaut.server.netty.access-logger.enabled

boolean

Enables or Disables the access logger.

micronaut.server.netty.access-logger.logger-name

java.lang.String

Sets the logger name to use. If not specified 'HTTP_ACCESS_LOGGER' will be used.

micronaut.server.netty.access-logger.log-format

java.lang.String

Sets the log format to use. When not specified, the Common Log Format (CLF) will be used.

🔗
Table 38. Configuration Properties for CacheControlConfiguration
Property Type Description

netty.responses.file.cache-control

FileTypeHandlerConfiguration$CacheControlConfiguration

Sets the cache control configuration.

netty.responses.file.cache-control.public

boolean

Sets whether the cache control is public. Default value (false)

🔗
Table 39. Configuration Properties for Http2Settings
Property Type Description

micronaut.server.netty.http2

NettyHttpServerConfiguration$Http2Settings

Sets the Http2Settings.

micronaut.server.netty.http2.header-table-size

java.lang.Long

Sets the {@code SETTINGS_HEADER_TABLE_SIZE} value.

micronaut.server.netty.http2.push-enabled

java.lang.Boolean

Sets the {@code SETTINGS_ENABLE_PUSH} value.

micronaut.server.netty.http2.max-concurrent-streams

java.lang.Long

Sets the {@code SETTINGS_MAX_CONCURRENT_STREAMS} value.

micronaut.server.netty.http2.initial-window-size

java.lang.Integer

Sets the {@code SETTINGS_INITIAL_WINDOW_SIZE} value.

micronaut.server.netty.http2.max-frame-size

java.lang.Integer

Sets the {@code SETTINGS_MAX_FRAME_SIZE} value.

micronaut.server.netty.http2.max-header-list-size

java.lang.Long

Sets the {@code SETTINGS_MAX_HEADER_LIST_SIZE} value.

🔗
Table 40. Configuration Properties for Parent
Property Type Description

micronaut.server.netty.parent

NettyHttpServerConfiguration$Parent

Sets the parent event loop configuration.

micronaut.server.netty.parent.event-loop-group

java.lang.String

Sets the name to use.

micronaut.server.netty.parent.threads

int

Sets the number of threads for the event loop group.

micronaut.server.netty.parent.io-ratio

java.lang.Integer

Sets the I/O ratio.

micronaut.server.netty.parent.executor

java.lang.String

Sets the name of the executor.

micronaut.server.netty.parent.prefer-native-transport

boolean

Set whether to prefer the native transport if available

micronaut.server.netty.parent.shutdown-quiet-period

java.time.Duration

Set the shutdown quiet period

micronaut.server.netty.parent.shutdown-timeout

java.time.Duration

Set the shutdown timeout (must be >= shutdownQuietPeriod)

🔗
Table 41. Configuration Properties for NettyHttpServerConfiguration
Property Type Description

micronaut.server.netty.child-options

java.util.Map

Sets the Netty child worker options.

micronaut.server.netty.options

java.util.Map

Sets the channel options.

micronaut.server.netty.max-initial-line-length

int

Sets the maximum initial line length for the HTTP request. Default value (4096).

micronaut.server.netty.max-header-size

int

Sets the maximum size of any one header. Default value (8192).

micronaut.server.netty.max-chunk-size

int

Sets the maximum size of any single request chunk. Default value (8192).

micronaut.server.netty.chunked-supported

boolean

Sets whether chunked transfer encoding is supported. Default value (true).

micronaut.server.netty.validate-headers

boolean

Sets whether to validate incoming headers. Default value (true).

micronaut.server.netty.initial-buffer-size

int

Sets the initial buffer size. Default value (128).

micronaut.server.netty.log-level

io.netty.handler.logging.LogLevel

Sets the Netty log level.

micronaut.server.netty.compression-threshold

int

Sets the minimum size of a request body must be in order to be compressed. Default value (1024).

micronaut.server.netty.compression-level

int

Sets the compression level (0-9). Default value (6).

micronaut.server.netty.use-native-transport

boolean

Sets whether to use netty’s native transport (epoll or kqueue) if available . Default value (false).

micronaut.server.netty.fallback-protocol

java.lang.String

Sets the fallback protocol to use when negotiating via ALPN.

Management Config Properties

🔗
Table 42. Configuration Properties for StatusConfiguration
Property Type Description

endpoints.health.status.http-mapping

java.util.Map

Set how HealthStatus map to HttpStatus codes.

🔗
Table 43. Configuration Properties for HealthEndpoint
Property Type Description

endpoints.health.details-visible

DetailsVisibility

Sets the visibility policy for health information.

🔗
Table 44. Configuration Properties for LoggersEndpoint
Property Type Description

endpoints.loggers.write-sensitive

boolean

Determines whether modifications to the log level should require authentication. Default value (true).

🔗
Table 45. Configuration Properties for EndpointDefaultConfiguration
Property Type Description

endpoints.all.enabled

java.lang.Boolean

Sets whether the endpoint is enabled.

endpoints.all.sensitive

java.lang.Boolean

Sets whether the endpoint is sensitive.

endpoints.all.port

java.lang.Integer

Sets the port to expose endpoints via.

endpoints.all.path

java.lang.String

The endpoints base path. Default value ("/").

🔗
Table 46. Configuration Properties for DiscoveryClientHealthIndicatorConfiguration
Property Type Description

endpoints.health.discovery-client.enabled

boolean

If health indicator should be enabled. Default is true.

🔗
Table 47. Configuration Properties for EndpointConfiguration
Property Type Description

endpoints.*.enabled

java.lang.Boolean

Sets whether the endpoint is enabled.

endpoints.*.sensitive

java.lang.Boolean

Sets whether the endpoint is sensitive.

🔗
Table 48. Configuration Properties for DiskSpaceIndicatorConfiguration
Property Type Description

endpoints.health.disk-space.enabled

boolean

Default value (true).

endpoints.health.disk-space.path

java.io.File

Default value (".").

endpoints.health.disk-space.threshold

long

Default value (1024L * 1024 * 10 ⇒ 10MB).

Router Config Properties

🔗
Table 49. Configuration Properties for StaticResourceConfiguration
Property Type Description

micronaut.router.static-resources.*.enabled

boolean

Sets whether this specific mapping is enabled. Default value (true).

micronaut.router.static-resources.*.paths

java.util.List

A list of paths either starting with classpath: or file:. You can serve files from anywhere on disk or the classpath. For example to serve static resources from src/main/resources/public, you would use classpath:public as the path.

micronaut.router.static-resources.*.mapping

java.lang.String

The path resources should be served from. Uses ant path matching. Default value ("/**").

🔗
Table 50. Configuration Properties for HeaderVersionResolverConfiguration
Property Type Description

micronaut.router.versioning.header.enabled

boolean

Sets whether headers should be searched for a version.

micronaut.router.versioning.header.names

java.util.List

Sets which headers should be searched for a version.

🔗
Table 51. Configuration Properties for RoutesVersioningConfiguration
Property Type Description

micronaut.router.versioning.enabled

boolean

Enables the version based route matches filtering.

micronaut.router.versioning.default-version

java.lang.String

Sets the version to use if the version cannot be resolved. Default value (null).

🔗
Table 52. Configuration Properties for ParameterVersionResolverConfiguration
Property Type Description

micronaut.router.versioning.parameter.enabled

boolean

Sets whether parameter should be searched for a version.

micronaut.router.versioning.parameter.names

java.util.List

Sets which parameter should be searched for a version.

Runtime Config Properties

🔗
Table 53. Configuration Properties for HeartbeatConfiguration
Property Type Description

micronaut.heartbeat.interval

java.time.Duration

Default value (15 seconds).

micronaut.heartbeat.enabled

boolean

Default value (true).

🔗
Table 54. Configuration Properties for JacksonConfiguration
Property Type Description

jackson.module-scan

boolean

Sets whether to scan for modules or not (defaults to true).

jackson.bean-introspection-module

boolean

Whether the BeanIntrospection should be used for reflection free object serialialization/deserialialization.

jackson.date-format

java.lang.String

Sets the default date format to use.

jackson.locale

java.util.Locale

Sets the locale to use.

jackson.time-zone

java.util.TimeZone

Sets the timezone to use.

jackson.array-size-threshold

int

Sets the array size threshold for data binding. Default value (100).

jackson.serialization

java.util.Map

Sets the serialization features to use.

jackson.deserialization

java.util.Map

Sets the deserialization features to use.

jackson.mapper

java.util.Map

Sets the object mapper features to use.

jackson.parser

java.util.Map

Sets the parser features to use.

jackson.generator

java.util.Map

Sets the generator features to use.

jackson.serialization-inclusion

com.fasterxml.jackson.annotation.JsonInclude$Include

Sets the serialization inclusion mode.

jackson.default-typing

com.fasterxml.jackson.databind.ObjectMapper$DefaultTyping

Sets the global defaultTyping using for Polymorphic handling.

jackson.property-naming-strategy

com.fasterxml.jackson.databind.PropertyNamingStrategy

Sets the property naming strategy.

jackson.always-serialize-errors-as-list

boolean

Sets whether _embedded.errors should always be serialized as list (defaults to false). If set to false, _embedded.errors with 1 element will be serialized as an object.

jackson.trim-strings

boolean

Whether strings should be trimmed when deserializing (defaults to false). If the resulting string is an empty string, then null will be applied instead.

🔗
Table 55. Configuration Properties for DigitalOceanMetadataConfiguration
Property Type Description

micronaut.application.digitalocean.metadata.url

java.lang.String

Default value ("http://169.254.169.254/metadata/v1.json").

micronaut.application.digitalocean.metadata.enabled

boolean

Default value (true).

Session Config Properties

🔗
Table 56. Configuration Properties for HttpSessionConfiguration
Property Type Description

micronaut.session.http.remember-me

boolean

Default value (false).

micronaut.session.http.base64-encode

boolean

Default value (true).

micronaut.session.http.cookie-max-age

java.time.temporal.TemporalAmount

Sets the maximum age of the cookie.

micronaut.session.http.cookie-secure

java.lang.Boolean

Sets the secure status of the cookie. Delegates to http if not set.

micronaut.session.http.cookie-path

java.lang.String

Set the cookie path to use. Default value ("/").

micronaut.session.http.domain-name

java.lang.String

Set the domain name to use for the cookie

micronaut.session.http.cookie-name

java.lang.String

Default value ("SESSION").

micronaut.session.http.prefix

java.lang.String

Set the prefix to use when serializing session ID

micronaut.session.http.header-names

java.lang.String[]

Default values (["Authorization-Info", "X-Auth-Token"]).

micronaut.session.http.cookie-domain

java.lang.String

Set the domain name to use for the cookie

micronaut.session.http.cookie-same-site

SameSite

Determines if this this Cookie can be sent along cross-site requests. For more information, please look <a href="https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-05">here</a>

🔗
Table 57. Configuration Properties for SessionConfiguration
Property Type Description

micronaut.session.max-active-sessions

java.lang.Integer

Sets the maximum number of active sessions.

micronaut.session.max-inactive-interval

java.time.Duration

Set the maximum inactive interval. Default value (30 minutes).

micronaut.session.prompt-expiration

boolean

Set if prompt expiration is enabled.

micronaut.session.executor-service

BeanProvider

Set the executor service.

Tracing Config Properties

🔗
Table 58. Configuration Properties for JaegerSenderConfiguration
Property Type Description

tracing.jaeger.sender.agent-host

java.lang.String

tracing.jaeger.sender.agent-port

java.lang.Integer

tracing.jaeger.sender.endpoint

java.lang.String

tracing.jaeger.sender.auth-token

java.lang.String

tracing.jaeger.sender.auth-username

java.lang.String

tracing.jaeger.sender.auth-password

java.lang.String

🔗
Table 59. Configuration Properties for HttpClientSenderConfiguration
Property Type Description

tracing.zipkin.http.http-version

HttpVersion

tracing.zipkin.http.log-level

LogLevel

tracing.zipkin.http.event-loop-group

java.lang.String

tracing.zipkin.http.ssl-configuration

SslConfiguration

tracing.zipkin.http.exception-on-error-status

boolean

tracing.zipkin.http.logger-name

java.lang.String

tracing.zipkin.http.follow-redirects

boolean

tracing.zipkin.http.default-charset

java.nio.charset.Charset

tracing.zipkin.http.channel-options

java.util.Map

tracing.zipkin.http.shutdown-quiet-period

java.time.Duration

tracing.zipkin.http.shutdown-timeout

java.time.Duration

tracing.zipkin.http.read-timeout

java.time.Duration

tracing.zipkin.http.read-idle-timeout

java.time.Duration

tracing.zipkin.http.connection-pool-idle-timeout

java.time.Duration

tracing.zipkin.http.connect-timeout

java.time.Duration

tracing.zipkin.http.connect-ttl

java.time.Duration

tracing.zipkin.http.num-of-threads

java.lang.Integer

tracing.zipkin.http.thread-factory

java.lang.Class

tracing.zipkin.http.max-content-length

int

tracing.zipkin.http.proxy-type

java.net.Proxy$Type

tracing.zipkin.http.proxy-address

java.net.SocketAddress

tracing.zipkin.http.proxy-username

java.lang.String

tracing.zipkin.http.proxy-password

java.lang.String

tracing.zipkin.http.proxy-selector

java.net.ProxySelector

tracing.zipkin.http.encoding

zipkin2.codec.Encoding

tracing.zipkin.http.message-max-bytes

int

tracing.zipkin.http.compression-enabled

boolean

tracing.zipkin.http.server

java.net.URI

tracing.zipkin.http.url

java.net.URI

tracing.zipkin.http.urls

java.util.List

tracing.zipkin.http.path

java.lang.String

tracing.zipkin.http.invocation-instrumenter-factories

java.util.List

tracing.zipkin.http.build

javax.inject.Provider

🔗
Table 60. Configuration Properties for JaegerConfiguration
Property Type Description

tracing.jaeger.tracer-tags

java.util.Map

tracing.jaeger.enabled

boolean

Enable/Disable Jaeger. Default value (false).

tracing.jaeger.expand-exception-logs

boolean

Whether to expand exception logs.

tracing.jaeger.zipkin-shared-rpc-span

boolean

Whether to use Zipkin shared RPC.

🔗
Table 61. Configuration Properties for AsyncReporterConfiguration
Property Type Description

tracing.zipkin.reporter.thread-factory

java.util.concurrent.ThreadFactory

tracing.zipkin.reporter.metrics

zipkin2.reporter.ReporterMetrics

tracing.zipkin.reporter.message-max-bytes

int

tracing.zipkin.reporter.message-timeout

java.time.Duration

tracing.zipkin.reporter.close-timeout

java.time.Duration

tracing.zipkin.reporter.queued-max-spans

int

tracing.zipkin.reporter.queued-max-bytes

int

tracing.zipkin.reporter.build

zipkin2.codec.BytesEncoder

🔗
Table 62. Configuration Properties for JaegerReporterConfiguration
Property Type Description

tracing.jaeger.reporter.log-spans

java.lang.Boolean

tracing.jaeger.reporter.flush-interval

java.lang.Integer

tracing.jaeger.reporter.max-queue-size

java.lang.Integer

tracing.jaeger.reporter.sender

io.jaegertracing.Configuration$SenderConfiguration

🔗
Table 63. Configuration Properties for BraveTracerConfiguration
Property Type Description

tracing.zipkin.local-service-name

java.lang.String

tracing.zipkin.local-ip

java.lang.String

tracing.zipkin.local-port

int

tracing.zipkin.trace-id128-bit

boolean

tracing.zipkin.supports-join

boolean

tracing.zipkin.add-finished-span-handler

brave.handler.FinishedSpanHandler

tracing.zipkin.add-span-handler

brave.handler.SpanHandler

tracing.zipkin.enabled

boolean

Default value (false).

🔗
Table 64. Configuration Properties for SamplerConfiguration
Property Type Description

tracing.zipkin.sampler.probability

float

Sets the sampler probability used by the default {@link brave.sampler.CountingSampler}. A value of 1.0 indicates to sample all requests. A value of 0.1 indicates to sample 10% of requests.

🔗
Table 65. Configuration Properties for JaegerSamplerConfiguration
Property Type Description

tracing.jaeger.sampler.type

java.lang.String

tracing.jaeger.sampler.param

java.lang.Number

tracing.jaeger.sampler.manager-host-port

java.lang.String

tracing.jaeger.sampler.probability

float

Sets the sampler probability used by the default {@link brave.sampler.CountingSampler}. A value of 1.0 indicates to sample all requests. A value of 0.1 indicates to sample 10% of requests.

Validation Config Properties

🔗
Table 66. Configuration Properties for DefaultValidatorConfiguration
Property Type Description

micronaut.validator.enabled

boolean

Sets whether Micronaut’s validator is enabled.