|
This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.5! |
Common Application Properties
Various properties can be specified inside your application.properties file, inside your application.yaml file, or as command line switches.
This appendix provides a list of common Spring Boot properties and references to the underlying classes that consume them.
| Spring Boot provides various conversion mechanisms with advanced value formatting. Make sure to review the properties conversion section. |
| Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. Also, you can define your own properties. |
Actuator Properties
| Name | Description | Default Value |
|---|---|---|
AppOptics API token. |
||
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Whether to ship a floored time, useful when sending measurements from multiple hosts to align them on a given time boundary. |
|
|
Tag that will be mapped to "@host" when shipping metrics to AppOptics. |
|
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI to ship metrics to. |
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Frequency for refreshing config settings from the LWC service. |
|
|
Time to live for subscriptions from the LWC service. |
|
|
URI for the Atlas LWC endpoint to retrieve current subscriptions. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
URI for the Atlas LWC endpoint to evaluate the data for a subscription. |
|
|
Whether to enable streaming to Atlas LWC. |
|
|
Whether expressions with the same step size as Atlas publishing should be ignored for streaming. Used for cases where data being published to Atlas is also sent into streaming from the backend. |
|
|
Step size (reporting frequency) to use for streaming to Atlas LWC. This is the highest supported resolution for getting an on-demand stream of the data. It must be less than or equal to management.metrics.export.atlas.step and management.metrics.export.atlas.step should be an even multiple of this value. |
|
|
Time to live for meters that do not have any activity. After this period the meter will be considered expired and will not get reported. |
|
|
Number of threads to use with the metrics publishing scheduler. |
|
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI of the Atlas server. |
|
|
Whether to enable storage of audit events. |
|
|
Whether to enable extended Cloud Foundry actuator endpoints. |
|
|
Whether to skip SSL verification for Cloud Foundry actuator endpoint security calls. |
|
|
Datadog API key. |
||
Datadog application key. Not strictly required, but improves the Datadog experience by sending meter descriptions, types, and base units to Datadog. |
||
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether to publish descriptions metadata to Datadog. Turn this off to minimize the amount of metadata sent. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Tag that will be mapped to "host" when shipping metrics to Datadog. |
|
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI to ship metrics to. Set this if you need to publish metrics to a Datadog site other than US, or to an internal proxy en-route to Datadog. |
|
|
Whether to enable default metrics exporters. |
|
|
Dynatrace authentication token. |
||
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI to ship metrics to. Should be used for SaaS, self-managed instances or to en-route through an internal proxy. |
||
ID of the custom device that is exporting metrics to Dynatrace. |
||
Group for exported metrics. Used to specify custom device group name in the Dynatrace UI. |
||
Technology type for exported metrics. Used to group metrics under a logical technology name in the Dynatrace UI. |
|
|
Default dimensions that are added to all metrics in the form of key-value pairs. These are overwritten by Micrometer tags if they use the same key. |
||
|
Whether to enable Dynatrace metadata export. |
|
|
Whether to export meter metadata (unit and description) to the Dynatrace backend. |
|
Prefix string that is added to all exported metrics. |
||
|
Whether to fall back to the built-in micrometer instruments for Timer and DistributionSummary. |
|
Base64-encoded credentials string. Mutually exclusive with user-name and password. |
||
Whether to create the index automatically if it does not exist. |
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether to enable _source in the default index template when auto-creating the index. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Host to export metrics to. |
|
|
Index to export metrics to. |
|
|
Index date format used for rolling indices. Appended to the index name. |
|
|
Prefix to separate the index name from the date format used for rolling indices. |
|
|
Login password of the Elastic server. Mutually exclusive with api-key-credentials. |
||
Ingest pipeline name. By default, events are not pre-processed. |
||
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
Name of the timestamp field. |
|
|
Login user of the Elastic server. Mutually exclusive with api-key-credentials. |
||
Permitted level of access for the auditevents endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the beans endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the caches endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the conditions endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the configprops endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Roles used to determine whether a user is authorized to be shown unsanitized values. When empty, all authenticated users are authorized. |
||
When to show unsanitized values. |
|
|
Permitted level of access for the env endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Roles used to determine whether a user is authorized to be shown unsanitized values. When empty, all authenticated users are authorized. |
||
When to show unsanitized values. |
|
|
Permitted level of access for the flyway endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the health endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Health endpoint groups. |
||
Threshold after which a warning will be logged for slow health indicators. |
|
|
Whether to make the liveness and readiness health groups available on the main server port. |
|
|
Whether to enable liveness and readiness probes. |
|
|
Roles used to determine whether a user is authorized to be shown details. When empty, all authenticated users are authorized. |
||
When to show components. If not specified the 'show-details' setting will be used. |
||
When to show full health details. |
|
|
Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200). |
||
List of health statuses in order of severity. |
|
|
Whether to validate health group membership on startup. Validation fails if a group includes or excludes a health contributor that does not exist. |
|
|
Permitted level of access for the heapdump endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the httpexchanges endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the info endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the integrationgraph endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the liquibase endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the logfile endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
External Logfile to be accessed. Can be used if the logfile is written by output redirect and not by the logging system itself. |
||
Permitted level of access for the loggers endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the mappings endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the metrics endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the prometheus endpoint. |
|
|
Permitted level of access for the quartz endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Roles used to determine whether a user is authorized to be shown unsanitized job or trigger values. When empty, all authenticated users are authorized. |
||
When to show unsanitized job or trigger values. |
|
|
Permitted level of access for the sbom endpoint. |
|
|
Additional SBOMs. |
||
Location to the SBOM. If null, the location will be auto-detected. |
||
Media type of the SBOM. If null, the media type will be auto-detected. |
||
Maximum time that a response can be cached. |
|
|
Permitted level of access for the scheduledtasks endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the sessions endpoint. |
|
|
Permitted level of access for the shutdown endpoint. |
|
|
Permitted level of access for the startup endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Permitted level of access for the threaddump endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Default access level for all endpoints. |
||
The maximum level of endpoint access that is permitted. Caps an endpoint's individual access level (management.endpoint.<id>.access) and the default access (management.endpoints.access.default).' |
|
|
Whether to use an isolated object mapper to serialize endpoint JSON. |
|
|
Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set. |
|
|
Endpoint IDs that should be excluded or '*' for all. |
||
Endpoint IDs that should be included or '*' for all. |
|
|
Additional static properties to append to all ObjectNames of MBeans representing Endpoints. |
||
Whether to transparently migrate legacy endpoint IDs. |
|
|
Base path for Web endpoints. Relative to the servlet context path (server.servlet.context-path) or WebFlux base path (spring.webflux.base-path) when the management server is sharing the main server port. Relative to the management server base path (management.server.base-path) when a separate management server port (management.server.port) is configured. |
|
|
Whether credentials are supported. When not set, credentials are not supported. |
||
List of headers to allow in a request. '*' allows all headers. |
||
List of methods to allow. '*' allows all methods. When not set, defaults to GET. |
||
List of origin patterns to allow. Unlike allowed origins which only supports '*', origin patterns are more flexible (for example 'https://*.example.com') and can be used when credentials are allowed. When no allowed origin patterns or allowed origins are set, CORS support is disabled. |
||
List of origins to allow. '*' allows all origins. When credentials are allowed, '*' cannot be used and origin patterns should be configured instead. When no allowed origins or allowed origin patterns are set, CORS support is disabled. |
||
List of headers to include in a response. |
||
How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used. |
|
|
Whether the discovery page is enabled. |
|
|
Endpoint IDs that should be excluded or '*' for all. |
||
Endpoint IDs that should be included or '*' for all. |
|
|
Mapping between endpoint IDs and the path that should expose them. |
||
UDP addressing mode, either unicast or multicast. |
|
|
Base time unit used to report durations. |
|
|
Whether exporting of metrics to Ganglia is enabled. |
|
|
Host of the Ganglia server to receive exported metrics. |
|
|
Port of the Ganglia server to receive exported metrics. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
Time to live for metrics on Ganglia. Set the multicast Time-To-Live to be one greater than the number of hops (routers) between the hosts. |
|
|
Base time unit used to report durations. |
|
|
Whether exporting of metrics to Graphite is enabled. |
|
|
Whether Graphite tags should be used, as opposed to a hierarchical naming convention. Enabled by default unless "tagsAsPrefix" is set. |
||
Host of the Graphite server to receive exported metrics. |
|
|
Port of the Graphite server to receive exported metrics. |
|
|
Protocol to use while shipping data to Graphite. |
|
|
Base time unit used to report rates. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
For the hierarchical naming convention, turn the specified tag keys into part of the metric prefix. Ignored if "graphiteTagsEnabled" is true. |
|
|
Whether to enable Cassandra health check. |
|
|
Whether to enable Couchbase health check. |
|
|
Whether to enable database health check. |
|
|
Whether to ignore AbstractRoutingDataSources when creating database health indicators. |
|
|
Whether to enable default health indicators. |
|
|
Whether to enable disk space health check. |
|
|
Path used to compute the available disk space. |
||
Minimum disk space that should be available. |
|
|
Whether to enable Elasticsearch health check. |
|
|
Whether to enable InfluxDB health check. |
|
|
Whether to enable JMS health check. |
|
|
Whether to enable LDAP health check. |
|
|
Whether to enable liveness state health check. |
|
|
Whether to enable Mail health check. |
|
|
Whether to enable MongoDB health check. |
|
|
Whether to enable Neo4j health check. |
|
|
Whether to enable ping health check. |
|
|
Whether to enable RabbitMQ health check. |
|
|
Whether to enable readiness state health check. |
|
|
Whether to enable Redis health check. |
|
|
|
If an SSL Certificate will be invalid within the time span defined by this threshold, it should trigger a warning. |
|
Whether to enable SSL certificate health check. |
|
|
Whether to enable HTTP request-response exchange recording. |
|
|
Items to be included in the exchange recording. Defaults to request headers (excluding Authorization and Cookie), response headers (excluding Set-Cookie), and time taken. |
|
|
Humio API token. |
||
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
Humio tags describing the data source in which metrics will be stored. Humio tags are a distinct concept from Micrometer's tags. Micrometer's tags are used to divide metrics along dimensional boundaries. |
||
URI to ship metrics to. If you need to publish metrics to an internal proxy en-route to Humio, you can define the location of the proxy with this. |
|
|
API version of InfluxDB to use. Defaults to 'v1' unless an org is configured. If an org is configured, defaults to 'v2'. |
||
Whether to create the Influx database if it does not exist before attempting to publish metrics to it. InfluxDB v1 only. |
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Bucket for metrics. Use either the bucket name or ID. Defaults to the value of the db property if not set. InfluxDB v2 only. |
||
Whether to enable GZIP compression of metrics batches published to Influx. |
|
|
Connection timeout for requests to this backend. |
|
|
Write consistency for each point. |
|
|
Database to send metrics to. InfluxDB v1 only. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Org to write metrics to. InfluxDB v2 only. |
||
Login password of the Influx server. InfluxDB v1 only. |
||
Read timeout for requests to this backend. |
|
|
Time period for which Influx should retain data in the current database. For instance 7d, check the influx documentation for more details on the duration format. InfluxDB v1 only. |
||
Retention policy to use (Influx writes to the DEFAULT retention policy if one is not specified). InfluxDB v1 only. |
||
|
How many copies of the data are stored in the cluster. Must be 1 for a single node instance. InfluxDB v1 only. |
|
Time range covered by a shard group. For instance 2w, check the influx documentation for more details on the duration format. InfluxDB v1 only. |
||
Step size (i.e. reporting frequency) to use. |
|
|
Authentication token to use with calls to the InfluxDB backend. For InfluxDB v1, the Bearer scheme is used. For v2, the Token scheme is used. |
||
URI of the Influx server. |
|
|
Login user of the Influx server. InfluxDB v1 only. |
||
Whether to enable build info. |
|
|
Whether to enable default info contributors. |
|
|
Whether to enable environment info. |
|
|
Whether to enable git info. |
|
|
Mode to use to expose git information. |
|
|
Whether to enable Java info. |
|
|
Whether to enable Operating System info. |
|
|
Whether to enable process info. |
|
|
Whether to enable SSL certificate info. |
|
|
Metrics JMX domain name. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Login password of the KairosDB server. |
||
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI of the KairosDB server. |
|
|
Login user of the KairosDB server. |
||
Whether auto-configuration of logging is enabled to export logs. |
|
|
Whether to enable auto-timing. |
|
|
Percentiles for which additional time series should be published. |
||
|
Whether to publish percentile histograms. |
|
Name of the metric for sent requests. |
|
|
Number of histograms for meter IDs starting with the specified name to keep in the ring buffer. The longest match wins, the key `all` can also be used to configure all meters. |
||
Maximum amount of time that samples for meter IDs starting with the specified name are accumulated to decaying distribution statistics before they are reset and rotated. The longest match wins, the key `all` can also be used to configure all meters. |
||
Maximum value that meter IDs starting with the specified name are expected to observe. The longest match wins. Values can be specified as a double or as a Duration value (for timer meters, defaulting to ms if no unit specified). |
||
Minimum value that meter IDs starting with the specified name are expected to observe. The longest match wins. Values can be specified as a double or as a Duration value (for timer meters, defaulting to ms if no unit specified). |
||
Specific computed non-aggregable percentiles to ship to the backend for meter IDs starting-with the specified name. The longest match wins, the key 'all' can also be used to configure all meters. |
||
Whether meter IDs starting with the specified name should publish percentile histograms. For monitoring systems that support aggregable percentile calculation based on a histogram, this can be set to true. For other systems, this has no effect. The longest match wins, the key 'all' can also be used to configure all meters. |
||
Specific service-level objective boundaries for meter IDs starting with the specified name. The longest match wins. Counters will be published for each specified boundary. Values can be specified as a double or as a Duration value (for timer meters, defaulting to ms if no unit specified). |
||
Whether meter IDs starting with the specified name should be enabled. The longest match wins, the key 'all' can also be used to configure all meters. |
||
Whether to enable Mongo client command metrics. |
|
|
Whether to enable Mongo connection pool metrics. |
|
|
List of paths to report disk metrics for. |
|
|
Common tags that are applied to every meter. |
||
Whether auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics. For testing, set this to 'false' to maximize test independence. |
|
|
Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter. |
|
|
Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter. |
|
|
New Relic account ID. |
||
New Relic API key. |
||
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Client provider type to use. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
The event type that should be published. This property will be ignored if 'meter-name-event-type-enabled' is set to 'true'. |
|
|
|
Whether to send the meter name as the event type instead of using the 'event-type' configuration property value. Can be set to 'true' if New Relic guidelines are not being followed or event types consistent with previous Spring Boot releases are required. |
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI to ship metrics to. |
|
|
Whether auto-configuration of Micrometer annotations is enabled. |
|
|
Whether observations starting with the specified name should be enabled. The longest match wins, the key 'all' can also be used to configure all observations. |
||
Name of the observation for client requests. |
|
|
Name of the observation for server requests. |
|
|
Common key-values that are applied to every observation. |
||
Whether to create a LongTaskTimer for every observation. |
|
|
Whether to tag actual query parameter values. |
|
|
Resource attributes. |
||
Method used to compress the payload. |
|
|
Connect timeout for the OTel collector connection. |
|
|
URL to the OTel collector's HTTP API. |
||
Whether auto-configuration of logging is enabled to export OTLP logs. |
||
Custom HTTP headers you want to pass to the collector, for example auth headers. |
||
Call timeout for the OTel Collector to process an exported batch of data. This timeout spans the entire call: resolving DNS, connecting, writing the request body, server processing, and reading the response body. If the call requires redirects or retries all must complete within one timeout period. |
|
|
Transport used to send the spans. |
|
|
Aggregation temporality of sums. It defines the way additive values are expressed. This setting depends on the backend you use, some only support one temporality. |
|
|
Time unit for exported metrics. |
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Headers for the exported metrics. |
||
Histogram type to be preferred when histogram publishing is enabled. |
|
|
Maximum number of buckets to be used for exponential histograms, if configured. This has no effect on explicit bucket histograms. |
|
|
Max scale to use for exponential histograms, if configured. |
|
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI of the OTLP server. |
|
|
Method used to compress the payload. |
|
|
Connect timeout for the OTel collector connection. |
|
|
URL to the OTel collector's HTTP API. |
||
Whether auto-configuration of tracing is enabled to export OTLP traces. |
||
Custom HTTP headers you want to pass to the collector, for example auth headers. |
||
Call timeout for the OTel Collector to process an exported batch of data. This timeout spans the entire call: resolving DNS, connecting, writing the request body, server processing, and reading the response body. If the call requires redirects or retries all must complete within one timeout period. |
|
|
Transport used to send the spans. |
|
|
Whether to enable publishing descriptions as part of the scrape payload to Prometheus. Turn this off to minimize the amount of data sent on each scrape. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Additional properties to pass to the Prometheus client. |
||
Base URL for the Pushgateway. |
|
|
Enable publishing over a Prometheus Pushgateway. |
|
|
|
Grouping key for the pushed metrics. |
|
Job identifier for this application instance. |
||
Login password of the Prometheus Pushgateway. |
||
Frequency with which to push metrics. |
|
|
|
Operation that should be performed on shutdown. |
|
Login user of the Prometheus Pushgateway. |
||
Step size (i.e. reporting frequency) to use. |
|
|
Add the "X-Application-Context" HTTP header in each response. |
|
|
Network address to which the management endpoints should bind. Requires a custom management.server.port. |
||
Management endpoint base path (for instance, '/management'). Requires a custom management.server.port. |
||
Management endpoint HTTP port (uses the same port as the application by default). Configure a different port to use management-specific SSL. |
||
The name of a configured SSL bundle. |
||
Path to a PEM-encoded SSL certificate file. |
||
Path to a PEM-encoded private key file for the SSL certificate. |
||
Supported SSL ciphers. |
||
Client authentication mode. Requires a trust store. |
||
Whether to enable SSL support. |
|
|
Enabled SSL protocols. |
||
Alias that identifies the key in the key store. |
||
Password used to access the key in the key store. |
||
Path to the key store that holds the SSL certificate (typically a jks file). |
||
Password used to access the key store. |
||
Provider for the key store. |
||
Type of the key store. |
||
SSL protocol to use. |
|
|
Mapping of host names to SSL bundles for SNI configuration. |
||
Path to a PEM-encoded SSL certificate authority file. |
||
Path to a PEM-encoded private key file for the SSL certificate authority. |
||
Trust store that holds SSL certificates. |
||
Password used to access the trust store. |
||
Provider for the trust store. |
||
Type of the trust store. |
||
SignalFX access token. |
||
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Type of histogram to publish. |
|
|
Read timeout for requests to this backend. |
|
|
Uniquely identifies the app instance that is publishing metrics to SignalFx. Defaults to the local host name. |
||
Step size (i.e. reporting frequency) to use. |
|
|
URI to ship metrics to. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Counting mode. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Prefix for metric type. Valid prefixes are described in the Google Cloud documentation (https://cloud.google.com/monitoring/custom-metrics#identifier). |
|
|
Identifier of the Google Cloud project to monitor. |
||
Read timeout for requests to this backend. |
|
|
Monitored resource's labels. |
||
Monitored resource type. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
|
Whether to use semantically correct metric types. When false, counter metrics are published as the GAUGE MetricKind. When true, counter metrics are published as the CUMULATIVE MetricKind. |
|
Whether measurements should be buffered before sending to the StatsD server. |
|
|
Whether exporting of metrics to StatsD is enabled. |
|
|
StatsD line protocol to use. |
|
|
Host of the StatsD server to receive exported metrics. |
|
|
Total length of a single payload should be kept within your network's MTU. |
|
|
How often gauges will be polled. When a gauge is polled, its value is recalculated and if the value has changed (or publishUnchangedMeters is true), it is sent to the StatsD server. |
|
|
Port of the StatsD server to receive exported metrics. |
|
|
Protocol of the StatsD server to receive exported metrics. |
|
|
Whether to send unchanged meters to the StatsD server. |
|
|
Step size to use in computing windowed statistics like max. To get the most out of these statistics, align the step interval to be close to your scrape interval. |
|
|
Whether to enable correlation of the baggage context with logging contexts. |
|
|
List of fields that should be correlated with the logging context. That means that these fields would end up as key-value pairs in e.g. MDC. |
||
Whether to enable Micrometer Tracing baggage propagation. |
|
|
List of fields that should be accessible within the JVM process but not propagated over the wire. Local fields are not supported with OpenTelemetry. |
||
List of fields that are referenced the same in-process as it is on the wire. For example, the field "x-vcap-request-id" would be set as-is including the prefix. |
||
List of fields that should automatically become tags. |
||
Whether the propagation type and tracing backend support sharing the span ID between client and server spans. Requires B3 propagation and a compatible backend. |
|
|
Whether auto-configuration of tracing is enabled to export and propagate traces. |
|
|
Tracing context propagation types consumed by the application. |
|
|
Tracing context propagation types produced by the application. |
|
|
Tracing context propagation types produced and consumed by the application. Setting this property overrides the more fine-grained propagation type properties. |
||
Probability in the range from 0.0 to 1.0 that a trace will be sampled. |
|
|
API token used when publishing metrics and traces directly to the Wavefront API host. |
||
Type of the API token. |
||
Wavefront Cluster name used in ApplicationTags. |
||
Wavefront custom tags used in ApplicationTags. |
||
Wavefront 'Application' name used in ApplicationTags. |
|
|
Wavefront 'Service' name used in ApplicationTags, falling back to 'spring.application.name'. If both are unset it defaults to 'unnamed_service'. |
||
Wavefront Shard name used in ApplicationTags. |
||
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Connection timeout for requests to this backend. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
|
Global prefix to separate metrics originating from this app's instrumentation from those originating from other Wavefront integrations when viewed in the Wavefront UI. |
||
Read timeout for requests to this backend. |
|
|
Whether to report histogram distributions aggregated into day intervals. |
|
|
|
Whether to report histogram distributions aggregated into hour intervals. |
|
|
Whether to report histogram distributions aggregated into minute intervals. |
|
Step size (i.e. reporting frequency) to use. |
|
|
Number of measurements per request to use for Wavefront. If more measurements are found, then multiple requests will be made. |
|
|
Flush interval to send queued messages. |
|
|
Maximum size of queued messages. |
|
|
Maximum size of a message. |
||
Unique identifier for the app instance that is the source of metrics and traces being published to Wavefront. Defaults to the local host name. |
||
Customized span tags for RED metrics. |
||
Whether auto-configuration of tracing is enabled to export Wavefront traces. |
||
URI to ship metrics and traces to. |
|
|
Connection timeout for requests to Zipkin. |
|
|
How to encode the POST body to the Zipkin API. |
|
|
URL to the Zipkin API. |
|
|
Whether auto-configuration of tracing is enabled to export Zipkin traces. |
||
Read timeout for requests to Zipkin. |
|
Cache Properties
| Name | Description | Default Value |
|---|---|---|
List of cache names to create if supported by the underlying cache manager. Usually, this disables the ability to create additional caches on-the-fly. |
||
The spec to use to create caches. See CaffeineSpec for more details on the spec format. |
||
Entry expiration. By default the entries never expire. Note that this value is ultimately converted to seconds. |
||
The location of the configuration file to use to initialize Infinispan. |
||
The location of the configuration file to use to initialize the cache manager. The configuration file is dependent of the underlying cache implementation. |
||
Fully qualified name of the CachingProvider implementation to use to retrieve the JSR-107 compliant cache manager. Needed only if more than one JSR-107 implementation is available on the classpath. |
||
Allow caching null values. |
|
|
Whether to enable cache statistics. |
|
|
Key prefix. |
||
Entry expiration. By default the entries never expire. |
||
Whether to use the key prefix when writing to Redis. |
|
|
Cache type. By default, auto-detected according to the environment. |
Core Properties
| Name | Description | Default Value |
|---|---|---|
Enable debug logs. |
|
|
Arbitrary properties to add to the info endpoint. |
||
Charset to use for console output. |
||
Charset to use for file output. |
||
Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback. |
||
Conversion word used when logging exceptions. |
|
|
Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory. |
||
Location of the log file. For instance, `/var/log`. |
||
Log groups to quickly change multiple loggers at the same time. For instance, `logging.group.db=org.hibernate,org.springframework.jdbc`. |
||
Whether to include the application group in the logs. |
|
|
Whether to include the application name in the logs. |
|
|
Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`. |
||
Overriding configuration files used to create a composite configuration. |
||
Whether to clean the archive log files on startup. |
|
|
Pattern for rolled-over log file names. |
|
|
Maximum log file size. |
|
|
Maximum number of archive log files to keep. |
|
|
Total size of log backups to be kept. |
|
|
Appender pattern for output to the console. Its default value varies according to the logging system. |
||
Appender pattern for log correlation. Its default value varies according to the logging system. |
||
Appender pattern for log date format. |
|
|
Appender pattern for output to a file. Its default value varies according to the logging system. |
||
Appender pattern for log level. |
|
|
Register a shutdown hook for the logging system when it is initialized. Disabled automatically when deployed as a war file. |
|
|
Structured ECS service environment. |
||
Structured ECS service name (defaults to 'spring.application.name'). |
||
Structured ECS service node name. |
||
Structured ECS service version (defaults to 'spring.application.version'). |
||
Structured logging format for output to the console. Must be either a format id or a fully qualified class name. |
||
Structured logging format for output to a file. Must be either a format id or a fully qualified class name. |
||
Structured GELF host (defaults to 'spring.application.name'). |
||
Structured GELF service version (defaults to 'spring.application.version'). |
||
Additional members that should be added to structured logging JSON |
||
The fully qualified class name of a StructureLoggingJsonMembersCustomizer |
||
Member paths that should be excluded from structured logging JSON |
||
Member paths that should be included in structured logging JSON |
||
Mapping between member paths and an alternative name that should be used in structured logging JSON |
||
Log level threshold for console output. |
|
|
Log level threshold for file output. |
|
|
Add @EnableAspectJAutoProxy. |
|
|
Whether subclass-based (CGLIB) proxies are to be created (true), as opposed to standard Java interface-based proxies (false). |
|
|
Whether to enable admin features for the application. |
|
|
JMX name of the application admin MBean. |
|
|
Application group. |
||
Application name. |
||
Application version (defaults to 'Implementation-Version' from the manifest). |
||
Auto-configuration classes to exclude. |
||
Banner file encoding. |
|
|
Banner text resource location. |
|
|
Whether to skip search of BeanInfo classes. |
|
|
Whether to log form data at DEBUG level, and headers at TRACE level. |
|
|
Limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated. This applies only to the auto-configured WebFlux server and WebClient instances. By default this is not set, in which case individual codec defaults apply. Most codecs are limited to 256K by default. |
||
Required cloud platform for the document to be included. |
||
Profile expressions that should match for the document to be included. |
||
Config file locations used in addition to the defaults. |
||
Import additional config data. |
||
Config file locations that replace the defaults. |
||
Config file name. |
|
|
File encoding. |
|
|
Location of the generated build-info.properties file. |
|
|
File encoding. |
|
|
Location of the generated git.properties file. |
|
|
JMX domain name. |
||
Expose Spring's management beans to the JMX domain. |
|
|
JMX Registration policy. |
|
|
MBeanServer bean name. |
|
|
Whether unique runtime object names should be ensured. |
|
|
Timeout for the shutdown of any phase (group of SmartLifecycle beans with the same 'phase' value). |
|
|
Whether bean definition overriding, by registering a definition with the same name as an existing definition, is allowed. |
|
|
Whether to allow circular references between beans and automatically try to resolve them. |
|
|
Mode used to display the banner when the application runs. Defaults to 'off' if structured logging is enabled or to 'console' otherwise |
||
Override the Cloud Platform auto-detection. |
||
Whether to keep the application alive even if there are no more non-daemon threads. |
|
|
Whether initialization should be performed lazily. |
|
|
Whether to log information about the application when it starts. |
|
|
Whether the application should have a shutdown hook registered. |
|
|
Sources (class names, package names, or XML resource locations) to include in the ApplicationContext. |
||
Flag to explicitly request a specific type of web application. If not set, auto-detected based on the classpath. |
||
Expected character encoding the application must use. |
||
Whether to always apply the MessageFormat rules, parsing even messages without arguments. |
|
|
List of basenames (essentially a fully-qualified classpath location), each following the ResourceBundle convention with relaxed support for slash based locations. If it doesn't contain a package qualifier (such as "org.mypackage"), it will be resolved from the classpath root. |
|
|
Loaded resource bundle files cache duration. When not set, bundles are cached forever. If a duration suffix is not specified, seconds will be used. |
||
List of locale-independent property file resources containing common messages. |
||
Message bundles encoding. |
|
|
Whether to fall back to the system Locale if no files for a specific Locale have been found. if this is turned off, the only fallback will be the default file (e.g. "messages.properties" for basename "messages"). |
|
|
Whether to use the message code as the default message instead of throwing a "NoSuchMessageException". Recommended during development only. |
|
|
Configures the ANSI output. |
|
|
Fails if ApplicationPidFileWriter is used but it cannot write the PID file. |
||
Location of the PID file to write (if ApplicationPidFileWriter is used). |
||
Comma-separated list of active profiles. Can be overridden by a command line switch. |
||
Name of the profile to enable if no profile is active. |
|
|
Profile groups to define a logical name for a related group of profiles. |
||
Unconditionally activate the specified comma-separated list of profiles (or list of profiles if using YAML). |
||
Whether to automatically start the scheduler after initialization. |
|
|
Prefixes for single-line comments in SQL initialization scripts. |
|
|
Database schema initialization mode. |
|
|
Platform to use in initialization scripts if the @@platform@@ placeholder is used. Auto-detected by default. |
||
Path to the SQL file to use to initialize the database schema. |
|
|
Quartz job store type. |
|
|
Whether configured jobs should overwrite existing job definitions. |
|
|
Additional Quartz Scheduler properties. |
||
Name of the scheduler. |
|
|
Delay after which the scheduler is started once initialization completes. Setting this property makes sense if no jobs should be run before the entire application has started up. |
|
|
Whether to wait for running jobs to complete on shutdown. |
|
|
Context Propagation support mode for Reactor operators. |
|
|
Whether the Reactor Debug Agent should be enabled when reactor-tools is present. |
|
|
Amount of time to wait before shutting down resources. |
||
Java keystore SSL trust material. |
||
PEM-encoded SSL trust material. |
||
Quiet period, after which changes are detected. |
|
|
Whether core threads are allowed to time out. This enables dynamic growing and shrinking of the pool. Doesn't have an effect if virtual threads are enabled. |
|
|
Core number of threads. Doesn't have an effect if virtual threads are enabled. |
|
|
Time limit for which threads may remain idle before being terminated. Doesn't have an effect if virtual threads are enabled. |
|
|
Maximum allowed number of threads. If tasks are filling up the queue, the pool can expand up to that size to accommodate the load. Ignored if the queue is unbounded. Doesn't have an effect if virtual threads are enabled. |
||
Queue capacity. An unbounded capacity does not increase the pool and therefore ignores the "max-size" property. Doesn't have an effect if virtual threads are enabled. |
||
|
Whether to accept further tasks after the application context close phase has begun. |
|
Whether the executor should wait for scheduled tasks to complete on shutdown. |
|
|
Maximum time the executor should wait for remaining tasks to complete. |
||
Set the maximum number of parallel accesses allowed. -1 indicates no concurrency limit at all. |
||
Prefix to use for the names of newly created threads. |
|
|
Maximum allowed number of threads. Doesn't have an effect if virtual threads are enabled. |
|
|
Whether the executor should wait for scheduled tasks to complete on shutdown. |
|
|
Maximum time the executor should wait for remaining tasks to complete. |
||
Set the maximum number of parallel accesses allowed. -1 indicates no concurrency limit at all. |
||
Prefix to use for the names of newly created threads. |
|
|
Whether to use virtual threads. |
|
|
Enable trace logs. |
|
Data Migration Properties
| Name | Description | Default Value |
|---|---|---|
Description to tag an existing schema with when applying a baseline. |
|
|
Whether to automatically call baseline when migrating a non-empty schema. |
|
|
Version to tag an existing schema with when executing baseline. |
|
|
Whether to batch SQL statements when executing them. Requires Flyway Teams. |
||
Whether to disable cleaning of the database. |
|
|
Whether to enable community database support. |
|
|
Maximum number of retries when attempting to connect to the database. |
|
|
Maximum time between retries when attempting to connect to the database. If a duration suffix is not specified, seconds will be used. |
|
|
Whether Flyway should attempt to create the schemas specified in the schemas property. |
|
|
Default schema name managed by Flyway (case-sensitive). |
||
Whether to attempt to automatically detect SQL migration file encoding. Requires Flyway Teams. |
||
Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. |
||
Whether to enable flyway. |
|
|
Encoding of SQL migrations. |
|
|
Rules for the built-in error handling to override specific SQL states and error codes. Requires Flyway Teams. |
||
Whether Flyway should execute SQL within a transaction. |
|
|
Whether to fail if a location of migration scripts doesn't exist. |
|
|
Whether to group all pending migrations together in the same transaction when applying them. |
|
|
List of patterns that identify migrations to ignore when performing validation. Requires Flyway Teams. |
||
SQL statements to execute to initialize a connection immediately after obtaining it. |
||
Username recorded in the schema history table as having applied the migration. |
||
Properties to pass to the JDBC driver. Requires Flyway Teams. |
||
Path of the Kerberos config file. Requires Flyway Teams. |
||
Locations of migrations scripts. Can contain the special "{vendor}" placeholder to use vendor-specific locations. |
|
|
Maximum number of retries when trying to obtain a lock. |
|
|
Loggers Flyway should use. |
|
|
Whether to allow mixing transactional and non-transactional statements within the same migration. |
|
|
Path of the Oracle Kerberos cache file. Requires Flyway Teams. |
||
Whether to enable support for Oracle SQL*Plus commands. Requires Flyway Teams. |
||
Whether to issue a warning rather than an error when a not-yet-supported Oracle SQL*Plus statement is encountered. Requires Flyway Teams. |
||
Location of the Oracle Wallet, used to sign in to the database automatically. Requires Flyway Teams. |
||
Whether to allow migrations to be run out of order. |
|
|
Whether Flyway should output a table with the results of queries when executing migrations. Requires Flyway Teams. |
||
Login password of the database to migrate. |
||
Prefix of placeholders in migration scripts. |
|
|
Perform placeholder replacement in migration scripts. |
|
|
Separator of default placeholders. |
|
|
Suffix of placeholders in migration scripts. |
|
|
Placeholders and their replacements to apply to sql migration scripts. |
||
Whether transactional advisory locks should be used. If set to false, session-level locks are used instead. |
||
File name prefix for repeatable SQL migrations. |
|
|
Scheme names managed by Flyway (case-sensitive). |
||
Prefix of placeholders in migration scripts. |
|
|
Suffix of placeholders in migration scripts. |
|
|
Whether to skip default callbacks. If true, only custom callbacks are used. |
|
|
Whether to skip default resolvers. If true, only custom resolvers are used. |
|
|
Whether Flyway should skip executing the contents of the migrations and only update the schema history table. Requires Flyway teams. |
||
File name prefix for SQL migrations. |
|
|
File name separator for SQL migrations. |
|
|
File name suffix for SQL migrations. |
|
|
Path to the SQL Server Kerberos login file. Requires Flyway Teams. |
||
Whether to stream SQL migrations when executing them. Requires Flyway Teams. |
||
Name of the schema history table that will be used by Flyway. |
|
|
Tablespace in which the schema history table is created. Ignored when using a database that does not support tablespaces. Defaults to the default tablespace of the connection used by Flyway. |
||
Target version up to which migrations should be considered. |
|
|
JDBC url of the database to migrate. If not set, the primary configured data source is used. |
||
Login user of the database to migrate. |
||
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. |
|
|
Whether to automatically call validate when performing a migration. |
|
|
Change log configuration path. |
|
|
Whether to clear all checksums in the current changelog, so they will be recalculated upon the next update. |
|
|
List of runtime contexts to use. |
||
Name of table to use for tracking concurrent Liquibase usage. |
|
|
Name of table to use for tracking change history. |
|
|
Default database schema. |
||
Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. |
||
Whether to first drop the database schema. |
|
|
Whether to enable Liquibase support. |
|
|
List of runtime labels to use. |
||
Schema to use for Liquibase objects. |
||
Tablespace to use for Liquibase objects. |
||
Change log parameters. |
||
Login password of the database to migrate. |
||
File to which rollback SQL is written when an update is performed. |
||
Whether to print a summary of the update operation. |
|
|
Where to print a summary of the update operation. |
|
|
Tag name to use when applying database changes. Can also be used with "rollbackFile" to generate a rollback script for all existing changes associated with that tag. |
||
Whether rollback should be tested before update is performed. |
|
|
Which UIService to use. |
|
|
JDBC URL of the database to migrate. If not set, the primary configured data source is used. |
||
Login user of the database to migrate. |
||
Whether initialization should continue when an error occurs. |
|
|
Locations of the data (DML) scripts to apply to the database. |
||
Encoding of the schema and data scripts. |
||
Mode to apply when determining whether initialization should be performed. |
|
|
Password of the database to use when applying initialization scripts (if different). |
||
Platform to use in the default schema or data script locations, schema-${platform}.sql and data-${platform}.sql. |
|
|
Locations of the schema (DDL) scripts to apply to the database. |
||
Statement separator in the schema and data scripts. |
|
|
Username of the database to use when applying initialization scripts (if different). |
Data Properties
| Name | Description | Default Value |
|---|---|---|
Compression supported by the Cassandra binary protocol. |
|
|
Location of the configuration file to use. |
||
Timeout to use when establishing driver connections. |
|
|
Timeout to use for internal queries that run as part of the initialization process, just after a connection is opened. |
|
|
Cluster node addresses in the form 'host:port', or a simple 'host' to use the configured port. |
|
|
Timeout to use for control queries. |
|
|
Keyspace name to use. |
||
Datacenter that is considered "local". Contact points should be from this datacenter. |
||
Login password of the server. |
||
Heartbeat interval after which a message is sent on an idle connection to make sure it's still alive. |
|
|
Idle timeout before an idle connection is removed. |
|
|
Port to use if a contact point does not specify one. |
|
|
Queries consistency level. |
||
How many rows will be retrieved simultaneously in a single network round-trip. |
|
|
Queries serial consistency level. |
||
How often the throttler attempts to dequeue requests. Set this high enough that each attempt will process multiple entries in the queue, but not delay requests too much. |
||
Maximum number of requests that are allowed to execute in parallel. |
||
Maximum number of requests that can be enqueued when the throttling threshold is exceeded. |
||
Maximum allowed request rate. |
||
Request throttling type. |
|
|
How long the driver waits for a request to complete. |
|
|
Schema action to take at startup. |
|
|
Name of the Cassandra session. |
||
SSL bundle name. |
||
Whether to enable SSL support. |
||
Login user of the server. |
||
Java KeyStore location for certificate-based cluster authentication. |
||
Java KeyStore password for certificate-based cluster authentication. |
||
Private key password for certificate-based cluster authentication. |
||
PEM-formatted certificates for certificate-based cluster authentication. |
||
PEM-formatted private key for certificate-based cluster authentication. |
||
Private key password for certificate-based cluster authentication. |
||
Connection string used to locate the Couchbase cluster. |
||
Length of time an HTTP connection may remain idle before it is closed and removed from the pool. |
|
|
Maximum number of sockets per node. |
|
|
Minimum number of sockets per node. |
|
|
SSL bundle name. |
||
Whether to enable SSL support. Enabled automatically if a "bundle" is provided unless specified otherwise. |
||
Timeout for the analytics service. |
|
|
Bucket connect timeout. |
|
|
Bucket disconnect timeout. |
|
|
Timeout for operations on a specific key-value. |
|
|
Timeout for operations on a specific key-value with a durability level. |
|
|
Timeout for the management operations. |
|
|
N1QL query operations timeout. |
|
|
Timeout for the search service. |
|
|
Regular and geospatial view operations timeout. |
|
|
Cluster password. |
||
Cluster username. |
||
Whether to enable the PersistenceExceptionTranslationPostProcessor. |
|
|
Type of Cassandra repositories to enable. |
|
|
Automatically create views and indexes. Use the meta-data provided by "@ViewIndexed", "@N1qlPrimaryIndexed" and "@N1qlSecondaryIndexed". |
|
|
Name of the bucket to connect to. |
||
Fully qualified name of the FieldNamingStrategy to use. |
||
Type of Couchbase repositories to enable. |
|
|
Name of the scope used for all collection access. |
||
Name of the field that stores the type information for complex types when using "MappingCouchbaseConverter". |
|
|
Whether to enable Elasticsearch repositories. |
|
|
Dialect to use. By default, the dialect is determined by inspecting the database connection. |
||
Whether to enable JDBC repositories. |
|
|
Bootstrap mode for JPA repositories. |
|
|
Whether to enable JPA repositories. |
|
|
Whether to enable LDAP repositories. |
|
|
Additional server hosts. Cannot be set with URI or if 'host' is not specified. Additional hosts will use the default mongo port of 27017. If you want to use a different port you can use the "host:port" syntax. |
||
Authentication database name. |
||
Whether to enable auto-index creation. |
||
Database name. Overrides database in URI. |
||
Fully qualified name of the FieldNamingStrategy to use. |
||
GridFS bucket name. |
||
GridFS database name. |
||
Mongo server host. Cannot be set with URI. |
||
Login password of the mongo server. Cannot be set with URI. |
||
Mongo server port. Cannot be set with URI. |
||
Required replica set name for the cluster. Cannot be set with URI. |
||
Type of Mongo repositories to enable. |
|
|
SSL bundle name. |
||
Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |
||
Mongo database URI. Overrides host, port, username, and password. |
|
|
Login user of the mongo server. Cannot be set with URI. |
||
Representation to use when converting a UUID to a BSON binary value. |
|
|
Database name to use. By default, the server decides the default database to use. |
||
Type of Neo4j repositories to enable. |
|
|
Whether to enable R2DBC repositories. |
|
|
Client name to be set on connections with CLIENT SETNAME. |
||
Type of client to use. By default, auto-detected according to the classpath. |
||
Maximum number of redirects to follow when executing commands across the cluster. |
||
List of "host:port" pairs to bootstrap from. This represents an "initial" list of cluster nodes and is required to have at least one entry. |
||
Connection timeout. |
||
Database index used by the connection factory. |
|
|
Redis server host. |
|
|
Whether to enable the pool. Enabled automatically if "commons-pool2" is available. With Jedis, pooling is implicitly enabled in sentinel mode and this setting only applies to single node setup. |
||
Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
|
|
Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
|
|
Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely. |
|
|
Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive. |
|
|
Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed. |
||
Whether adaptive topology refreshing using all available refresh triggers should be used. |
|
|
|
Whether to discover and query all cluster nodes for obtaining the cluster topology. When set to false, only the initial seed nodes are used as sources for topology discovery. |
|
Cluster topology refresh period. |
||
Whether to enable the pool. Enabled automatically if "commons-pool2" is available. With Jedis, pooling is implicitly enabled in sentinel mode and this setting only applies to single node setup. |
||
Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
|
|
Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
|
|
Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely. |
|
|
Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive. |
|
|
Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed. |
||
Shutdown timeout. |
|
|
Login password of the redis server. |
||
Redis server port. |
|
|
Whether to enable Redis repositories. |
|
|
Name of the Redis server. |
||
List of "host:port" pairs. |
||
Password for authenticating with sentinel(s). |
||
Login username for authenticating with sentinel(s). |
||
SSL bundle name. |
||
Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |
||
Read timeout. |
||
Connection URL. Overrides host, port, username, and password. Example: redis://user:[email protected]:6379 |
||
Login username of the redis server. |
||
Base path to be used by Spring Data REST to expose repository resources. |
||
Content type to use as a default when none is specified. |
||
Default size of pages. |
||
Strategy to use to determine which repositories get exposed. |
|
|
Whether to enable enum value translation through the Spring Data REST default resource bundle. |
||
Name of the URL query string parameter that indicates how many results to return at once. |
||
Maximum size of pages. |
||
Name of the URL query string parameter that indicates what page to return. |
||
Whether to return a response body after creating an entity. |
||
Whether to return a response body after updating an entity. |
||
Name of the URL query string parameter that indicates what direction to sort results. |
||
Default page size. |
|
|
Maximum page size to be accepted. |
|
|
Whether to expose and assume 1-based page number indexes. Defaults to "false", meaning a page number of 0 in the request equals the first page. |
|
|
Page index parameter name. |
|
|
General prefix to be prepended to the page number and page size parameters. |
||
Delimiter to be used between the qualifier and the actual page number and size properties. |
|
|
Configures how to render Spring Data Pageable instances. |
|
|
Page size parameter name. |
|
|
Sort parameter name. |
|
|
|
Commons DBCP2 specific settings bound to an instance of DBCP2's BasicDataSource |
|
Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. |
||
Connection details for an embedded database. Defaults to the most suitable embedded database that is available on the classpath. |
||
Whether to generate a random datasource name. |
|
|
|
Hikari specific settings bound to an instance of Hikari's HikariDataSource |
|
JNDI location of the datasource. Class, url, username and password are ignored when set. |
||
Datasource name to use if "generate-unique-name" is false. Defaults to "testdb" when using an embedded database, otherwise null. |
||
|
Oracle UCP specific settings bound to an instance of Oracle UCP's PoolDataSource |
|
Login password of the database. |
||
|
Tomcat datasource specific settings bound to an instance of Tomcat JDBC's DataSource |
|
Fully qualified name of the connection pool implementation to use. By default, it is auto-detected from the classpath. |
||
JDBC URL of the database. |
||
Login username of the database. |
||
XA datasource fully qualified name. |
||
Properties to pass to the XA data source. |
||
Connection timeout used when communicating with Elasticsearch. |
|
|
Password for authentication with Elasticsearch. |
||
Prefix added to the path of every request sent to Elasticsearch. |
||
Delay of a sniff execution scheduled after a failure. |
|
|
Interval between consecutive ordinary sniff executions. |
|
|
SSL bundle name. |
||
Whether to enable socket keep alive between client and Elasticsearch. |
|
|
Socket timeout used when communicating with Elasticsearch. |
|
|
List of the Elasticsearch instances to use. |
|
|
Username for authentication with Elasticsearch. |
||
Whether to enable the console. |
|
|
Path at which the console is available. |
|
|
Whether to enable trace output. |
|
|
Password to access preferences and tools of H2 Console. |
||
Whether to enable remote access. |
|
|
Number of rows that should be fetched from the database when more rows are needed. Use -1 to use the JDBC driver's default configuration. |
|
|
Maximum number of rows. Use -1 to use the JDBC driver's default configuration. |
|
|
Query timeout. Default is to use the JDBC driver's default configuration. If a duration suffix is not specified, seconds will be used. |
||
SQL dialect to use. Auto-detected by default. |
||
Target database to operate on, auto-detected by default. Can be alternatively set using the "databasePlatform" property. |
||
Name of the target database to operate on, auto-detected by default. Can be alternatively set using the "Database" enum. |
||
Whether to defer DataSource initialization until after any EntityManagerFactory beans have been created and initialized. |
|
|
Whether to initialize the schema on startup. |
|
|
DDL mode. This is actually a shortcut for the "hibernate.hbm2ddl.auto" property. Defaults to "create-drop" when using an embedded database and no schema manager was detected. Otherwise, defaults to "none". |
||
Fully qualified name of the implicit naming strategy. |
||
Fully qualified name of the physical naming strategy. |
||
Mapping resources (equivalent to "mapping-file" entries in persistence.xml). |
||
Register OpenEntityManagerInViewInterceptor. Binds a JPA EntityManager to the thread for the entire processing of the request. |
|
|
Additional native properties to set on the JPA provider. |
||
Whether to enable logging of SQL statements. |
|
|
Whether read-only operations should use an anonymous environment. Disabled by default unless a username is set. |
||
Base suffix from which all operations should originate. |
||
LDAP specification settings. |
||
List of base DNs. |
||
Embedded LDAP password. |
||
Embedded LDAP username. |
||
Schema (LDIF) script resource reference. |
|
|
Embedded LDAP port. |
|
|
Whether to enable LDAP schema validation. |
|
|
Path to the custom schema. |
||
Login password of the server. |
||
Whether NameNotFoundException should be ignored in searches through the LdapTemplate. |
|
|
Whether PartialResultException should be ignored in searches through the LdapTemplate. |
|
|
Whether SizeLimitExceededException should be ignored in searches through the LdapTemplate. |
|
|
LDAP URLs of the server. |
||
Login username of the server. |
||
Kerberos ticket for connecting to the database. Mutual exclusive with a given username. |
||
Login password of the server. |
||
Realm to connect to. |
||
Login user of the server. |
||
Timeout for borrowing connections from the pool. |
|
|
Maximum time transactions are allowed to retry. |
|
|
Acquisition of new connections will be attempted for at most configured timeout. |
|
|
Pooled connections that have been idle in the pool for longer than this threshold will be tested before they are used again. |
||
Whether to log leaked sessions. |
|
|
Pooled connections older than this threshold will be closed and removed from the pool. |
|
|
Maximum amount of connections in the connection pool towards a single database. |
|
|
Whether to enable metrics. |
|
|
Path to the file that holds the trusted certificates. |
||
Whether the driver should use encrypted traffic. |
|
|
Whether hostname verification is required. |
|
|
Trust strategy to use. |
|
|
URI used by the driver. |
|
|
Whether to generate a random database name. Ignore any configured name when enabled. |
|
|
Database name. Set if no name is specified in the url. Default to "testdb" when using an embedded database. |
||
Login password of the database. Set if no password is specified in the url. |
||
Whether pooling is enabled. Requires r2dbc-pool. |
|
|
Initial connection pool size. |
|
|
Maximum time to acquire a connection from the pool. By default, wait indefinitely. |
||
Maximum time to wait to create a new connection. By default, wait indefinitely. |
||
Maximum amount of time that a connection is allowed to sit idle in the pool. |
|
|
Maximum lifetime of a connection in the pool. By default, connections have an infinite lifetime. |
||
Maximal connection pool size. |
|
|
Maximum time to validate a connection from the pool. By default, wait indefinitely. |
||
Minimal number of idle connections. |
|
|
Validation depth. |
|
|
Validation query. |
||
Additional R2DBC options. |
||
R2DBC URL of the database. database name, username, password and pooling options specified in the url take precedence over individual options. |
||
Login username of the database. Set if no username is specified in the url. |
Devtools Properties
| Name | Description | Default Value |
|---|---|---|
Whether to enable development property defaults. |
|
|
Whether to enable a livereload.com-compatible server. |
|
|
Server port. |
|
|
Context path used to handle the remote connection. |
|
|
The host of the proxy to use to connect to the remote application. |
||
The port of the proxy to use to connect to the remote application. |
||
Whether to enable remote restart. |
|
|
A shared secret required to establish a connection (required to enable remote support). |
||
HTTP header used to transfer the shared secret. |
|
|
Additional patterns that should be excluded from triggering a full restart. |
||
Additional paths to watch for changes. |
||
Whether to enable automatic restart. |
|
|
Patterns that should be excluded from triggering a full restart. |
|
|
Whether to log the condition evaluation delta upon restart. |
|
|
Amount of time to wait between polling for classpath changes. |
|
|
Amount of quiet time required without any classpath changes before a restart is triggered. |
|
|
Name of a specific file that, when changed, triggers the restart check. Must be a simple name (without any path) of a file that appears on your classpath. If not specified, any classpath file change triggers the restart. |
Docker Compose Properties
| Name | Description | Default Value |
|---|---|---|
Arguments to pass to the Docker Compose command. |
||
Whether Docker Compose support is enabled. |
|
|
Paths to the Docker Compose configuration files. |
||
Hostname or IP of the machine where the docker containers are started. |
||
Docker compose lifecycle management. |
|
|
Docker compose profiles that should be active. |
||
Timeout for connections. |
|
|
Timeout for reads. |
|
|
Timeout of the readiness checks. |
|
|
Wait strategy to use. |
|
|
Whether to skip in tests. |
|
|
Arguments to pass to the start command. |
||
Command used to start Docker Compose. |
|
|
Log level for output. |
|
|
Whether to skip executing the start command. |
|
|
Arguments to pass to the stop command. |
||
Command used to stop Docker Compose. |
|
|
Timeout for stopping Docker Compose. Use '0' for forced stop. |
|
Integration Properties
| Name | Description | Default Value |
|---|---|---|
URL of the ActiveMQ broker. Auto-generated by default. |
||
Time to wait before considering a close complete. |
|
|
Whether to enable embedded mode if the ActiveMQ Broker is available. |
|
|
Whether to stop message delivery before re-delivering messages from a rolled back transaction. This implies that message order is not preserved when this is enabled. |
|
|
Whether to trust all packages. |
||
List of specific packages to trust (when not trusting all packages). |
||
Login password of the broker. |
||
Whether to block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead. |
|
|
Blocking period before throwing an exception if the pool is still full. |
|
|
Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. |
|
|
Connection idle timeout. |
|
|
Maximum number of pooled connections. |
|
|
Maximum number of pooled sessions per connection in the pool. |
|
|
Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs. |
|
|
Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required. |
|
|
Time to wait on message sends for a response. Set it to 0 to wait forever. |
|
|
Login user of the broker. |
||
Artemis broker url. |
|
|
Cluster password. Randomly generated on startup by default. |
||
Journal file directory. Not necessary if persistence is turned off. |
||
Whether to enable embedded mode if the Artemis server APIs are available. |
|
|
Whether to enable persistent store. |
|
|
List of queues to create on startup. |
|
|
Server ID. By default, an auto-incremented counter is used. |
|
|
List of topics to create on startup. |
|
|
Artemis deployment mode, auto-detected by default. |
||
Login password of the broker. |
||
Whether to block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead. |
|
|
Blocking period before throwing an exception if the pool is still full. |
|
|
Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory. |
|
|
Connection idle timeout. |
|
|
Maximum number of pooled connections. |
|
|
Maximum number of pooled sessions per connection in the pool. |
|
|
Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs. |
|
|
Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required. |
|
|
Login user of the broker. |
||
Database schema initialization mode. |
|
|
Transaction isolation level to use when creating job meta-data for new jobs. |
||
Platform to use in initialization scripts if the @@platform@@ placeholder is used. Auto-detected by default. |
||
Path to the SQL file to use to initialize the database schema. |
|
|
Table prefix for all the batch meta-data tables. |
||
Execute all Spring Batch jobs in the context on startup. |
|
|
Job name to execute on startup. Must be specified if multiple Jobs are found in the context. |
||
The location of the configuration file to use to initialize Hazelcast. |
||
Whether to create input channels if necessary. |
|
|
Default number of subscribers allowed on, for example, a 'PublishSubscribeChannel'. |
||
Default number of subscribers allowed on, for example, a 'DirectChannel'. |
||
Default timeout for blocking operations such as sending or receiving messages. |
|
|
List of endpoint bean names patterns that should not be started automatically during application startup. |
||
List of message header names that should not be populated into Message instances during a header copying operation. |
||
Whether to throw an exception when a reply is not expected anymore by a gateway. |
|
|
Whether to ignore failures for one or more of the handlers of the global 'errorChannel'. |
|
|
Whether to not silently ignore messages on the global 'errorChannel' when there are no subscribers. |
|
|
Database schema initialization mode. |
|
|
Platform to use in initialization scripts if the @@platform@@ placeholder is used. Auto-detected by default. |
||
Path to the SQL file to use to initialize the database schema. |
|
|
Whether Spring Integration components should perform logging in the main message flow. When disabled, such logging will be skipped without checking the logging level. When enabled, such logging is controlled as normal by the logging system's log level configuration. |
|
|
List of simple patterns to match against the names of Spring Integration components. When matched, observation instrumentation will be performed for the component. Please refer to the javadoc of the smartMatch method of Spring Integration's PatternMatchUtils for details of the pattern syntax. |
||
Cron expression for polling. Mutually exclusive with 'fixedDelay' and 'fixedRate'. |
||
Polling delay period. Mutually exclusive with 'cron' and 'fixedRate'. |
||
Polling rate period. Mutually exclusive with 'fixedDelay' and 'cron'. |
||
Polling initial delay. Applied for 'fixedDelay' and 'fixedRate'; ignored for 'cron'. |
||
Maximum number of messages to poll per polling cycle. |
||
How long to wait for messages on poll. |
|
|
TCP RSocket server host to connect to. |
||
TCP RSocket server port to connect to. |
||
WebSocket RSocket server uri to connect to. |
||
Whether to handle message mapping for RSocket through Spring Integration. |
|
|
Whether to cache message consumers. |
|
|
Whether to cache sessions. |
|
|
Whether to cache message producers. |
|
|
Size of the session cache (per JMS Session type). |
|
|
Client id of the connection. |
||
Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations. |
||
Start the container automatically on startup. |
|
|
Maximum number of concurrent consumers. |
||
Specify the maximum number of messages to process in one task. By default, unlimited unless a SchedulingTaskExecutor is configured on the listener (10 messages), as it indicates a preference for short-lived tasks. |
||
Minimum number of concurrent consumers. When max-concurrency is not specified the minimum will also be used as the maximum. |
||
Timeout to use for receive calls. Use -1 for a no-wait receive or 0 for no timeout at all. The latter is only feasible if not running within a transaction manager and is generally discouraged since it prevents clean shutdown. |
|
|
Acknowledge mode of the listener container. |
|
|
Whether the listener container should use transacted JMS sessions. Defaults to false in the presence of a JtaTransactionManager and true otherwise. |
||
Whether the default destination type is topic. |
|
|
Whether the subscription is durable. |
|
|
Default destination to use on send and receive operations that do not have a destination parameter. |
||
Delivery delay to use for send calls. |
||
Delivery mode. Enables QoS (Quality of Service) when set. |
||
Priority of a message when sending. Enables QoS (Quality of Service) when set. |
||
Whether to enable explicit QoS (Quality of Service) when sending a message. When enabled, the delivery mode, priority and time-to-live properties will be used when sending a message. QoS is automatically enabled when at least one of those settings is customized. |
||
Timeout to use for receive calls. |
||
Acknowledge mode used when creating sessions. |
|
|
Whether to use transacted sessions. |
|
|
Time-to-live of a message when sending. Enables QoS (Quality of Service) when set. |
||
Whether to automatically create topics during context initialization. When set to false, disables automatic topic creation during context initialization. |
|
|
ID to pass to the server when making requests. Used for server-side logging. |
||
Close timeout. |
||
Whether to fail fast if the broker is not available on startup. |
|
|
Whether to enable modification of existing topic configuration. |
|
|
Operation timeout. |
||
Additional admin-specific properties used to configure the client. |
||
Security protocol used to communicate with brokers. |
||
Name of the SSL bundle to use. |
||
Password of the private key in either key store key or key store file. |
||
Certificate chain in PEM format with a list of X.509 certificates. |
||
Private key in PEM format with PKCS#8 keys. |
||
Location of the key store file. |
||
Store password for the key store file. |
||
Type of the key store. |
||
SSL protocol to use. |
||
Trusted certificates in PEM format with X.509 certificates. |
||
Location of the trust store file. |
||
Store password for the trust store file. |
||
Type of the trust store. |
||
List of host:port pairs to use for establishing the initial connections to the Kafka cluster. Applies to all components unless overridden. |
||
ID to pass to the server when making requests. Used for server-side logging. |
||
Frequency with which the consumer offsets are auto-committed to Kafka if 'enable.auto.commit' is set to true. |
||
What to do when there is no initial offset in Kafka or if the current offset no longer exists on the server. |
||
List of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for consumers. |
||
ID to pass to the server when making requests. Used for server-side logging. |
||
Whether the consumer's offset is periodically committed in the background. |
||
Maximum amount of time the server blocks before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by "fetch-min-size". |
||
Minimum amount of data the server should return for a fetch request. |
||
Unique string that identifies the consumer group to which this consumer belongs. |
||
Expected time between heartbeats to the consumer coordinator. |
||
Isolation level for reading messages that have been written transactionally. |
|
|
Deserializer class for keys. |
||
Maximum number of records returned in a single call to poll(). |
||
Additional consumer-specific properties used to configure the client. |
||
Security protocol used to communicate with brokers. |
||
Name of the SSL bundle to use. |
||
Password of the private key in either key store key or key store file. |
||
Certificate chain in PEM format with a list of X.509 certificates. |
||
Private key in PEM format with PKCS#8 keys. |
||
Location of the key store file. |
||
Store password for the key store file. |
||
Type of the key store. |
||
SSL protocol to use. |
||
Trusted certificates in PEM format with X.509 certificates. |
||
Location of the trust store file. |
||
Store password for the trust store file. |
||
Type of the trust store. |
||
Deserializer class for values. |
||
Control flag for login configuration. |
|
|
Whether to enable JAAS configuration. |
|
|
Login module. |
|
|
Additional JAAS options. |
||
Number of records between offset commits when ackMode is "COUNT" or "COUNT_TIME". |
||
Listener AckMode. See the spring-kafka documentation. |
||
Time between offset commits when ackMode is "TIME" or "COUNT_TIME". |
||
Support for asynchronous record acknowledgements. Only applies when spring.kafka.listener.ack-mode is manual or manual-immediate. |
||
Whether to auto start the container. |
|
|
Whether to instruct the container to change the consumer thread name during initialization. |
||
Prefix for the listener's consumer client.id property. |
||
Number of threads to run in the listener containers. |
||
Sleep interval between Consumer.poll(Duration) calls. |
|
|
Time between publishing idle consumer events (no data received). |
||
Time between publishing idle partition consumer events (no data received for partition). |
||
Whether the container stops after the current record is processed or after all the records from the previous poll are processed. |
|
|
Whether to log the container configuration during initialization (INFO level). |
||
Whether the container should fail to start if at least one of the configured topics are not present on the broker. |
|
|
Time between checks for non-responsive consumers. If a duration suffix is not specified, seconds will be used. |
||
Multiplier applied to "pollTimeout" to determine if a consumer is non-responsive. |
||
Whether to enable observation. |
|
|
Timeout to use when polling the consumer. |
||
Listener type. |
|
|
Number of acknowledgments the producer requires the leader to have received before considering a request complete. |
||
Default batch size. A small batch size will make batching less common and may reduce throughput (a batch size of zero disables batching entirely). |
||
List of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for producers. |
||
Total memory size the producer can use to buffer records waiting to be sent to the server. |
||
ID to pass to the server when making requests. Used for server-side logging. |
||
Compression type for all data generated by the producer. |
||
Serializer class for keys. |
||
Additional producer-specific properties used to configure the client. |
||
When greater than zero, enables retrying of failed sends. |
||
Security protocol used to communicate with brokers. |
||
Name of the SSL bundle to use. |
||
Password of the private key in either key store key or key store file. |
||
Certificate chain in PEM format with a list of X.509 certificates. |
||
Private key in PEM format with PKCS#8 keys. |
||
Location of the key store file. |
||
Store password for the key store file. |
||
Type of the key store. |
||
SSL protocol to use. |
||
Trusted certificates in PEM format with X.509 certificates. |
||
Location of the trust store file. |
||
Store password for the trust store file. |
||
Type of the trust store. |
||
When non empty, enables transaction support for producer. |
||
Serializer class for values. |
||
Additional properties, common to producers and consumers, used to configure the client. |
||
Total number of processing attempts made before sending the message to the DLT. |
|
|
Canonical backoff period. Used as an initial value in the exponential case, and as a minimum value in the uniform case. |
|
|
Maximum wait between retries. If less than the delay then the default of 30 seconds is applied. |
|
|
Multiplier to use for generating the next backoff delay. |
|
|
Whether to have the backoff delays. |
|
|
Whether to enable topic-based non-blocking retries. |
|
|
Security protocol used to communicate with brokers. |
||
Name of the SSL bundle to use. |
||
Password of the private key in either key store key or key store file. |
||
Certificate chain in PEM format with a list of X.509 certificates. |
||
Private key in PEM format with PKCS#8 keys. |
||
Location of the key store file. |
||
Store password for the key store file. |
||
Type of the key store. |
||
SSL protocol to use. |
||
Trusted certificates in PEM format with X.509 certificates. |
||
Location of the trust store file. |
||
Store password for the trust store file. |
||
Type of the trust store. |
||
Kafka streams application.id property; default spring.application.name. |
||
Whether to auto-start the streams factory bean. |
|
|
List of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for streams. |
||
Cleanup the application’s local state directory on shutdown. |
|
|
Cleanup the application’s local state directory on startup. |
|
|
ID to pass to the server when making requests. Used for server-side logging. |
||
Additional Kafka properties used to configure the streams. |
||
The replication factor for change log topics and repartition topics created by the stream processing application. |
||
Security protocol used to communicate with brokers. |
||
Name of the SSL bundle to use. |
||
Password of the private key in either key store key or key store file. |
||
Certificate chain in PEM format with a list of X.509 certificates. |
||
Private key in PEM format with PKCS#8 keys. |
||
Location of the key store file. |
||
Store password for the key store file. |
||
Type of the key store. |
||
SSL protocol to use. |
||
Trusted certificates in PEM format with X.509 certificates. |
||
Location of the trust store file. |
||
Store password for the trust store file. |
||
Type of the trust store. |
||
Directory location for the state store. |
||
Maximum size of the in-memory state store cache across all threads. |
||
Default topic to which messages are sent. |
||
Whether to enable observation. |
|
|
Transaction id prefix, override the transaction id prefix in the producer factory. |
||
Authentication parameter(s) as a map of parameter names to parameter values. |
||
Fully qualified class name of the authentication plugin. |
||
Duration to wait for a connection to server to be established. |
|
|
Server response read time out for any request. |
|
|
Server request time out for any request. |
|
|
Pulsar web URL for the admin endpoint in the format '(http|https)://host:port'. |
|
|
Authentication parameter(s) as a map of parameter names to parameter values. |
||
Fully qualified class name of the authentication plugin. |
||
Duration to wait for a connection to a broker to be established. |
|
|
List of backup clusters. The backup cluster is chosen in the sequence of the given list. If all backup clusters are available, the Pulsar client chooses the first backup cluster. |
||
Frequency of performing a probe task. |
||
Delay before the Pulsar client switches from the primary cluster to the backup cluster. |
||
Cluster failover policy. |
|
|
Delay before the Pulsar client switches from the backup cluster to the primary cluster. |
||
Client lookup timeout. |
||
Client operation timeout. |
|
|
Pulsar service URL in the format '(pulsar|pulsar+ssl)://host:port'. |
|
|
Number of threads to be used for handling connections to brokers. |
||
Number of threads to be used for message listeners. |
||
Name of the dead topic where the failing messages will be sent. |
||
|
Name of the initial subscription of the dead letter topic. When not set, the initial subscription will not be created. However, when the property is set then the broker's 'allowAutoSubscriptionCreation' must be enabled or the DLQ producer will fail. |
|
|
Maximum number of times that a message will be redelivered before being sent to the dead letter queue. |
|
|
Name of the retry topic where the failing messages will be sent. |
|
Consumer name to identify a particular consumer from the topic stats. |
||
Priority level for shared subscription consumers. |
|
|
Whether to read messages from the compacted topic rather than the full message backlog. |
|
|
Whether to auto retry messages. |
|
|
Position where to initialize a newly created subscription. |
|
|
Subscription mode to be used when subscribing to the topic. |
|
|
Subscription name for the consumer. |
||
Determines which type of topics (persistent, non-persistent, or all) the consumer should be subscribed to when using pattern subscriptions. |
|
|
Subscription type to be used when subscribing to a topic. |
|
|
Topics the consumer subscribes to. |
||
Pattern for topics the consumer subscribes to. |
||
Whether to enable default tenant and namespace support for topics. |
|
|
Default namespace to use when producing or consuming messages against a non-fully-qualified topic URL. |
|
|
Default tenant to use when producing or consuming messages against a non-fully-qualified topic URL. |
|
|
List of mappings from message type to topic name and schema info to use as a defaults when a topic name and/or schema is not explicitly specified when producing or consuming messages of the mapped type. |
||
Whether to enable function support. |
|
|
Whether to stop processing further function creates/updates when a failure occurs. |
|
|
Whether to throw an exception if any failure is encountered during server startup while creating/updating functions. |
|
|
Whether to throw an exception if any failure is encountered during server shutdown while enforcing stop policy on functions. |
|
|
Number of threads used by listener container. |
||
Whether to record observations for when the Observations API is available and the client supports it. |
|
|
SchemaType of the consumed messages. |
||
Type of access to the topic the producer requires. |
|
|
Whether to automatically batch messages. |
|
|
Whether to enable caching in the PulsarProducerFactory. |
|
|
Time period to expire unused entries in the cache. |
|
|
Initial size of cache. |
|
|
Maximum size of cache (entries). |
|
|
Whether to split large-size messages into multiple chunks. |
|
|
Message compression type. |
||
Message hashing scheme to choose the partition to which the message is published. |
|
|
Message routing mode for a partitioned producer. |
|
|
Name for the producer. If not assigned, a unique name is generated. |
||
Time before a message has to be acknowledged by the broker. |
|
|
Topic the producer will publish to. |
||
Reader name. |
||
Whether to read messages from a compacted topic rather than a full message backlog of a topic. |
|
|
Subscription name. |
||
Prefix of subscription role. |
||
Topics the reader subscribes to. |
||
Whether to record observations for when the Observations API is available. |
|
|
Whether transaction support is enabled. |
|
|
Mode used to shuffle configured addresses. |
|
|
List of addresses to which the client should connect. When set, the host and port are ignored. |
||
Duration to wait to obtain a channel if the cache size has been reached. If 0, always create a new channel. |
||
Number of channels to retain in the cache. When "check-timeout" > 0, max channels per connection. |
||
Connection factory cache mode. |
|
|
Number of connections to cache. Only applies when mode is CONNECTION. |
||
Continuation timeout for RPC calls in channels. Set it to zero to wait forever. |
|
|
Connection timeout. Set it to zero to wait forever. |
||
Whether to create an AmqpAdmin bean. |
|
|
RabbitMQ host. Ignored if an address is set. |
|
|
Acknowledge mode of container. |
||
Whether to start the container automatically on startup. |
|
|
Number of consumers per queue. |
||
Whether the container should present batched messages as discrete messages or call the listener with the batch. |
|
|
Whether rejected deliveries are re-queued by default. |
||
Whether the container (when stopped) should stop immediately after processing the current message or stop after processing all pre-fetched messages. |
|
|
How often idle container events should be published. |
||
Whether to fail if the queues declared by the container are not available on the broker. |
|
|
Whether to enable observation. |
|
|
Maximum number of unacknowledged messages that can be outstanding at each consumer. |
||
Whether publishing retries are enabled. |
|
|
Duration between the first and second attempt to deliver a message. |
|
|
Maximum number of attempts to deliver a message. |
|
|
Maximum duration between attempts. |
|
|
Multiplier to apply to the previous retry interval. |
|
|
Whether retries are stateless or stateful. |
|
|
Acknowledge mode of container. |
||
Whether to start the container automatically on startup. |
|
|
Batch size, expressed as the number of physical messages, to be used by the container. |
||
Minimum number of listener invoker threads. |
||
Whether the container creates a batch of messages based on the 'receive-timeout' and 'batch-size'. Coerces 'de-batching-enabled' to true to include the contents of a producer created batch in the batch as discrete records. |
|
|
Whether the container should present batched messages as discrete messages or call the listener with the batch. |
|
|
Whether rejected deliveries are re-queued by default. |
||
Whether the container (when stopped) should stop immediately after processing the current message or stop after processing all pre-fetched messages. |
|
|
How often idle container events should be published. |
||
Maximum number of listener invoker threads. |
||
Whether to fail if the queues declared by the container are not available on the broker and/or whether to stop the container if one or more queues are deleted at runtime. |
|
|
Whether to enable observation. |
|
|
Maximum number of unacknowledged messages that can be outstanding at each consumer. |
||
Whether publishing retries are enabled. |
|
|
Duration between the first and second attempt to deliver a message. |
|
|
Maximum number of attempts to deliver a message. |
|
|
Maximum duration between attempts. |
|
|
Multiplier to apply to the previous retry interval. |
|
|
Whether retries are stateless or stateful. |
|
|
Whether the container will support listeners that consume native stream messages instead of Spring AMQP messages. |
|
|
Whether to enable observation. |
|
|
Listener container type. |
|
|
Maximum size of the body of inbound (received) messages. |
|
|
Login to authenticate against the broker. |
|
|
RabbitMQ port. Ignored if an address is set. Default to 5672, or 5671 if SSL is enabled. |
||
Type of publisher confirms to use. |
||
Whether to enable publisher returns. |
|
|
Number of channels per connection requested by the client. Use 0 for unlimited. |
|
|
Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used. |
||
SSL algorithm to use. By default, configured by the Rabbit client library. |
||
SSL bundle name. |
||
Whether to enable SSL support. Determined automatically if an address is provided with the protocol (amqp:// vs. amqps://). |
||
Path to the key store that holds the SSL certificate. |
||
Key store algorithm. |
|
|
Password used to access the key store. |
||
Key store type. |
|
|
Trust store that holds SSL certificates. |
||
Trust store algorithm. |
|
|
Password used to access the trust store. |
||
Trust store type. |
|
|
Whether to enable server side certificate validation. |
|
|
Whether to enable hostname verification. |
|
|
Host of a RabbitMQ instance with the Stream plugin enabled. |
|
|
Name of the stream. |
||
Login password to authenticate to the broker. When not set spring.rabbitmq.password is used. |
||
Stream port of a RabbitMQ instance with the Stream plugin enabled. |
||
Login user to authenticate to the broker. When not set, spring.rabbitmq.username is used. |
||
Virtual host of a RabbitMQ instance with the Stream plugin enabled. When not set, spring.rabbitmq.virtual-host is used. |
||
Simple patterns for allowable packages/classes for deserialization. |
||
Name of the default queue to receive messages from when none is specified explicitly. |
||
Name of the default exchange to use for send operations. |
||
Whether to enable mandatory messages. |
||
Whether to enable observation. |
|
|
Timeout for receive() operations. |
||
Timeout for sendAndReceive() operations. |
||
Whether publishing retries are enabled. |
|
|
Duration between the first and second attempt to deliver a message. |
|
|
Maximum number of attempts to deliver a message. |
|
|
Maximum duration between attempts. |
|
|
Multiplier to apply to the previous retry interval. |
|
|
Value of a default routing key to use for send operations. |
||
Login user to authenticate to the broker. |
|
|
Virtual host to use when connecting to the broker. |
||
Path that serves as the base URI for the services. |
|
|
Servlet init parameters to pass to Spring Web Services. |
||
Load on startup priority of the Spring Web Services servlet. |
|
|
Comma-separated list of locations of WSDLs and accompanying XSDs to be exposed as beans. |
JSON Properties
| Name | Description | Default Value |
|---|---|---|
Format to use when serializing Date objects. |
||
Whether to disable the escaping of HTML characters such as '<', '>', etc. |
||
Whether to exclude inner classes during serialization. |
||
Whether to enable serialization of complex map keys (i.e. non-primitives). |
||
Whether to exclude all fields from consideration for serialization or deserialization that do not have the "Expose" annotation. |
||
Naming policy that should be applied to an object's field during serialization and deserialization. |
||
Whether to generate non-executable JSON by prefixing the output with some special text. |
||
Serialization policy for Long and long types. |
||
Whether to output serialized JSON that fits in a page for pretty printing. |
||
Whether to serialize null fields. |
||
Sets how strictly the RFC 8259 specification will be enforced when reading and writing JSON. |
||
Strategy to use to auto-detect constructor, and in particular behavior with single-argument constructors. |
|
|
Jackson on/off features for enums. |
||
Jackson on/off features for JsonNodes. |
||
Date format string or a fully-qualified date format class name. For instance, 'yyyy-MM-dd HH:mm:ss'. |
||
Global default setting (if any) for leniency. |
||
Controls the inclusion of properties during serialization. Configured with one of the values in Jackson's JsonInclude.Include enumeration. |
||
Jackson on/off features that affect the way Java objects are deserialized. |
||
Jackson on/off features for generators. |
||
Locale used for formatting. |
||
Jackson general purpose on/off features. |
||
Jackson on/off features for parsers. |
||
One of the constants on Jackson's PropertyNamingStrategies. Can also be a fully-qualified class name of a PropertyNamingStrategy implementation. |
||
Jackson on/off features that affect the way Java objects are serialized. |
||
Time zone used when formatting dates. For instance, "America/Los_Angeles" or "GMT+10". |
||
Jackson visibility thresholds that can be used to limit which methods (and fields) are auto-detected. |
Mail Properties
| Name | Description | Default Value |
|---|---|---|
Default MimeMessage encoding. |
|
|
SMTP server host. For instance, 'smtp.example.com'. |
||
Session JNDI name. When set, takes precedence over other Session settings. |
||
Login password of the SMTP server. |
||
SMTP server port. |
||
Additional JavaMail Session properties. |
||
Protocol used by the SMTP server. |
|
|
SSL bundle name. If set, 'mail.(protocol).ssl.socketFactory' property is set to an SSLSocketFactory obtained from the corresponding SSL bundle. <p> Note that the STARTTLS command can use the corresponding SSLSocketFactory, even if the 'mail.(protocol).ssl.enable' property is not set. |
||
Whether to enable SSL support. If enabled, 'mail.(protocol).ssl.enable' property is set to 'true'. |
|
|
Whether to test that the mail server is available on startup. |
|
|
Login user of the SMTP server. |
||
SendGrid API key. |
||
SendGrid proxy host. |
||
SendGrid proxy port. |
RSocket Properties
| Name | Description | Default Value |
|---|---|---|
Network address to which the server should bind. |
||
Maximum transmission unit. Frames larger than the specified value are fragmented. |
||
Path under which RSocket handles requests (only works with websocket transport). |
||
Server port. |
||
Whether the websocket compression extension is enabled. |
|
|
Whether to proxy websocket ping frames or respond to them. |
|
|
Maximum allowable frame payload length. |
|
|
Sub-protocols to use in websocket handshake signature. |
||
The name of a configured SSL bundle. |
||
Path to a PEM-encoded SSL certificate file. |
||
Path to a PEM-encoded private key file for the SSL certificate. |
||
Supported SSL ciphers. |
||
Client authentication mode. Requires a trust store. |
||
Whether to enable SSL support. |
|
|
Enabled SSL protocols. |
||
Alias that identifies the key in the key store. |
||
Password used to access the key in the key store. |
||
Path to the key store that holds the SSL certificate (typically a jks file). |
||
Password used to access the key store. |
||
Provider for the key store. |
||
Type of the key store. |
||
SSL protocol to use. |
|
|
Mapping of host names to SSL bundles for SNI configuration. |
||
Path to a PEM-encoded SSL certificate authority file. |
||
Path to a PEM-encoded private key file for the SSL certificate authority. |
||
Trust store that holds SSL certificates. |
||
Password used to access the trust store. |
||
Provider for the trust store. |
||
Type of the trust store. |
||
RSocket transport protocol. |
|
Security Properties
| Name | Description | Default Value |
|---|---|---|
Security filter chain dispatcher types for Servlet-based web applications. |
|
|
Security filter chain order for Servlet-based web applications. |
|
|
Registered clients of the Authorization Server. |
||
|
Authorization Server's OAuth 2.0 Authorization Endpoint. |
|
|
Authorization Server's OAuth 2.0 Device Authorization Endpoint. |
|
|
Authorization Server's OAuth 2.0 Device Verification Endpoint. |
|
|
Authorization Server's JWK Set Endpoint. |
|
|
Authorization Server's OpenID Connect 1.0 Client Registration Endpoint. |
|
|
Authorization Server's OpenID Connect 1.0 Logout Endpoint. |
|
|
Authorization Server's OpenID Connect 1.0 UserInfo Endpoint. |
|
|
Authorization Server's OAuth 2.0 Token Introspection Endpoint. |
|
|
Authorization Server's OAuth 2.0 Token Revocation Endpoint. |
|
|
Authorization Server's OAuth 2.0 Token Endpoint. |
|
URL of the Authorization Server's Issuer Identifier. |
||
|
Whether multiple issuers are allowed per host. Using path components in the URL of the issuer identifier enables supporting multiple issuers per host in a multi-tenant hosting configuration. |
|
OAuth provider details. |
||
OAuth client registrations. |
||
Identifies the recipients that the JWT is intended for. |
||
|
Regex to use for splitting the value of the authorities claim into authorities. |
|
|
Name of token claim to use for mapping authorities from JWT. |
|
Prefix to use for authorities mapped from JWT. |
||
URI that can either be an OpenID Connect discovery endpoint or an OAuth 2.0 Authorization Server Metadata endpoint defined by RFC 8414. |
||
JSON Web Key URI to use to verify the JWT token. |
||
JSON Web Algorithms used for verifying the digital signatures. |
|
|
|
JWT principal claim name. |
|
|
Location of the file containing the public key used to verify a JWT. |
|
Client id used to authenticate with the token introspection endpoint. |
||
|
Client secret used to authenticate with the token introspection endpoint. |
|
|
OAuth 2.0 endpoint through which token introspection is accomplished. |
|
SAML2 relying party registrations. |
||
Default user name. |
|
|
Password for the default user name. |
||
Granted roles for the default user name. |
Server Properties
| Name | Description | Default Value |
|---|---|---|
Network address to which the server should bind. |
||
Whether response compression is enabled. |
|
|
Comma-separated list of user agents for which responses should not be compressed. |
||
Comma-separated list of MIME types that should be compressed. |
|
|
Minimum "Content-Length" value that is required for compression to be performed. |
|
|
When to include "errors" attribute. |
|
|
Include the "exception" attribute. |
|
|
When to include "message" attribute. |
|
|
When to include "path" attribute. |
|
|
When to include the "trace" attribute. |
|
|
Path of the error controller. |
|
|
Whether to enable the default error page displayed in browsers in case of a server error. |
|
|
Strategy for handling X-Forwarded-* headers. |
||
Whether to enable HTTP/2 support, if the current environment supports it. |
|
|
Append to log. |
|
|
Custom log format, see org.eclipse.jetty.server.CustomRequestLog. If defined, overrides the "format" configuration key. |
||
Enable access log. |
|
|
Date format to place in log file name. |
||
Log filename. If not specified, logs redirect to "System.err". |
||
Log format. |
|
|
Request paths that should not be logged. |
||
Number of days before rotated log files are deleted. |
|
|
Time that the connection can be idle before it is closed. |
||
Maximum number of connections that the server accepts and processes at any given time. |
|
|
Maximum number of form keys. |
|
|
Maximum size of the form content in any HTTP post request. |
|
|
Maximum size of the HTTP response header. |
|
|
Number of acceptor threads to use. When the value is -1, the default, the number of acceptors is derived from the operating environment. |
|
|
Maximum thread idle time. |
|
|
Maximum number of threads. Doesn't have an effect if virtual threads are enabled. |
|
|
Maximum capacity of the thread pool's backing queue. A default is computed based on the threading configuration. |
||
Minimum number of threads. Doesn't have an effect if virtual threads are enabled. |
|
|
Number of selector threads to use. When the value is -1, the default, the number of selectors is derived from the operating environment. |
|
|
Maximum size of the HTTP request header. Refer to the documentation for your chosen embedded server for details of exactly how this limit is applied. For example, Netty applies the limit separately to each individual header in the request whereas Tomcat applies the limit to the combined size of the request line and all of the header names and values in the request. |
|
|
Connection timeout of the Netty channel. |
||
Maximum content length of an H2C upgrade request. |
|
|
Idle timeout of the Netty channel. When not specified, an infinite timeout is used. |
||
Initial buffer size for HTTP request decoding. |
|
|
Maximum length that can be decoded for an HTTP request's initial line. |
|
|
Maximum number of requests that can be made per connection. By default, a connection serves unlimited number of requests. |
||
Whether to validate headers when decoding requests. |
|
|
Server HTTP port. |
|
|
Domain for the cookie. |
||
Whether to use "HttpOnly" cookies for the cookie. |
||
Maximum age of the cookie. If a duration suffix is not specified, seconds will be used. A positive value indicates when the cookie expires relative to the current time. A value of 0 means the cookie should expire immediately. A negative value means no "Max-Age". |
||
Name for the cookie. |
||
Whether the generated cookie carries the Partitioned attribute. |
||
Path of the cookie. |
||
SameSite setting for the cookie. |
||
Whether to always mark the cookie as secure. |
||
Maximum number of sessions that can be stored. |
|
|
Session timeout. If a duration suffix is not specified, seconds will be used. |
|
|
Value to use for the Server response header (if empty, no header is sent). |
||
Display name of the application. |
|
|
Servlet context init parameters. |
||
Context path of the application. |
||
Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly. |
|
|
Whether to enable http encoding support. |
|
|
Whether to force the encoding to the configured charset on HTTP requests and responses. |
||
Whether to force the encoding to the configured charset on HTTP requests. Defaults to true when "force" has not been specified. |
||
Whether to force the encoding to the configured charset on HTTP responses. |
||
Mapping of locale to charset for response encoding. |
||
Class name of the servlet to use for JSPs. If registered is true and this class * is on the classpath then it will be registered. |
|
|
Init parameters used to configure the JSP servlet. |
||
Whether the JSP servlet is registered. |
|
|
Whether to register the default Servlet with the container. |
|
|
Domain for the cookie. |
||
Whether to use "HttpOnly" cookies for the cookie. |
||
Maximum age of the cookie. If a duration suffix is not specified, seconds will be used. A positive value indicates when the cookie expires relative to the current time. A value of 0 means the cookie should expire immediately. A negative value means no "Max-Age". |
||
Name of the cookie. |
||
Whether the generated cookie carries the Partitioned attribute. |
||
Path of the cookie. |
||
SameSite setting for the cookie. |
||
Whether to always mark the cookie as secure. |
||
Whether to persist session data between restarts. |
|
|
Directory used to store session data. |
||
Session timeout. If a duration suffix is not specified, seconds will be used. |
|
|
Session tracking modes. |
||
Type of shutdown that the server will support. |
|
|
The name of a configured SSL bundle. |
||
Path to a PEM-encoded SSL certificate file. |
||
Path to a PEM-encoded private key file for the SSL certificate. |
||
Supported SSL ciphers. |
||
Client authentication mode. Requires a trust store. |
||
Whether to enable SSL support. |
|
|
Enabled SSL protocols. |
||
Alias that identifies the key in the key store. |
||
Password used to access the key in the key store. |
||
Path to the key store that holds the SSL certificate (typically a jks file). |
||
Password used to access the key store. |
||
Provider for the key store. |
||
Type of the key store. |
||
SSL protocol to use. |
|
|
Mapping of host names to SSL bundles for SNI configuration. |
||
Path to a PEM-encoded SSL certificate authority file. |
||
Path to a PEM-encoded private key file for the SSL certificate authority. |
||
Trust store that holds SSL certificates. |
||
Password used to access the trust store. |
||
Provider for the trust store. |
||
Type of the trust store. |
||
Maximum queue length for incoming connection requests when all possible request processing threads are in use. |
|
|
Whether to buffer output such that it is flushed only periodically. |
|
|
Whether to check for log file existence so it can be recreated if an external process has renamed it. |
|
|
Whether logging of the request will only be enabled if "ServletRequest.getAttribute(conditionIf)" does not yield null. |
||
Whether logging of the request will only be enabled if "ServletRequest.getAttribute(conditionUnless)" yield null. |
||
Directory in which log files are created. Can be absolute or relative to the Tomcat base dir. |
|
|
Enable access log. |
|
|
Character set used by the log file. Default to the system default character set. |
||
Date format to place in the log file name. |
|
|
Whether to use IPv6 canonical representation format as defined by RFC 5952. |
|
|
Locale used to format timestamps in log entries and in log file name suffix. Default to the default locale of the Java process. |
||
Number of days to retain the access log files before they are removed. |
|
|
Format pattern for access logs. |
|
|
Log file name prefix. |
|
|
Whether to defer inclusion of the date stamp in the file name until rotate time. |
|
|
Set request attributes for the IP address, Hostname, protocol, and port used for the request. |
|
|
Whether to enable access log rotation. |
|
|
Log file name suffix. |
|
|
List of additional patterns that match jars to ignore for TLD scanning. The special '?' and '*' characters can be used in the pattern to match one and only one character and zero or more characters respectively. |
||
Delay between the invocation of backgroundProcess methods. If a duration suffix is not specified, seconds will be used. |
|
|
Tomcat base directory. If not specified, a temporary directory is used. |
||
Amount of time the connector will wait, after accepting a connection, for the request URI line to be presented. |
||
Time to wait for another HTTP request before the connection is closed. When not set the connectionTimeout is used. When set to -1 there will be no timeout. |
||
Maximum number of connections that the server accepts and processes at any given time. Once the limit has been reached, the operating system may still accept connections based on the "acceptCount" property. |
|
|
Maximum size of the form content in any HTTP post request. |
|
|
Maximum size of the HTTP response header. |
|
|
Maximum number of HTTP requests that can be pipelined before the connection is closed. When set to 0 or 1, keep-alive and pipelining are disabled. When set to -1, an unlimited number of pipelined or keep-alive requests are allowed. |
|
|
Maximum amount of request body to swallow. |
|
|
Whether Tomcat's MBean Registry should be enabled. |
|
|
Maximum number of idle processors that will be retained in the cache and reused with a subsequent request. When set to -1 the cache will be unlimited with a theoretical maximum size equal to the maximum number of connections. |
|
|
Whether requests to the context root should be redirected by appending a / to the path. When using SSL terminated at a proxy, this property should be set to false. |
|
|
List of additional unencoded characters that should be allowed in URI paths. Only "< > [ \ ] ^ ` { | }" are allowed. |
||
List of additional unencoded characters that should be allowed in URI query strings. Only "< > [ \ ] ^ ` { | }" are allowed. |
||
Name of the HTTP header from which the remote host is extracted. |
|
|
Regular expression that matches proxies that are to be trusted. |
|
|
Name of the HTTP header used to override the original port value. |
|
|
Header that holds the incoming protocol, usually named "X-Forwarded-Proto". |
||
Value of the protocol header indicating whether the incoming request uses SSL. |
|
|
Name of the HTTP header from which the remote IP is extracted. For instance, 'X-FORWARDED-FOR'. |
||
Regular expression defining proxies that are trusted when they appear in the "remote-ip-header" header. |
||
Whether static resource caching is permitted for this web application. |
|
|
Time-to-live of the static resource cache. |
||
Maximum amount of worker threads. Doesn't have an effect if virtual threads are enabled. |
|
|
Maximum capacity of the thread pool's backing queue. This setting only has an effect if the value is greater than 0. |
|
|
Minimum amount of worker threads. Doesn't have an effect if virtual threads are enabled. |
|
|
Character encoding to use to decode the URI. |
|
|
Whether HTTP 1.1 and later location headers generated by a call to sendRedirect will use relative or absolute redirects. |
|
|
Undertow access log directory. |
||
Whether to enable the access log. |
|
|
Format pattern for access logs. |
|
|
Log file name prefix. |
|
|
Whether to enable access log rotation. |
|
|
Log file name suffix. |
|
|
Whether the 'Connection: keep-alive' header should be added to all responses, even if not required by the HTTP specification. |
|
|
Size of each buffer. The default is derived from the maximum amount of memory that is available to the JVM. |
||
Whether encoded slash characters (%2F) should be decoded. Decoding can cause security problems if a front-end proxy does not perform the same decoding. Only enable this if you have a legacy application that requires it. When set, server.undertow.allow-encoded-slash has no effect. |
||
Whether the URL should be decoded. When disabled, percent-encoded characters in the URL will be left as-is. |
|
|
Whether to allocate buffers outside the Java heap. The default is derived from the maximum amount of memory that is available to the JVM. |
||
Whether servlet filters should be initialized on startup. |
|
|
Maximum number of cookies that are allowed. This limit exists to prevent hash collision based DOS attacks. |
|
|
Maximum number of headers that are allowed. This limit exists to prevent hash collision based DOS attacks. |
||
Maximum size of the HTTP post content. When the value is -1, the default, the size is unlimited. |
|
|
Maximum number of query or path parameters that are allowed. This limit exists to prevent hash collision based DOS attacks. |
||
Amount of time a connection can sit idle without processing a request, before it is closed by the server. |
||
Server options as defined in io.undertow.UndertowOptions. |
||
Socket options as defined in org.xnio.Options. |
||
Whether to preserve the path of a request when it is forwarded. |
|
|
Number of I/O threads to create for the worker. The default is derived from the number of available processors. |
||
Number of worker threads. The default is 8 times the number of I/O threads. |
||
Charset used to decode URLs. |
|
Templating Properties
| Name | Description | Default Value |
|---|---|---|
Whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. Only supported with Spring MVC. |
|
|
Whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. Only supported with Spring MVC. |
|
|
Whether to enable template caching. Only supported with Spring MVC. |
|
|
Template encoding. |
|
|
Whether to check that the templates location exists. |
|
|
Content-Type value. Only supported with Spring MVC. |
|
|
Whether to enable MVC view resolution for this technology. |
|
|
Whether all request attributes should be added to the model prior to merging with the template. Only supported with Spring MVC. |
|
|
Whether all HttpSession attributes should be added to the model prior to merging with the template. Only supported with Spring MVC. |
|
|
Whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". Only supported with Spring MVC. |
|
|
Whether to prefer file system access for template loading to enable hot detection of template changes. When a template path is detected as a directory, templates are loaded from the directory only and other matching classpath locations will not be considered. |
|
|
Prefix that gets prepended to view names when building a URL. |
||
Name of the RequestContext attribute for all views. |
||
Well-known FreeMarker keys which are passed to FreeMarker's Configuration. |
||
Suffix that gets appended to view names when building a URL. |
|
|
List of template paths. |
|
|
View names that can be resolved. |
||
Whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. |
|
|
Whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. |
|
|
Whether to enable template caching. |
|
|
Template encoding. |
|
|
Whether to check that the templates location exists. |
|
|
|
See GroovyMarkupConfigurer |
|
Content-Type value. |
|
|
Whether to enable MVC view resolution for this technology. |
|
|
Whether all request attributes should be added to the model prior to merging with the template. |
|
|
Whether all HttpSession attributes should be added to the model prior to merging with the template. |
|
|
Whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". |
|
|
Prefix that gets prepended to view names when building a URL. |
||
Name of the RequestContext attribute for all views. |
||
Template path. |
|
|
Suffix that gets appended to view names when building a URL. |
|
|
View names that can be resolved. |
||
Template encoding. |
|
|
Whether to check that the templates location exists. |
|
|
Whether to enable MVC view resolution for Mustache. |
|
|
Prefix to apply to template names. |
|
|
Media types supported by Mustache views. |
|
|
Name of the RequestContext attribute for all views. |
||
Whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. |
|
|
Whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. |
|
|
Whether to enable template caching. |
|
|
Content-Type value. |
||
Whether all request attributes should be added to the model prior to merging with the template. |
|
|
Whether all HttpSession attributes should be added to the model prior to merging with the template. |
|
|
Whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". |
|
|
Suffix to apply to template names. |
|
|
View names that can be resolved. |
||
Whether to enable template caching. |
|
|
Whether to check that the template exists before rendering it. |
|
|
Whether to check that the templates location exists. |
|
|
Enable the SpringEL compiler in SpringEL expressions. |
|
|
Whether to enable Thymeleaf view resolution for Web frameworks. |
|
|
Template files encoding. |
|
|
List of view names (patterns allowed) that should be excluded from resolution. |
||
Template mode to be applied to templates. See also Thymeleaf's TemplateMode enum. |
|
|
Prefix that gets prepended to view names when building a URL. |
|
|
Comma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set. |
||
Comma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set. |
||
Maximum size of data buffers used for writing to the response. Templates will execute in CHUNKED mode by default if this is set. |
|
|
Media types supported by the view technology. |
|
|
Whether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself. |
|
|
Content-Type value written to HTTP responses. |
|
|
|
Whether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished. |
|
Suffix that gets appended to view names when building a URL. |
|
|
Order of the template resolver in the chain. By default, the template resolver is first in the chain. Order start at 1 and should only be set if you have defined additional "TemplateResolver" beans. |
||
List of view names (patterns allowed) that can be resolved. |
Testcontainers Properties
| Name | Description | Default Value |
|---|---|---|
Testcontainers startup modes. |
|
|
How to treat injection of DynamicPropertyRegistry into a @Bean method. |
|
Testing Properties
| Name | Description | Default Value |
|---|---|---|
Type of existing DataSource to replace. |
|
|
MVC Print option. |
|
|
Whether observability should be auto-configured in tests. |
|
Transaction Properties
| Name | Description | Default Value |
|---|---|---|
Whether to enable JTA support. |
|
|
Default transaction timeout. If a duration suffix is not specified, seconds will be used. |
||
Whether to roll back on commit failures. |
Web Properties
| Name | Description | Default Value |
|---|---|---|
Whether credentials are supported. When not set, credentials are not supported. |
||
List of HTTP headers to allow in a request. '*' allows all headers. |
||
List of HTTP methods to allow. '*' allows all methods. When not set, defaults to GET. |
||
List of origin patterns to allow. Unlike allowed origins which only support '*', origin patterns are more flexible, e.g. 'https://*.example.com', and can be used with allow-credentials. When neither allowed origins nor allowed origin patterns are set, cross-origin requests are effectively disabled. |
||
List of origins to allow with '*' allowing all origins. When allow-credentials is enabled, '*' cannot be used, and setting origin patterns should be considered instead. When neither allowed origins nor allowed origin patterns are set, cross-origin requests are effectively disabled. |
||
List of headers to include in a response. |
||
How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used. |
|
|
Whether the default GraphiQL UI is enabled. |
|
|
Path to the GraphiQL UI endpoint. |
|
|
Path at which to expose a GraphQL request HTTP endpoint. |
|
|
Mapping of the RSocket message handler. |
||
File extensions for GraphQL schema files. |
|
|
Whether schema should be compared to the application to detect missing mappings. |
|
|
Whether field introspection should be enabled at the schema level. |
|
|
Locations of GraphQL schema files. |
|
|
Whether the endpoint that prints the schema is enabled. Schema is available under spring.graphql.path + "/schema". |
|
|
Time within which the initial {@code CONNECTION_INIT} type message must be received. |
|
|
Maximum idle period before a server keep-alive ping is sent to client. |
||
Path of the GraphQL WebSocket subscription endpoint. |
||
Whether application/hal+json responses should be sent to requests that accept application/json. |
|
|
Default connect timeout for a client HTTP request. |
||
Default factory used for a client HTTP request. |
||
Default read timeout for a client HTTP request. |
||
Handling for HTTP redirects. |
|
|
SSL bundle to use. |
||
Path that serves as the base URI for the application. If specified, overrides the value of "@ApplicationPath". |
||
Jersey filter chain order. |
|
|
Init parameters to pass to Jersey through the servlet or filter. |
||
Load on startup priority of the Jersey servlet. |
|
|
Jersey integration type. |
|
|
Amount of time before asynchronous request handling times out. If this value is not set, the default timeout of the underlying implementation is used. |
||
Whether a request parameter ("format" by default) should be used to determine the requested media type. |
|
|
Map file extensions to media types for content negotiation. For instance, yml to text/yaml. |
||
Query parameter name to use when "favor-parameter" is enabled. |
||
Preferred JSON mapper to use for HTTP message conversion. By default, auto-detected according to the environment. Supported values are 'jackson', 'gson', and 'jsonb'. When other json mapping libraries (such as kotlinx.serialization) are present, use a custom HttpMessageConverters bean to control the preferred mapper. |
|
|
Whether to dispatch OPTIONS requests to the FrameworkServlet doService method. |
|
|
Whether to dispatch TRACE requests to the FrameworkServlet doService method. |
|
|
Date format to use, for example 'dd/MM/yyyy'. Used for formatting of java.util.Date and java.time.LocalDate. |
||
Date-time format to use, for example 'yyyy-MM-dd HH:mm:ss'. Used for formatting of java.time's LocalDateTime, OffsetDateTime, and ZonedDateTime. |
||
Time format to use, for example 'HH:mm:ss'. Used for formatting of java.time's LocalTime and OffsetTime. |
||
Whether to enable Spring's FormContentFilter. |
|
|
Whether to enable Spring's HiddenHttpMethodFilter. |
|
|
Whether logging of (potentially sensitive) request details at DEBUG and TRACE level is allowed. |
|
|
Whether to enable warn logging of exceptions resolved by a "HandlerExceptionResolver", except for "DefaultHandlerExceptionResolver". |
|
|
Formatting strategy for message codes. For instance, 'PREFIX_ERROR_CODE'. |
||
Choice of strategy for matching request paths against registered mappings. |
|
|
Whether RFC 9457 Problem Details support should be enabled. |
|
|
Whether to publish a ServletRequestHandledEvent at the end of each request. |
|
|
Load on startup priority of the dispatcher servlet. |
|
|
Path of the dispatcher servlet. Setting a custom value for this property is not compatible with the PathPatternParser matching strategy. |
|
|
Path pattern used for static resources. |
|
|
Spring MVC view prefix. |
||
Spring MVC view suffix. |
||
Path pattern used for WebJar assets. |
|
|
Level of leak detection for reference-counted buffers. If not configured via 'ResourceLeakDetector.setLevel' or the 'io.netty.leakDetection.level' system property, default to 'simple'. |
||
Whether to enable support of multipart uploads. |
|
|
Threshold after which files are written to disk. |
|
|
Intermediate location of uploaded files. |
||
Max file size. |
|
|
Max request size. |
|
|
Whether to resolve the multipart request lazily at the time of file or parameter access. |
|
|
Whether to resolve the multipart request strictly complying with the Servlet specification, only to be used for "multipart/form-data" requests. |
|
|
Sessions flush mode. Determines when session changes are written to the session store. |
|
|
Name of the map used to store sessions. |
|
|
Sessions save mode. Determines how session changes are tracked and saved to the session store. |
|
|
Cron expression for expired session cleanup job. |
|
|
Sessions flush mode. Determines when session changes are written to the session store. |
|
|
Database schema initialization mode. |
|
|
Platform to use in initialization scripts if the @@platform@@ placeholder is used. Auto-detected by default. |
||
Sessions save mode. Determines how session changes are tracked and saved to the session store. |
|
|
Path to the SQL file to use to initialize the database schema. |
|
|
Name of the database table used to store sessions. |
|
|
Collection name used to store sessions. |
|
|
Cron expression for expired session cleanup job. Only supported when repository-type is set to indexed. Not supported with a reactive session repository. |
|
|
The configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present. |
|
|
Sessions flush mode. Determines when session changes are written to the session store. Not supported with a reactive session repository. |
|
|
Namespace for keys used to store sessions. |
|
|
Type of Redis session repository to configure. |
|
|
Sessions save mode. Determines how session changes are tracked and saved to the session store. |
|
|
Session repository filter dispatcher types. |
|
|
Session repository filter order. |
||
Session timeout. If a duration suffix is not specified, seconds will be used. |
||
Locale to use. By default, this locale is overridden by the "Accept-Language" header. |
||
Define how the locale should be resolved. |
|
|
Whether to enable default resource handling. |
|
|
Indicate that the response message is intended for a single user and must not be stored by a shared cache. |
||
Indicate that any cache may store the response. |
||
Maximum time the response should be cached, in seconds if no duration suffix is not specified. |
||
Indicate that once it has become stale, a cache must not use the response without re-validating it with the server. |
||
Indicate that the cached response can be reused only if re-validated with the server. |
||
Indicate to not cache the response in any case. |
||
Indicate intermediaries (caches and others) that they should not transform the response content. |
||
Same meaning as the "must-revalidate" directive, except that it does not apply to private caches. |
||
Maximum time the response should be cached by shared caches, in seconds if no duration suffix is not specified. |
||
Maximum time the response may be used when errors are encountered, in seconds if no duration suffix is not specified. |
||
|
Maximum time the response can be served after it becomes stale, in seconds if no duration suffix is not specified. |
|
Cache period for the resources served by the resource handler. If a duration suffix is not specified, seconds will be used. Can be overridden by the 'spring.web.resources.cache.cachecontrol' properties. |
||
Whether we should use the "lastModified" metadata of the files in HTTP caching headers. |
|
|
Whether to enable caching in the Resource chain. |
|
|
Whether to enable resolution of already compressed resources (gzip, brotli). Checks for a resource name with the '.gz' or '.br' file extensions. |
|
|
Whether to enable the Spring Resource Handling chain. By default, disabled unless at least one strategy has been enabled. |
||
Whether to enable the content Version Strategy. |
|
|
List of patterns to apply to the content Version Strategy. |
|
|
Whether to enable the fixed Version Strategy. |
|
|
List of patterns to apply to the fixed Version Strategy. |
|
|
Version string to use for the fixed Version Strategy. |
||
Locations of static resources. Defaults to classpath:[/META-INF/resources/, /resources/, /static/, /public/]. |
|
|
Base path for all web handlers. |
||
Date format to use, for example 'dd/MM/yyyy'. Used for formatting of java.util.Date and java.time.LocalDate. |
||
Date-time format to use, for example 'yyyy-MM-dd HH:mm:ss'. Used for formatting of java.time's LocalDateTime, OffsetDateTime, and ZonedDateTime. |
||
Time format to use, for example 'HH:mm:ss'. Used for formatting of java.time's LocalTime and OffsetTime. |
||
Whether to enable Spring's HiddenHttpMethodFilter. |
|
|
Directory used to store file parts larger than 'maxInMemorySize'. Default is a directory named 'spring-multipart' created under the system temporary directory. Ignored when using the PartEvent streaming support. |
||
Character set used to decode headers. |
|
|
Maximum amount of disk space allowed per part. Default is -1 which enforces no limits. |
|
|
Maximum amount of memory allowed per headers section of each part. Set to -1 to enforce no limits. |
|
|
Maximum amount of memory allowed per part before it's written to disk. Set to -1 to store all contents in memory. |
|
|
Maximum number of parts allowed in a given multipart request. Default is -1 which enforces no limits. |
|
|
Whether RFC 9457 Problem Details support should be enabled. |
|
|
Path pattern used for static resources. |
|
|
Path pattern used for WebJar assets. |
|
