Various properties can be specified inside your application.properties
file, inside your application.yml
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 mechanism 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. |
1. Core properties
Key | Default Value | Description |
---|---|---|
|
|
Enable debug logs. |
|
Arbitrary properties to add to the info endpoint. |
|
|
Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback. |
|
|
|
Conversion word used when logging exceptions. |
|
|
Whether to clean the archive log files on startup. Only supported with the default logback setup. |
|
|
Maximum number of days archive log files are kept. Only supported with the default logback setup. |
|
|
Maximum log file size. Only supported with the default logback setup. |
|
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`. |
|
|
|
Total size of log backups to be kept. Only supported with the default logback setup. |
|
Log groups to quickly change multiple loggers at the same time. For instance, `logging.group.db=org.hibernate,org.springframework.jdbc`. |
|
|
Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`. |
|
|
|
Appender pattern for output to the console. Supported only with the default Logback setup. |
|
|
Appender pattern for log date format. Supported only with the default Logback setup. |
|
|
Appender pattern for output to a file. Supported only with the default Logback setup. |
|
|
Appender pattern for log level. Supported only with the default Logback setup. |
|
|
Pattern for rolled-over log file names. Supported only with the default Logback setup. |
|
|
Register a shutdown hook for the logging system when it is initialized. |
|
|
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 name. |
|
|
Auto-configuration classes to exclude. |
|
|
|
Banner file encoding. |
|
|
Bit depth to use for ANSI colors. Supported values are 4 (16 color) or 8 (256 color). |
|
Height of the banner image in chars (default based on image height). |
|
|
|
Whether images should be inverted for dark terminal themes. |
|
|
Banner image file location (jpg or png can also be used). |
|
|
Left hand image margin in chars. |
|
|
Pixel mode to use when rendering the image. |
|
|
Width of the banner image in chars. |
|
|
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. |
|
|
Config file locations used in addition to the defaults. |
|
|
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 management beans to the JMX domain. |
|
|
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. |
|
|
Mode used to display the banner when the application runs. |
|
Override the Cloud Platform auto-detection. |
|
|
|
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. |
|
|
Comma-separated 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. |
|
|
|
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 profile expressions that at least one should match for the document to be included. |
|
|
Comma-separated list of active profiles. Can be overridden by a command line switch. |
|
|
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. |
|
|
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. |
|
|
Whether the Reactor Debug Agent should be enabled when reactor-tools is present. |
|
|
Whether core threads are allowed to time out. This enables dynamic growing and shrinking of the pool. |
|
|
Core number of threads. |
|
|
Time limit for which threads may remain idle before being terminated. |
|
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. |
|
|
Queue capacity. An unbounded capacity does not increase the pool and therefore ignores the "max-size" property. |
|
|
|
Whether the executor should wait for scheduled tasks to complete on shutdown. |
|
Maximum time the executor should wait for remaining tasks to complete. |
|
|
|
Prefix to use for the names of newly created threads. |
|
|
Maximum allowed number of threads. |
|
|
Whether the executor should wait for scheduled tasks to complete on shutdown. |
|
Maximum time the executor should wait for remaining tasks to complete. |
|
|
|
Prefix to use for the names of newly created threads. |
|
|
Enable trace logs. |
2. Cache properties
Key | Default Value | Description |
---|---|---|
|
Comma-separated 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 EhCache. |
|
|
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. |
|
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. |
3. Mail properties
Key | Default Value | Description |
---|---|---|
|
|
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. |
|
|
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. |
4. JSON properties
Key | Default Value | Description |
---|---|---|
|
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. |
|
|
Whether to be lenient about parsing JSON that doesn't conform to RFC 4627. |
|
|
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. |
|
|
Date format string or a fully-qualified date format class name. For instance, `yyyy-MM-dd HH:mm:ss`. |
|
|
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 PropertyNamingStrategy. Can also be a fully-qualified class name of a PropertyNamingStrategy subclass. |
|
|
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. |
5. Data properties
Key | Default Value | Description |
---|---|---|
|
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. |
|
Whether to enable SSL support. Enabled automatically if a "keyStore" is provided unless specified otherwise. |
|
|
Path to the JVM key store that holds the certificates. |
|
|
Password used to access the key store. |
|
|
|
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. |
|
|
Compression supported by the Cassandra binary protocol. |
|
|
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. |
|
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. |
|
|
Type of Cassandra repositories to enable. |
|
Queries consistency level. |
|
|
|
How many rows will be retrieved simultaneously in a single network roundtrip. |
|
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. |
|
|
|
Enable SSL support. |
|
Login user of the server. |
|
|
|
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". |
|
Connection timeout. |
|
|
Comma-separated list of the Elasticsearch endpoints to connect to. |
|
|
Limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated. |
|
|
Credentials password. |
|
|
Read and Write Socket timeout. |
|
|
|
Whether the client should use SSL to connect to the endpoints. |
|
Credentials username. |
|
|
|
Whether to enable Elasticsearch repositories. |
|
|
Whether to enable JDBC repositories. |
|
|
Bootstrap mode for JPA repositories. |
|
|
Whether to enable JPA repositories. |
|
|
Whether to enable LDAP repositories. |
|
Authentication database name. |
|
|
Whether to enable auto-index creation. |
|
|
Database name. |
|
|
Fully qualified name of the FieldNamingStrategy to use. |
|
|
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. |
|
|
Mongo database URI. Cannot be set with host, port, credentials and replica set name. |
|
Login user of the mongo server. Cannot be set with URI. |
|
|
|
Representation to use when converting a UUID to a BSON binary value. |
|
|
Auto index mode. |
|
|
Whether to enable embedded mode if the embedded driver is available. |
|
|
Register OpenSessionInViewInterceptor that binds a Neo4j Session to the thread for the entire processing of the request. |
|
Login password of the server. |
|
|
|
Whether to enable Neo4j repositories. |
|
URI used by the driver. Auto-detected by default. |
|
|
|
Whether to use Neo4j native types wherever possible. |
|
Login user of the server. |
|
|
|
Whether to enable R2DBC repositories. |
|
|
Whether to enable Redis repositories. |
|
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. |
|
|
|
Solr host. Ignored if "zk-host" is set. |
|
ZooKeeper host address in the form HOST:PORT. |
|
|
|
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. |
|
|
Page size parameter name. |
|
|
Sort parameter name. |
|
|
Whether to stop if an error occurs while initializing the database. |
|
Data (DML) script resource references. |
|
|
Password of the database to execute DML scripts (if different). |
|
|
Username of the database to execute DML scripts (if different). |
|
|
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. |
|
|
|
Whether to generate a random datasource name. |
|
Hikari specific settings bound to an instance of Hikari's HikariDataSource |
|
|
|
Mode to apply when determining if DataSource initialization should be performed using the available DDL and DML scripts. |
|
JNDI location of the datasource. Class, url, username and password are ignored when set. |
|
|
Name of the datasource. Default to "testdb" when using an embedded database. |
|
|
Login password of the database. |
|
|
|
Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or data-${platform}.sql). |
|
Schema (DDL) script resource references. |
|
|
Password of the database to execute DDL scripts (if different). |
|
|
Username of the database to execute DDL scripts (if different). |
|
|
|
Statement separator in SQL initialization scripts. |
|
SQL scripts encoding. |
|
|
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. |
|
Credentials password. |
|
|
|
Read timeout. |
|
|
Comma-separated list of the Elasticsearch instances to use. |
|
Credentials username. |
|
|
|
Whether to enable the console. |
|
|
Path at which the console is available. |
|
|
Whether to enable trace output. |
|
|
Whether to enable remote access. |
|
Login password. |
|
|
URL of the InfluxDB instance to which to connect. |
|
|
Login user. |
|
|
|
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 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. |
|
|
Whether to use Hibernate's newer IdentifierGenerator for AUTO, TABLE and SEQUENCE. This is actually a shortcut for the "hibernate.id.new_generator_mappings" property. When not specified will default to "true". |
|
|
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. |
|
|
LDAP URLs of the server. |
|
|
Login username of the server. |
|
|
|
Comma-separated list of features to enable. Uses the defaults of the configured version by default. |
|
Directory used for data storage. |
|
|
Maximum size of the oplog. |
|
|
Name of the replica set. |
|
|
|
Version of Mongo to use. |
|
|
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. Enabled automatically if "r2dbc-pool" is on the classpath. |
|
|
|
Initial connection pool size. |
|
|
Maximum amount of time that a connection is allowed to sit idle in the pool. |
|
|
Maximal connection pool size. |
|
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. |
|
|
Client name to be set on connections with CLIENT SETNAME. |
|
|
Maximum number of redirects to follow when executing commands across the cluster. |
|
|
Comma-separated 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. |
|
|
|
Database index used by the connection factory. |
|
|
Redis server host. |
|
|
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. |
|
Cluster topology refresh period. |
|
|
|
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. |
|
Name of the Redis server. |
|
|
Comma-separated list of "host:port" pairs. |
|
|
Password for authenticating with sentinel(s). |
|
|
|
Whether to enable SSL support. |
|
Connection timeout. |
|
|
Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:[email protected]:6379 |
6. Transaction properties
Key | Default Value | Description |
---|---|---|
|
|
Timeout, in seconds, for borrowing connections from the pool. |
|
|
Whether to ignore the transacted flag when creating session. |
|
|
Whether local transactions are desired. |
|
|
Time, in seconds, between runs of the pool's maintenance thread. |
|
|
Time, in seconds, after which connections are cleaned up from the pool. |
|
|
Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. |
|
|
Maximum size of the pool. |
|
|
Minimum size of the pool. |
|
|
Reap timeout, in seconds, for borrowed connections. 0 denotes no limit. |
|
|
Unique name used to identify the resource during recovery. |
|
Vendor-specific implementation of XAConnectionFactory. |
|
|
Vendor-specific XA properties. |
|
|
|
Timeout, in seconds, for borrowing connections from the pool. |
|
|
Whether to use concurrent connection validation. |
|
Default isolation level of connections provided by the pool. |
|
|
|
Timeout, in seconds, for establishing a database connection. |
|
|
Time, in seconds, between runs of the pool's maintenance thread. |
|
|
Time, in seconds, after which connections are cleaned up from the pool. |
|
|
Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. |
|
|
Maximum size of the pool. |
|
|
Minimum size of the pool. |
|
|
Reap timeout, in seconds, for borrowed connections. 0 denotes no limit. |
|
SQL query or statement used to validate a connection before returning it. |
|
|
|
Unique name used to identify the resource during recovery. |
|
Vendor-specific implementation of XAConnectionFactory. |
|
|
Vendor-specific XA properties. |
|
|
|
Specify whether sub-transactions are allowed. |
|
|
Interval between checkpoints, expressed as the number of log writes between two checkpoints. A checkpoint reduces the log file size at the expense of adding some overhead in the runtime. |
|
|
Default timeout for JTA transactions. |
|
How long should normal shutdown (no-force) wait for transactions to complete. |
|
|
|
Whether to enable disk logging. |
|
|
Whether a VM shutdown should trigger forced shutdown of the transaction core. |
|
Directory in which the log files should be stored. Defaults to the current working directory. |
|
|
|
Transactions log file base name. |
|
|
Maximum number of active transactions. |
|
|
Maximum timeout that can be allowed for transactions. |
|
|
Delay between two recovery scans. |
|
|
Delay after which recovery can cleanup pending ('orphaned') log entries. |
|
|
Number of retry attempts to commit the transaction before throwing an exception. |
|
|
Delay between retry attempts. |
|
|
Whether sub-transactions should be joined when possible. |
|
Transaction manager implementation that should be started. |
|
|
|
Whether to use different (and concurrent) threads for two-phase commit on the participating resources. |
|
The transaction manager's unique name. Defaults to the machine's IP address. If you plan to run more than one transaction manager against one database you must set this property to a unique value. |
|
|
|
Number of connections to create when growing the pool. |
|
|
Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired. |
|
|
Timeout, in seconds, for acquiring connections from the pool. |
|
|
Whether the transaction manager should allow mixing XA and non-XA transactions. |
|
|
Whether the transaction timeout should be set on the XAResource when it is enlisted. |
|
|
Whether resources should be enlisted and delisted automatically. |
|
|
Whether producers and consumers should be cached. |
|
Underlying implementation class name of the XA resource. |
|
|
|
Whether the provider can run many transactions on the same connection and supports transaction interleaving. |
|
|
Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool. |
|
Properties that should be set on the underlying implementation. |
|
|
||
|
|
Whether recovery failures should be ignored. |
|
|
Time, in seconds, after which connections are cleaned up from the pool. |
|
|
Maximum size of the pool. 0 denotes no limit. |
|
|
Minimum size of the pool. |
|
Password to use to connect to the JMS provider. |
|
|
|
Whether connections in the ACCESSIBLE state can be shared within the context of a transaction. |
|
|
Whether connections should be tested when acquired from the pool. |
|
|
Position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE). |
|
|
Unique name used to identify the resource during recovery. |
|
|
Whether TMJOIN should be used when starting XAResources. |
|
User to use to connect to the JMS provider. |
|
|
|
Number of connections to create when growing the pool. |
|
|
Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired. |
|
|
Timeout, in seconds, for acquiring connections from the pool. |
|
|
Whether the transaction manager should allow mixing XA and non-XA transactions. |
|
|
Whether the transaction timeout should be set on the XAResource when it is enlisted. |
|
|
Whether resources should be enlisted and delisted automatically. |
|
Underlying implementation class name of the XA resource. |
|
|
Default cursor holdability for connections. |
|
|
|
Whether the database can run many transactions on the same connection and supports transaction interleaving. |
|
|
Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool. |
|
Properties that should be set on the underlying implementation. |
|
|
|
Whether Connection.isValid() is called when acquiring a connection from the pool. |
|
||
|
|
Whether recovery failures should be ignored. |
|
Default isolation level for connections. |
|
|
Default auto-commit mode for local transactions. |
|
|
Timeout, in seconds, for establishing a database connection. |
|
|
|
Time, in seconds, after which connections are cleaned up from the pool. |
|
|
Maximum size of the pool. 0 denotes no limit. |
|
|
Minimum size of the pool. |
|
|
Target size of the prepared statement cache. 0 disables the cache. |
|
|
Whether connections in the ACCESSIBLE state can be shared within the context of a transaction. |
|
SQL query or statement used to validate a connection before returning it. |
|
|
|
Position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, and always last is Integer.MAX_VALUE). |
|
|
Unique name used to identify the resource during recovery. |
|
|
Whether TMJOIN should be used when starting XAResources. |
|
|
Whether to enable JTA support. |
|
Transaction logs directory. |
|
|
Transaction manager unique identifier. |
|
|
Default transaction timeout. If a duration suffix is not specified, seconds will be used. |
|
|
Whether to roll back on commit failures. |
7. Data migration properties
Key | Default Value | Description |
---|---|---|
|
|
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 Pro or Flyway Enterprise. |
|
|
|
Whether to check that migration scripts location exists. |
|
|
Whether to disable cleaning of the database. |
|
|
Whether to automatically call clean when a validation error occurs. |
|
|
Maximum number of retries when attempting to connect to the database. |
|
Default schema name managed by Flyway (case-sensitive). |
|
|
|
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 Pro or Flyway Enterprise. |
|
|
|
Whether to group all pending migrations together in the same transaction when applying them. |
|
|
Whether to ignore future migrations when reading the schema history table. |
|
|
Whether to ignore ignored migrations when reading the schema history table. |
|
|
Whether to ignore missing migrations when reading the schema history table. |
|
|
Whether to ignore pending migrations when reading the schema history table. |
|
SQL statements to execute to initialize a connection immediately after obtaining it. |
|
|
Username recorded in the schema history table as having applied the migration. |
|
|
Licence key for Flyway Pro or Flyway Enterprise. |
|
|
|
Locations of migrations scripts. Can contain the special "{vendor}" placeholder to use vendor-specific locations. |
|
|
Whether to allow mixing transactional and non-transactional statements within the same migration. |
|
Whether to enable support for Oracle SQL*Plus commands. Requires Flyway Pro or Flyway Enterprise. |
|
|
Whether to issue a warning rather than an error when a not-yet-supported Oracle SQL*Plus statement is encountered. Requires Flyway Pro or Flyway Enterprise. |
|
|
|
Whether to allow migrations to be run out of order. |
|
Login password of the database to migrate. |
|
|
|
Prefix of placeholders in migration scripts. |
|
|
Perform placeholder replacement in migration scripts. |
|
|
Suffix of placeholders in migration scripts. |
|
Placeholders and their replacements to apply to sql migration scripts. |
|
|
|
File name prefix for repeatable SQL migrations. |
|
Scheme names managed by Flyway (case-sensitive). |
|
|
|
Whether to skip default callbacks. If true, only custom callbacks are used. |
|
|
Whether to skip default resolvers. If true, only custom resolvers are used. |
|
|
File name prefix for SQL migrations. |
|
|
File name separator for SQL migrations. |
|
|
File name suffix for SQL migrations. |
|
Whether to stream SQL migrations when executing them. Requires Flyway Pro or Flyway Enterprise. |
|
|
|
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. |
|
Comma-separated 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. |
|
|
|
Whether to first drop the database schema. |
|
|
Whether to enable Liquibase support. |
|
Comma-separated 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. |
|
|
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. |
|
JDBC URL of the database to migrate. If not set, the primary configured data source is used. |
|
|
Login user of the database to migrate. |
8. Integration properties
Key | Default Value | Description |
---|---|---|
|
URL of the ActiveMQ broker. Auto-generated by default. |
|
|
|
Time to wait before considering a close complete. |
|
|
Whether the default broker URL should be in memory. Ignored if an explicit broker has been specified. |
|
|
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. |
|
|
Comma-separated 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. |
|
|
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. |
|
|
Comma-separated list of queues to create on startup. |
|
|
Server ID. By default, an auto-incremented counter is used. |
|
|
Comma-separated list of topics to create on startup. |
|
|
Artemis broker host. |
|
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. |
|
|
Artemis broker port. |
|
Login user of the broker. |
|
|
|
Database schema initialization mode. |
|
|
Execute all Spring Batch jobs in the context on startup. |
|
Comma-separated list of job names to execute on startup (for instance, `job1,job2`). By default, all Jobs found in the context are executed. |
|
|
|
Path to the SQL file to use to initialize the database schema. |
|
Table prefix for all the batch meta-data tables. |
|
|
The location of the configuration file to use to initialize Hazelcast. |
|
|
|
Database schema initialization mode. |
|
|
Path to the SQL file to use to initialize the database schema. |
|
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 via 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). |
|
Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations. |
|
|
Acknowledge mode of the container. By default, the listener is transacted with automatic acknowledgment. |
|
|
|
Start the container automatically on startup. |
|
Minimum number of concurrent consumers. |
|
|
Maximum number of concurrent consumers. |
|
|
|
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. |
|
|
Whether the default destination type is topic. |
|
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. |
|
|
Time-to-live of a message when sending. Enables QoS (Quality of Service) when set. |
|
|
ID to pass to the server when making requests. Used for server-side logging. |
|
|
|
Whether to fail fast if the broker is not available on startup. |
|
Additional admin-specific properties used to configure the client. |
|
|
Security protocol used to communicate with brokers. |
|
|
Password of the private key in the key store file. |
|
|
Location of the key store file. |
|
|
Store password for the key store file. |
|
|
Type of the key store. |
|
|
SSL protocol to use. |
|
|
Location of the trust store file. |
|
|
Store password for the trust store file. |
|
|
Type of the trust store. |
|
|
Comma-delimited 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. |
|
|
Comma-delimited 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. |
|
|
Password of the private key in the key store file. |
|
|
Location of the key store file. |
|
|
Store password for the key store file. |
|
|
Type of the key store. |
|
|
SSL protocol to use. |
|
|
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". |
|
|
Prefix for the listener's consumer client.id property. |
|
|
Number of threads to run in the listener containers. |
|
|
Time between publishing idle consumer events (no data received). |
|
|
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. |
|
|
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). |
|
|
Comma-delimited 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. |
|
|
Password of the private key in the key store file. |
|
|
Location of the key store file. |
|
|
Store password for the key store file. |
|
|
Type of the key store. |
|
|
SSL protocol to use. |
|
|
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. |
|
|
Security protocol used to communicate with brokers. |
|
|
Password of the private key in the key store file. |
|
|
Location of the key store file. |
|
|
Store password for the key store file. |
|
|
Type of the key store. |
|
|
SSL protocol to use. |
|
|
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 or not to auto-start the streams factory bean. |
|
Comma-delimited list of host:port pairs to use for establishing the initial connections to the Kafka cluster. Overrides the global property, for streams. |
|
|
Maximum memory size to be used for buffering across all threads. |
|
|
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. |
|
|
Password of the private key in the key store file. |
|
|
Location of the key store file. |
|
|
Store password for the key store file. |
|
|
Type of the key store. |
|
|
SSL protocol to use. |
|
|
Location of the trust store file. |
|
|
Store password for the trust store file. |
|
|
Type of the trust store. |
|
|
Directory location for the state store. |
|
|
Default topic to which messages are sent. |
|
|
Comma-separated 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. |
|
|
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 rejected deliveries are re-queued by default. |
|
|
How often idle container events should be published. |
|
|
|
Whether to fail if the queues declared by the container are not available on the broker. |
|
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 rejected deliveries are re-queued by default. |
|
|
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. |
|
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. |
|
|
Listener container type. |
|
|
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. |
|
|
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. |
|
|
Password used to access the key store. |
|
|
|
Key store type. |
|
Trust store that holds SSL certificates. |
|
|
Password used to access the trust store. |
|
|
|
Trust store type. |
|
|
Whether to enable server side certificate validation. |
|
|
Whether to enable hostname verification. |
|
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. |
|
|
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. |
9. Web properties
Key | Default Value | Description |
---|---|---|
|
|
Whether application/hal+json responses should be sent to requests that accept application/json. |
|
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. |
|
|
|
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`. |
|
|
Date-time format to use, for example `yyyy-MM-dd HH:mm:ss`. |
|
|
Time format to use, for example `HH:mm:ss`. |
|
|
|
Whether to enable Spring's FormContentFilter. |
|
|
Whether to enable Spring's HiddenHttpMethodFilter. |
|
|
Whether the content of the "default" model should be ignored during redirect scenarios. |
|
Locale to use. By default, this locale is overridden by the "Accept-Language" header. |
|
|
|
Define how the locale should be resolved. |
|
|
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`. |
|
|
|
Whether to publish a ServletRequestHandledEvent at the end of each request. |
|
|
Load on startup priority of the dispatcher servlet. |
|
|
Path of the dispatcher servlet. |
|
|
Path pattern used for static resources. |
|
|
Whether a "NoHandlerFoundException" should be thrown if no Handler was found to process a request. |
|
Spring MVC view prefix. |
|
|
Spring MVC view suffix. |
|
|
|
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.resources.cache.cachecontrol' properties. |
|
|
|
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 HTML5 application cache manifest rewriting. |
|
|
Whether to enable the content Version Strategy. |
|
|
Comma-separated list of patterns to apply to the content Version Strategy. |
|
|
Whether to enable the fixed Version Strategy. |
|
|
Comma-separated 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/]. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
The configure action to apply when no user defined ConfigureRedisAction bean is present. |
|
|
Sessions flush mode. Determines when session changes are written to the session store. |
|
|
Namespace for keys used to store sessions. |
|
|
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 store type. |
|
|
Session timeout. If a duration suffix is not specified, seconds will be used. |
|
|
Base path for all web handlers. |
|
|
Date format to use, for example `dd/MM/yyyy`. |
|
|
Date-time format to use, for example `yyyy-MM-dd HH:mm:ss`. |
|
|
Time format to use, for example `HH:mm:ss`. |
|
|
|
Whether to enable Spring's HiddenHttpMethodFilter. |
|
|
Path pattern used for static resources. |
10. Templating properties
Key | Default Value | Description |
---|---|---|
|
|
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. |
|
|
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". |
|
|
Whether to prefer file system access for template loading. File system access enables hot detection of template changes. |
|
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. |
|
|
Comma-separated 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. |
|
|
|
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. |
|
|
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 to apply to template names. |
|
Name of the RequestContext attribute for all views. |
|
|
|
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. |
|
Comma-separated 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. |
|
|
Comma-separated list of view names (patterns allowed) that can be resolved. |
11. Server properties
Key | Default Value | Description |
---|---|---|
|
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 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 size of the form content in any HTTP post request. |
|
|
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. |
|
Maximum capacity of the thread pool's backing queue. A default is computed based on the threading configuration. |
|
|
|
Minimum number of threads. |
|
|
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 message header. |
|
Connection timeout of the Netty channel. |
|
|
|
Server HTTP port. |
|
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. |
|
|
||
|
|
Whether to enable http encoding support. |
|
||
|
||
|
||
|
||
|
|
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. |
|
Comment for the session cookie. |
|
|
Domain for the session cookie. |
|
|
Whether to use "HttpOnly" cookies for session cookies. |
|
|
Maximum age of the session cookie. If a duration suffix is not specified, seconds will be used. |
|
|
Session cookie name. |
|
|
Path of the session cookie. |
|
|
Whether to always mark the session 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. |
|
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. |
|
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 it 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. |
|
Comma-separated 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. |
|
|
|
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 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. |
|
Comma-separated list of additional unencoded characters that should be allowed in URI paths. Only "< > [ \ ] ^ ` { | }" are allowed. |
|
|
Comma-separated 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`. |
|
|
|
Whether static resource caching is permitted for this web application. |
|
Time-to-live of the static resource cache. |
|
|
|
Maximum amount of worker threads. |
|
|
Minimum amount of worker threads. |
|
|
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 server should decode percent encoded slash characters. Enabling encoded slashes can have security implications due to different servers interpreting the slash differently. Only enable this if you have a legacy application that requires it. |
|
|
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 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. |
|
|
||
|
||
|
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. |
12. Security properties
Key | Default Value | Description |
---|---|---|
|
|
Security filter chain dispatcher types. |
|
|
Security filter chain order. |
|
OAuth provider details. |
|
|
OAuth client registrations. |
|
|
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 Algorithm used for verifying the digital signatures. |
|
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. |
13. RSocket properties
Key | Default Value | Description |
---|---|---|
|
Network address to which the server should bind. |
|
|
Path under which RSocket handles requests (only works with websocket transport). |
|
|
Server port. |
|
|
|
RSocket transport protocol. |
14. Actuator properties
Key | Default Value | Description |
---|---|---|
|
|
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. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the auditevents endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the beans endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the caches endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the conditions endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the configprops endpoint. |
|
|
Keys that should be sanitized. Keys can be simple strings that the property ends with or regular expressions. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the env endpoint. |
|
|
Keys that should be sanitized. Keys can be simple strings that the property ends with or regular expressions. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the flyway endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the health endpoint. |
|
Health endpoint groups. |
|
|
|
Whether to enable liveness and readiness probes. |
|
Roles used to determine whether or not 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). |
|
|
|
Comma-separated list of health statuses in order of severity. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the heapdump endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the httptrace endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the info endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the integrationgraph endpoint. |
|
Jolokia settings. Refer to the documentation of Jolokia for more details. |
|
|
|
Whether to enable the jolokia endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the liquibase endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the logfile endpoint. |
|
External Logfile to be accessed. Can be used if the logfile is written by output redirect and not by the logging system itself. |
|
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the loggers endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the mappings endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the metrics endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the prometheus endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the scheduledtasks endpoint. |
|
|
Whether to enable the sessions endpoint. |
|
|
Whether to enable the shutdown endpoint. |
|
|
Maximum time that a response can be cached. |
|
|
Whether to enable the threaddump endpoint. |
|
Whether to enable or disable all endpoints by default. |
|
|
|
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 server.servlet.context-path or management.server.servlet.context-path if management.server.port is configured. |
|
Whether credentials are supported. When not set, credentials are not supported. |
|
|
Comma-separated list of headers to allow in a request. '*' allows all headers. |
|
|
Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET. |
|
|
Comma-separated list of origins to allow. '*' allows all origins. When not set, CORS support is disabled. |
|
|
Comma-separated 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. |
|
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. |
|
|
|
Whether to enable Cassandra health check. |
|
|
Whether to enable Couchbase health check. |
|
|
Whether to enable database health check. |
|
|
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. |
|
|
Whether to enable Solr health check. |
|
|
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. |
|
Maximum value that meter IDs starting with the specified name are expected to observe. The longest match wins. Values can be specified as a long 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 long or as a Duration value (for timer meters, defaulting to ms if no unit specified). |
|
|
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 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. |
|
|
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 long 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. |
|
|
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. |
|
|
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. |
|
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. If you need to publish metrics to an internal proxy en-route to Datadog, you can define the location of the proxy with this. |
|
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. |
|
ID of the custom device that is exporting metrics to Dynatrace. |
|
|
|
Whether exporting of metrics to this backend is enabled. |
|
Group for exported metrics. Used to specify custom device group name in the Dynatrace UI. |
|
|
|
Read timeout for requests to this backend. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
Technology type for exported metrics. Used to group metrics under a logical technology name in the Dynatrace UI. |
|
URI to ship metrics to. Should be used for SaaS, self managed instances or to en-route through an internal proxy. |
|
|
|
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 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. |
|
|
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. |
|
|
|
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 multi-cast 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. |
|
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. |
|
|
Whether to create the Influx database if it does not exist before attempting to publish metrics to it. |
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Whether to enable GZIP compression of metrics batches published to Influx. |
|
|
Connection timeout for requests to this backend. |
|
|
Write consistency for each point. |
|
|
Tag that will be mapped to "host" when shipping metrics to Influx. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
Login password of the Influx server. |
|
|
|
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. |
|
|
Retention policy to use (Influx writes to the DEFAULT retention policy if one is not specified). |
|
|
How many copies of the data are stored in the cluster. Must be 1 for a single node instance. |
|
|
Time range covered by a shard group. For instance 2w, check the influx documentation for more details on the duration format. |
|
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI of the Influx server. |
|
Login user of the Influx server. |
|
|
|
Metrics JMX domain name. |
|
|
Whether exporting of metrics to JMX 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. |
|
|
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 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 Prometheus is enabled. |
|
|
Histogram type for backing DistributionSummary and Timer. |
|
|
Base URL for the Pushgateway. |
|
|
Enable publishing via a Prometheus Pushgateway. |
|
Grouping key for the pushed metrics. |
|
|
Job identifier for this application instance. |
|
|
|
Frequency with which to push metrics. |
|
|
Operation that should be performed on shutdown. |
|
|
Step size (i.e. reporting frequency) to use. |
|
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. |
|
|
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, in the absence of any other exporter, exporting of metrics to an in-memory 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. |
|
Identifier of the Google Cloud project to monitor. |
|
|
|
Read timeout for requests to this backend. |
|
|
Monitored resource type. |
|
|
Step size (i.e. reporting frequency) to use. |
|
|
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. |
|
|
Whether to send unchanged meters to the StatsD server. |
|
API token used when publishing metrics directly to the Wavefront API host. |
|
|
|
Number of measurements per request to use for this backend. If more measurements are found, then multiple requests will be made. |
|
|
Whether exporting of metrics to this backend is enabled. |
|
Global prefix to separate metrics originating from this app's white box instrumentation from those originating from other Wavefront integrations when viewed in the Wavefront UI. |
|
|
|
|
|
|
|
|
||
|
Unique identifier for the app instance that is the source of metrics being published to Wavefront. Defaults to the local host name. |
|
|
|
Step size (i.e. reporting frequency) to use. |
|
|
URI to ship metrics to. |
|
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. |
|
|
Whether to automatically time web client requests. |
|
Computed non-aggregable percentiles to publish. |
|
|
|
Whether percentile histograms should be published. |
|
|
Name of the metric for sent requests. |
|
|
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. |
|
|
Whether to automatically time web server requests. |
|
Computed non-aggregable percentiles to publish. |
|
|
|
Whether percentile histograms should be published. |
|
|
Whether the trailing slash should be ignored when recording metrics. |
|
|
Name of the metric for received requests. |
|
|
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 HTTP port (uses the same port as the application by default). Configure a different port to use management-specific SSL. |
|
|
Management endpoint context-path (for instance, `/management`). Requires a custom management.server.port. |
|
|
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. |
|
Trust store that holds SSL certificates. |
|
|
Password used to access the trust store. |
|
|
Provider for the trust store. |
|
|
Type of the trust store. |
|
|
|
Whether to enable HTTP request-response tracing. |
|
|
Items to be included in the trace. Defaults to request headers (excluding Authorization but including Cookie), response headers (including Set-Cookie), and time taken. |
15. Devtools properties
Key | Default Value | Description |
---|---|---|
|
|
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. |