From ae39935d61b4cb03be7234020d7cf734b2699dbf Mon Sep 17 00:00:00 2001 From: John Blum Date: Fri, 5 Apr 2019 17:43:19 -0700 Subject: [PATCH] Add configuration meta-data reference for Pool properties. --- .../asciidoc/configuration-properties.adoc | 84 ++++++++++++++----- 1 file changed, 62 insertions(+), 22 deletions(-) diff --git a/spring-geode-docs/src/docs/asciidoc/configuration-properties.adoc b/spring-geode-docs/src/docs/asciidoc/configuration-properties.adoc index ea18ce28..a10e1a92 100644 --- a/spring-geode-docs/src/docs/asciidoc/configuration-properties.adoc +++ b/spring-geode-docs/src/docs/asciidoc/configuration-properties.adoc @@ -9,7 +9,7 @@ different aspects of or enable individual features of Apache Geode or Pivotal Ge When combined with the power of Spring Boot, magical things begin to happen. [[geode-configuration-metadata-springdata]] -=== Spring Data for Apache Geode/Pivotal GemFire Properties +=== Spring Data Based Properties The following properties all have a `spring.data.gemfire.*` prefix. For example, to set the cache `copy-on-read` property, use `spring.data.gemfire.cache.copy-on-read` in Spring Boot `application.properties`. @@ -98,7 +98,7 @@ property, use `spring.data.gemfire.cache.copy-on-read` in Spring Boot `applicati |===================================================================================================================== -_CacheServer_ properties can be further targeted at specific CacheServer instances, using an option bean name +_CacheServer_ properties can be further targeted at specific _CacheServer_ instances, using an option bean name of the `CacheServer` bean defined in the Spring application context. For example: [source,properties] @@ -188,10 +188,10 @@ specified location and limited to the defined size. |===================================================================================================================== | Name | Description | Default | From -| logging.level | Configures the log-level of an Apache Geode / Pivotal GemFire cache; Alias for 'spring.data.gemfire.cache.log-level'. | config | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logLevel--[EnableLogging.logLevel] -| logging.log-disk-space-limit | Configures the amount of disk space allowed to store log files. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logDiskSpaceLimit--[EnableLogging.logDiskSpaceLimit] -| logging.log-file | Configures the pathname of the log file used to log messages. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logFile--[EnableLogging.logFile] -| logging.log-file-size | Configures the maximum size of a log file before the log file is rolled. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logFileSizeLimit--[EnableLogging.logFileSize] +| logging.level | Configures the log-level of an Apache Geode / Pivotal GemFire cache; Alias for 'spring.data.gemfire.cache.log-level'. | config | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logLevel--[EnableLogging.logLevel] +| logging.log-disk-space-limit | Configures the amount of disk space allowed to store log files. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logDiskSpaceLimit--[EnableLogging.logDiskSpaceLimit] +| logging.log-file | Configures the pathname of the log file used to log messages. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logFile--[EnableLogging.logFile] +| logging.log-file-size | Configures the maximum size of a log file before the log file is rolled. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableLogging.html#logFileSizeLimit--[EnableLogging.logFileSize] |===================================================================================================================== @@ -201,9 +201,9 @@ specified location and limited to the defined size. |===================================================================================================================== | Name | Description | Default | From -| management.use-http | Configures whether to use the HTTP protocol to communicate with a GemFire/Geode Manager. | false | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#useHttp--[EnableClusterConfiguration.useHttp] -| management.http.host | Configures the IP address or hostname of the GemFire/Geode Manager running the HTTP service. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#host-- | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#host--[EnableClusterConfiguration.host] -| management.http.port | Configures the port used by the GemFire/Geode Manager's HTTP service to listen for connections. | 7070 | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#host-- | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#port--[EnableClusterConfiguration.port] +| management.use-http | Configures whether to use the HTTP protocol to communicate with a GemFire/Geode Manager. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#useHttp--[EnableClusterConfiguration.useHttp] +| management.http.host | Configures the IP address or hostname of the GemFire/Geode Manager running the HTTP service. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#host--[EnableClusterConfiguration.host] +| management.http.port | Configures the port used by the GemFire/Geode Manager's HTTP service to listen for connections. | 7070 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.html#port--[EnableClusterConfiguration.port] |===================================================================================================================== @@ -213,13 +213,13 @@ specified location and limited to the defined size. |===================================================================================================================== | Name | Description | Default | From -| manager.access-file | Configures the Access Control List (ACL) file used by the Manager to restrict access to the JMX MBeans by the clients. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableManager.html#accessFile--[EnableManager.accessFile] -| manager.bind-address | Configures the IP address or hostname of the system NIC used by the Manager to bind and listen for JMX client connections. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableManager.html#bindAddress--[EnableManager.bindAddress] -| manager.hostname-for-clients | Configures the hostname given to JMX clients to ask the Locator for the location of the Manager. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableManager.html#hostnameForClients--[EnableManager.hostNameForClients] -| manager.password-file | By default, the JMX Manager will allow clients without credentials to connect. If this property is set to the name of a file then only clients that connect with credentials that match an entry in this file will be allowed. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableManager.html#passwordFile--[EnableManager.passwordFile] -| manager.port | Configures the port used by th Manager to listen for JMX client connections. | 1099 | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableManager.html#port--[EnableManager.port] -| manager.start | Configures whether to start the Manager service at runtime. | false | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableManager.html#start--[EnableManager.start] -| manager.update-rate | Configures the rate, in milliseconds, at which this member will push updates to any JMX Managers. | 2000 | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnableManager.html#updateRate--[EnableManager.updateRate] +| manager.access-file | Configures the Access Control List (ACL) file used by the Manager to restrict access to the JMX MBeans by the clients. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableManager.html#accessFile--[EnableManager.accessFile] +| manager.bind-address | Configures the IP address or hostname of the system NIC used by the Manager to bind and listen for JMX client connections. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableManager.html#bindAddress--[EnableManager.bindAddress] +| manager.hostname-for-clients | Configures the hostname given to JMX clients to ask the Locator for the location of the Manager. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableManager.html#hostnameForClients--[EnableManager.hostNameForClients] +| manager.password-file | By default, the JMX Manager will allow clients without credentials to connect. If this property is set to the name of a file then only clients that connect with credentials that match an entry in this file will be allowed. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableManager.html#passwordFile--[EnableManager.passwordFile] +| manager.port | Configures the port used by th Manager to listen for JMX client connections. | 1099 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableManager.html#port--[EnableManager.port] +| manager.start | Configures whether to start the Manager service at runtime. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableManager.html#start--[EnableManager.start] +| manager.update-rate | Configures the rate, in milliseconds, at which this member will push updates to any JMX Managers. | 2000 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnableManager.html#updateRate--[EnableManager.updateRate] |===================================================================================================================== @@ -229,11 +229,51 @@ specified location and limited to the defined size. |===================================================================================================================== | Name | Description | Default | From -| pdx.disk-store-name | Configures the name of the DiskStore used to store PDX type meta-data to disk when PDX is persistent. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnablePdx.html#diskStoreName--[EnablePdx.diskStoreName] -| pdx.ignore-unread-fields | Configures whether PDX ignores fields that were unread during deserialization. | false | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnablePdx.html#ignoreUnreadFields--[EnablePdx.ignoreUnreadFields] -| pdx.persistent | Configures whether PDX persists type meta-data to disk. | false | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnablePdx.html#persistent--[EnablePdx.persistent] -| pdx.read-serialized | Configures whether a Region entry is returned as a PdxInstance or deserialized back into object form on read. | false | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnablePdx.html#readSerialized--[EnablePdx.readSerialized] -| pdx.serialize-bean-name | Configures the name of a custom Spring bean implementing org.apache.geode.pdx.PdxSerializer. | | https://docs.spring.io/spring-data/geode/docs/current/api/org/springframework/data/gemfire/config/annotation/EnablePdx.html#serializerBeanName--[EnablePdx.serializerBeanName] +| pdx.disk-store-name | Configures the name of the DiskStore used to store PDX type meta-data to disk when PDX is persistent. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePdx.html#diskStoreName--[EnablePdx.diskStoreName] +| pdx.ignore-unread-fields | Configures whether PDX ignores fields that were unread during deserialization. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePdx.html#ignoreUnreadFields--[EnablePdx.ignoreUnreadFields] +| pdx.persistent | Configures whether PDX persists type meta-data to disk. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePdx.html#persistent--[EnablePdx.persistent] +| pdx.read-serialized | Configures whether a Region entry is returned as a PdxInstance or deserialized back into object form on read. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePdx.html#readSerialized--[EnablePdx.readSerialized] +| pdx.serialize-bean-name | Configures the name of a custom Spring bean implementing org.apache.geode.pdx.PdxSerializer. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePdx.html#serializerBeanName--[EnablePdx.serializerBeanName] + +|===================================================================================================================== + + +.`spring.data.gemfire.*` Pool properties +[width="90%",options="header"] +|===================================================================================================================== +| Name | Description | Default | From + +| pool.free-connection-timeout | Configures the timeout used to acquire a free connection from a Pool. | 10000 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#freeConnectionTimeout--[EnablePool.freeConnectionTimeout] +| pool.idle-timeout | Configures the amount of time a connection can be idle before expiring (and closing) the connection. | 5000 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#idleTimeout--[EnablePool.idleTimeout] +| pool.load-conditioning-interval | Configures the interval for how frequently the pool will check to see if a connection to a given server should be moved to a different server to improve the load balance. | 300000 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#loadConditioningInterval--[EnablePool.loadConditioningInterval] +| pool.locators | Comma-delimited list of Locator endpoints in the format: locator1[port1],...,locatorN[portN] | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#locators--[EnablePool.locators] +| pool.max-connections | Configures the maximum number of client to server connections that a Pool will create. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#maxConnections--[EnablePool.maxConnections] +| pool.min-connections | Configures the minimum number of client to server connections that a Pool will maintain. | 1 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#minConnections--[EnablePool.minConnections] +| pool.multi-user-authentication | Configures whether the created Pool can be used by multiple authenticated users. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#multiUserAuthentication--[EnablePool.multiUserAuthentication] +| pool.ping-interval | Configures how often to ping servers to verify that they are still alive. | 10000 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#pingInterval--[EnablePool.pingInterval] +| pool.pr-single-hop-enabled | Configures whether to perform single-hop data access operations between the client and servers. When true the client is aware of the location of partitions on servers hosting Regions with DataPolicy.PARTITION. | true | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#prSingleHopEnabled--[EnablePool.prSingleHopEnabled] +| pool.read-timeout | Configures the number of milliseconds to wait for a response from a server before timing out the operation and trying another server (if any are available). | 10000 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#readTimeout--[EnablePool.readTimeout] +| pool.ready-for-events | Configures whether to signal the server that the client is prepared and ready to receive events. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/ClientCacheApplication.html#readyForEvents--[ClientCacheApplication.readyForEvents] +| pool.retry-attempts | Configures the number of times to retry a request after timeout/exception. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#retryAttempts--[EnablePool.retryAttempts] +| pool.server-group | Configures the group that all servers a Pool connects to must belong to. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#serverGroup--[EnablePool.serverGroup] +| pool.servers | Comma-delimited list of CacheServer endpoints in the format: server1[port1],...,serverN[portN] | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#servers--[EnablePool.servers] +| pool.socket-buffer-size | Configures the socket buffer size for each connection made in all Pools. | 32768 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#socketBufferSize--[EnablePool.socketBufferSize] +| pool.statistic-interval | Configures how often to send client statistics to the server. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#statisticInterval--[EnablePool.statisticInterval] +| pool.subscription-ack-interval | Configures the interval in milliseconds to wait before sending acknowledgements to the CacheServer for events received from the server subscriptions. | 100 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#subscriptionAckInterval--[EnablePool.subscriptionAckInterval] +| pool.subscription-enabled | Configures whether the created Pool will have server-to-client subscriptions enabled. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#subscriptionEnabled--[EnablePool.subscriptionEnabled] +| pool.subscription-message-tracking-timeout | Configures the messageTrackingTimeout attribute which is the time-to-live period, in milliseconds, for subscription events the client has received from the server. | 900000 | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#subscriptionMessageTrackingTimeout--[EnablePool.subscriptionMessageTrackingTimeout] +| pool.subscription-redundancy | Configures the redundancy level for all Pools server-to-client subscriptions. | | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#subscriptionRedundancy--[EnablePool.subsriptionRedundancy] +| pool.thread-local-connections | Configures the thread local connections policy for all Pools. | false | {spring-data-geode-javadoc}/org/springframework/data/gemfire/config/annotation/EnablePool.html#threadLocalConnections--[EnablePool.threadLocalConnections] + +|===================================================================================================================== + + +.`spring.data.gemfire.*` Security properties +[width="90%",options="header"] +|===================================================================================================================== +| Name | Description | Default | From + +| X | X | false | [ClientCacheApplication.name] |===================================================================================================================== @@ -249,7 +289,7 @@ specified location and limited to the defined size. [[geode-configuration-metadata-springsession]] -=== Spring Session for Apache Geode/Pivotal GemFire Properties +=== Spring Session Based Properties The following properties all have a `spring.session.data.gemfire.*` prefix. For example, to set the Session Region name, use `spring.session.data.gemfire.session.region.name` in Spring Boot `application.properties`.