Repository: geode Updated Branches: refs/heads/feature/GEODE-3416 c20ac681d -> c6b20a91f (forced update)
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/gfe_cache_xml.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/gfe_cache_xml.html.md.erb b/geode-docs/reference/topics/gfe_cache_xml.html.md.erb index dba7b6a..3a941eb 100644 --- a/geode-docs/reference/topics/gfe_cache_xml.html.md.erb +++ b/geode-docs/reference/topics/gfe_cache_xml.html.md.erb @@ -22,9 +22,9 @@ limitations under the License. # <cache> Element Reference -This section documents the `cache.xml` sub-elements used for Geode server configuration. All elements are sub-elements of the `<cache>` element. +This section documents the `cache.xml` sub-elements used for <%=vars.product_name%> server configuration. All elements are sub-elements of the `<cache>` element. -For Geode client configuration, see [<client-cache> Element Reference](client-cache.html#cc-client-cache). +For <%=vars.product_name%> client configuration, see [<client-cache> Element Reference](client-cache.html#cc-client-cache). **API**:`org.apache.geode.cache.CacheFactory` @@ -237,7 +237,7 @@ Deprecated ## <a id="gateway-sender" class="no-quick-link"></a><gateway-sender> -Configures a gateway sender to distribute region events to another Geode site. See [Configuring a Multi-site (WAN) System](../../topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html#setting_up_a_multisite_system). +Configures a gateway sender to distribute region events to another <%=vars.product_name%> site. See [Configuring a Multi-site (WAN) System](../../topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html#setting_up_a_multisite_system). **API:** `GatewaySender` @@ -260,7 +260,7 @@ Configures a gateway sender to distribute region events to another Geode site. S <tbody> <tr class="odd"> <td>parallel</td> -<td>Value of "true" or "false" that specifies the type of gateway sender that Geode creates.</td> +<td>Value of "true" or "false" that specifies the type of gateway sender that <%=vars.product_name%> creates.</td> <td>false</td> </tr> <tr class="even"> @@ -277,7 +277,7 @@ When distributing region events from the local queue, multiple dispatcher thread <span class="keyword option">thread</span> When distributing region events from the local queue, multiple dispatcher threads preserve the order in which a given thread added region events to the queue. <span class="keyword option">partition</span> -When distributing region events from the local queue, multiple dispatcher threads preserve the order in which region events were added to the local queue. For a partitioned region, this means that all region events delivered to a specific partition are delivered in the same order to the remote Geode site. For a distributed region, this means that all key updates delivered to the local gateway sender queue are distributed to the remote site in the same order. +When distributing region events from the local queue, multiple dispatcher threads preserve the order in which region events were added to the local queue. For a partitioned region, this means that all region events delivered to a specific partition are delivered in the same order to the remote <%=vars.product_name%> site. For a distributed region, this means that all key updates delivered to the local gateway sender queue are distributed to the remote site in the same order. </div> <p>You cannot configure the <code class="ph codeph">order-policy</code> for a parallel event queue, because parallel queues cannot preserve event ordering for regions. Only the ordering of events for a given partition (or in a given queue of a distributed region) can be preserved.</p></td> <td>key</td> @@ -289,7 +289,7 @@ When distributing region events from the local queue, multiple dispatcher thread </tr> <tr class="odd"> <td>remote-distributed-system-id</td> -<td>Integer that uniquely identifies the remote Geode cluster to which this gateway sender will send region events. This value corresponds to the <code class="ph codeph">distributed-system-id</code> property specified in locators for the remote cluster. This attribute is required.</td> +<td>Integer that uniquely identifies the remote <%=vars.product_name%> cluster to which this gateway sender will send region events. This value corresponds to the <code class="ph codeph">distributed-system-id</code> property specified in locators for the remote cluster. This attribute is required.</td> <td>null</td> </tr> <tr class="even"> @@ -309,7 +309,7 @@ When distributing region events from the local queue, multiple dispatcher thread </tr> <tr class="odd"> <td>enable-batch-conflation</td> -<td>Boolean value that determines whether Geode should conflate messages.</td> +<td>Boolean value that determines whether <%=vars.product_name%> should conflate messages.</td> <td>false</td> </tr> <tr class="even"> @@ -324,12 +324,12 @@ When distributing region events from the local queue, multiple dispatcher thread </tr> <tr class="even"> <td>enable-persistence</td> -<td>Boolean value that determines whether Geode persists the gateway queue.</td> +<td>Boolean value that determines whether <%=vars.product_name%> persists the gateway queue.</td> <td>false</td> </tr> <tr class="odd"> <td>disk-store-name</td> -<td>Named disk store to use for storing the queue overflow, or for persisting the queue. If you specify a value, the named disk store must exist. If you specify a null value, Geode uses the default disk store for overflow and queue persistence.</td> +<td>Named disk store to use for storing the queue overflow, or for persisting the queue. If you specify a value, the named disk store must exist. If you specify a null value, <%=vars.product_name%> uses the default disk store for overflow and queue persistence.</td> <td>Â </td> </tr> <tr class="even"> @@ -344,7 +344,7 @@ When distributing region events from the local queue, multiple dispatcher thread </tr> <tr class="even"> <td>alert-threshold</td> -<td>Maximum number of milliseconds that a region event can remain in the gateway sender queue before Geode logs an alert.</td> +<td>Maximum number of milliseconds that a region event can remain in the gateway sender queue before <%=vars.product_name%> logs an alert.</td> <td>0</td> </tr> </tbody> @@ -416,7 +416,7 @@ Specify the Java class and its initialization parameters with the `<class-name>` ## <a id="gateway-transport-filter" class="no-quick-link"></a><gateway-transport-filter> -Use a GatewayTransportFilter implementation to process the TCP stream that sends a batch of events that is distributed from one Geode cluster to another over a WAN. A GatewayTransportFilter is typically used to perform encryption or compression on the data that distributed. You install the same GatewayTransportFilter implementation on both a gateway sender and gateway receiver. +Use a GatewayTransportFilter implementation to process the TCP stream that sends a batch of events that is distributed from one <%=vars.product_name%> cluster to another over a WAN. A GatewayTransportFilter is typically used to perform encryption or compression on the data that distributed. You install the same GatewayTransportFilter implementation on both a gateway sender and gateway receiver. Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](#class-name_parameter). @@ -434,7 +434,7 @@ Specify the Java class and its initialization parameters with the `<class-name>` ## <a id="gateway-receiver" class="no-quick-link"></a><gateway-receiver> -Configures a gateway receiver to receive and apply region events that were distributed from another Geode site. You can only specify one gateway receiver on a member. See [Configuring a Multi-site (WAN) System](../../topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html#setting_up_a_multisite_system). +Configures a gateway receiver to receive and apply region events that were distributed from another <%=vars.product_name%> site. You can only specify one gateway receiver on a member. See [Configuring a Multi-site (WAN) System](../../topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html#setting_up_a_multisite_system). **API:** `GatewayReceiverFactory`, `GatewayTransportFilter` @@ -457,14 +457,14 @@ Configures a gateway receiver to receive and apply region events that were distr <tbody> <tr class="odd"> <td>start-port</td> -<td><p>Starting port number to use when specifying the range of possible port numbers this gateway receiver will use to connects to gateway senders in other sites. Geode chooses an unused port number in the specified port number range to start the receiver. If no port numbers in the range are available, an exception is thrown.</p> -<p>The <code class="ph codeph">STARTPORT</code> value is inclusive while the <code class="ph codeph">ENDPORT</code> value is exclusive. For example, if you specify <code class="ph codeph">STARTPORT="50510"</code> and <code class="ph codeph">ENDPOINT="50520"</code>, Geode chooses a port value from 50510 to 50519.</p></td> +<td><p>Starting port number to use when specifying the range of possible port numbers this gateway receiver will use to connects to gateway senders in other sites. <%=vars.product_name%> chooses an unused port number in the specified port number range to start the receiver. If no port numbers in the range are available, an exception is thrown.</p> +<p>The <code class="ph codeph">STARTPORT</code> value is inclusive while the <code class="ph codeph">ENDPORT</code> value is exclusive. For example, if you specify <code class="ph codeph">STARTPORT="50510"</code> and <code class="ph codeph">ENDPOINT="50520"</code>, <%=vars.product_name%> chooses a port value from 50510 to 50519.</p></td> <td>5000</td> </tr> <tr class="even"> <td>end-port</td> -<td><p>Defines the upper bound port number to use when specifying the range of possible port numbers this gateway receiver will use to for connections from gateway senders in other sites. Geode chooses an unused port number in the specified port number range to start the receiver. If no port numbers in the range are available, an exception is thrown.</p> -<p>The <code class="ph codeph">ENDPORT</code> value is exclusive while the <code class="ph codeph">STARTPORT</code> value is inclusive. For example, if you specify <code class="ph codeph">STARTPORT="50510"</code> and <code class="ph codeph">ENDPOINT="50520"</code>, Geode chooses a port value from 50510 to 50519.</p></td> +<td><p>Defines the upper bound port number to use when specifying the range of possible port numbers this gateway receiver will use to for connections from gateway senders in other sites. <%=vars.product_name%> chooses an unused port number in the specified port number range to start the receiver. If no port numbers in the range are available, an exception is thrown.</p> +<p>The <code class="ph codeph">ENDPORT</code> value is exclusive while the <code class="ph codeph">STARTPORT</code> value is inclusive. For example, if you specify <code class="ph codeph">STARTPORT="50510"</code> and <code class="ph codeph">ENDPOINT="50520"</code>, <%=vars.product_name%> chooses a port value from 50510 to 50519.</p></td> <td>5500</td> </tr> <tr class="odd"> @@ -515,7 +515,7 @@ Configures a gateway receiver to receive and apply region events that were distr ## <a id="gateway-receiver_gateway-transport-filter" class="no-quick-link"></a><gateway-transport-filter> -Use a GatewayTransportFilter implementation to process the TCP stream that sends a batch of events that is distributed from one Geode cluster to another over a WAN. A GatewayTransportFilter is typically used to perform encryption or compression on the data that distributed. You install the same GatewayTransportFilter implementation on both a gateway sender and gateway receiver. +Use a GatewayTransportFilter implementation to process the TCP stream that sends a batch of events that is distributed from one <%=vars.product_name%> cluster to another over a WAN. A GatewayTransportFilter is typically used to perform encryption or compression on the data that distributed. You install the same GatewayTransportFilter implementation on both a gateway sender and gateway receiver. Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](#class-name_parameter). @@ -579,7 +579,7 @@ Configures a queue for sending region events to an AsyncEventListener implementa </tr> <tr class="even"> <td>parallel</td> -<td>Value of "true" or "false" that specifies the type of queue that Geode creates.</td> +<td>Value of "true" or "false" that specifies the type of queue that <%=vars.product_name%> creates.</td> <td>false</td> </tr> <tr class="odd"> @@ -594,12 +594,12 @@ Configures a queue for sending region events to an AsyncEventListener implementa </tr> <tr class="odd"> <td>enable-batch-conflation</td> -<td>Boolean value that determines whether Geode should conflate messages.</td> +<td>Boolean value that determines whether <%=vars.product_name%> should conflate messages.</td> <td>false</td> </tr> <tr class="even"> <td>disk-store-name</td> -<td>Named disk store to use for storing queue overflow, or for persisting the queue. If you specify a value, the named disk store must exist. If you specify a null value, Geode uses the default disk store for overflow and queue persistence.</td> +<td>Named disk store to use for storing queue overflow, or for persisting the queue. If you specify a value, the named disk store must exist. If you specify a null value, <%=vars.product_name%> uses the default disk store for overflow and queue persistence.</td> <td>null specifies the default disk store</td> </tr> <tr class="odd"> @@ -628,13 +628,13 @@ Configures a queue for sending region events to an AsyncEventListener implementa <ul> <li><strong>key</strong>. When distributing region events from the local queue, multiple dispatcher threads preserve the order of key updates.</li> <li><strong>thread</strong>. When distributing region events from the local queue, multiple dispatcher threads preserve the order in which a given thread added region events to the queue.</li> -<li><strong>partition</strong>. This option is valid for parallel event queues. When distributing region events from the local queue, multiple dispatcher threads preserve the order in which region events were added to the local queue. For a partitioned region, this means that all region events delivered to a specific partition are delivered in the same order to the remote Geode site. For a distributed region, this means that all key updates delivered to the local queue are distributed to the remote site in the same order.</li> +<li><strong>partition</strong>. This option is valid for parallel event queues. When distributing region events from the local queue, multiple dispatcher threads preserve the order in which region events were added to the local queue. For a partitioned region, this means that all region events delivered to a specific partition are delivered in the same order to the remote <%=vars.product_name%> site. For a distributed region, this means that all key updates delivered to the local queue are distributed to the remote site in the same order.</li> </ul></td> <td>key</td> </tr> <tr class="even"> <td>persistent</td> -<td>Boolean value that determines whether Geode persists this queue.</td> +<td>Boolean value that determines whether <%=vars.product_name%> persists this queue.</td> <td>False</td> </tr> </tbody> @@ -795,7 +795,7 @@ The `cacheserver` process uses only `cache.xml` configuration. For application s </tr> <tr class="odd"> <td>tcp-no-delay</td> -<td>When set to true, enables TCP_NODELAY for Geode server connections to clients.</td> +<td>When set to true, enables TCP_NODELAY for <%=vars.product_name%> server connections to clients.</td> <td>false</td> </tr> </tbody> @@ -850,7 +850,7 @@ Application plug-in used to provide current and predicted server load informatio Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](cache_xml.html#class-name_parameter). -**Default:** If this is not defined, the default Geode load probe is used. +**Default:** If this is not defined, the default <%=vars.product_name%> load probe is used. **API:** `org.apache.geode.cache.server.setLoadProbe` @@ -1259,7 +1259,7 @@ Specifies the configuration for the Portable Data eXchange (PDX) method of seria ## <a id="id_td2_ydq_rr" class="no-quick-link"></a><pdx-serializer> -Allows you to configure the PdxSerializer for this Geode member. +Allows you to configure the PdxSerializer for this <%=vars.product_name%> member. Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](cache_xml.html#class-name_parameter). @@ -1305,7 +1305,7 @@ Specifies a region attributes template that can be named (by `id`) and reference <tbody> <tr class="odd"> <td>concurrency-level</td> -<td>Gives an estimate of the maximum number of application threads that will concurrently access a region entry at one time. This attribute does not apply to partitioned regions. This attribute helps Geode optimize the use of system resources and reduce thread contention. This sets an initial parameter on the underlying <code class="ph codeph">java.util.ConcurrentHashMap</code> used for storing region entries. +<td>Gives an estimate of the maximum number of application threads that will concurrently access a region entry at one time. This attribute does not apply to partitioned regions. This attribute helps <%=vars.product_name%> optimize the use of system resources and reduce thread contention. This sets an initial parameter on the underlying <code class="ph codeph">java.util.ConcurrentHashMap</code> used for storing region entries. <div class="note note"> **Note:** <p>Before you modify this, read the concurrency level description, then see the Java API documentation for <code class="ph codeph">java.util.ConcurrentHashMap</code>.</p> @@ -1407,7 +1407,7 @@ Used only with GemFire version 6.x gateway configurations. For GemFire 7.0 confi </tr> <tr class="even"> <td>gateway-sender-ids</td> -<td><p>Specifies one or more gateway sender IDs to use for distributing region events to remote Geode sites. Specify multiple IDs as a comma-separated list.</p> +<td><p>Specifies one or more gateway sender IDs to use for distributing region events to remote <%=vars.product_name%> sites. Specify multiple IDs as a comma-separated list.</p> <p><strong>API:</strong> <code class="ph codeph">addGatewaySenderId</code></p> <p><strong>Example:</strong></p> <pre class="pre codeblock language-xml"><code><region-attributes @@ -1584,7 +1584,7 @@ Used only with GemFire version 6.x gateway configurations. For GemFire 7.0 confi <td><p>Definition: Determines how updates to region entries are distributed to the other caches in the distributed system where the region and entry are defined. Scope also determines whether to allow remote invocation of some of the regionâs event handlers, and whether to use region entry versions to provide consistent updates across replicated regions.</p> <div class="note note"> **Note:** -<p>You can configure the most common of these options with Geodeâs region shortccuts in <code class="ph codeph">RegionShortcut</code> and <code class="ph codeph">ClientRegionShortcut</code>.</p> +<p>You can configure the most common of these options with <%=vars.product_name%> region shortcuts in <code class="ph codeph">RegionShortcut</code> and <code class="ph codeph">ClientRegionShortcut</code>.</p> </div> <div class="note note"> **Note:** @@ -1622,7 +1622,7 @@ Used only with GemFire version 6.x gateway configurations. For GemFire 7.0 confi </tr> <tr class="even"> <td>statistics-enabled</td> -<td>Boolean specifying whether to gather statistics on the region. Must be true to use expiration on the region. Geode provides a standard set of statistics for cached regions and region entries, which give you information for fine-tuning your distributed system. Unlike other Geode statistics, statistics for local and distributed regions are not archived and cannot be charted. They are kept in instances of <code class="ph codeph">org.apache.geode.cache.CacheStatistics</code> and made available through the region and its entries through the <code class="ph codeph">Region.getStatistics</code> and <code class="ph codeph">Region.Entry.getStatistics</code> methods. +<td>Boolean specifying whether to gather statistics on the region. Must be true to use expiration on the region. <%=vars.product_name%> provides a standard set of statistics for cached regions and region entries, which give you information for fine-tuning your distributed system. Unlike other <%=vars.product_name%> statistics, statistics for local and distributed regions are not archived and cannot be charted. They are kept in instances of <code class="ph codeph">org.apache.geode.cache.CacheStatistics</code> and made available through the region and its entries through the <code class="ph codeph">Region.getStatistics</code> and <code class="ph codeph">Region.Entry.getStatistics</code> methods. <p><strong>API:</strong> <code class="ph codeph">setStatisticsEnabled</code></p> <p><strong>Example:</strong></p> <pre class="pre codeblock language-xml"><code><region-attributes @@ -1645,7 +1645,7 @@ Used only with GemFire version 6.x gateway configurations. For GemFire 7.0 confi <td><p>Determines whether members perform checks to provide consistent handling for concurrent or out-of-order updates to distributed regions. See [Consistency for Region Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045).</p> <div class="note note"> **Note:** -<p>Applications that use a <code class="ph codeph">client-cache</code> may want to disable concurrency checking in order to see all events for a region. Geode server members can continue using concurrency checks for the region, but they will pass all events to the client cache. This configuration ensures that the client sees all events, but it does not prevent the client cache from becoming out-of-sync with the server cache.</p> +<p>Applications that use a <code class="ph codeph">client-cache</code> may want to disable concurrency checking in order to see all events for a region. <%=vars.product_name%> server members can continue using concurrency checks for the region, but they will pass all events to the client cache. This configuration ensures that the client sees all events, but it does not prevent the client cache from becoming out-of-sync with the server cache.</p> </div> <p><strong>API:</strong> <code class="ph codeph">setConcurrencyChecksEnabled</code></p> <p><strong>Example:</strong></p> @@ -2209,7 +2209,7 @@ With the exception of `local-max-memory`, all members defining a partitioned reg | Attribute | Description | Default | |------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| | colocated-with | The full name of a region to colocate with this region. The named region must exist before this region is created. | null | -| local-max-memory | Maximum megabytes of memory set aside for this region in the local member. This is all memory used for this partitioned region - for primary buckets and any redundant copies. This value must be smaller than the Java settings for the initial or maximum JVM heap. When the memory use goes above this value, Geode issues a warning, but operation continues. Besides setting the maximum memory to use for the member, this setting also tells Geode how to balance the load between members where the region is defined. For example, if one member sets this value to twice the value of another memberâs setting, Geode works to keep the ratio between the first and the second at two-to-one, regardless of how little memory the region consumes. This is a local parameter that applies only to the local member. A value of 0 disables local data caching. | 90% (of local heap) | +| local-max-memory | Maximum megabytes of memory set aside for this region in the local member. This is all memory used for this partitioned region - for primary buckets and any redundant copies. This value must be smaller than the Java settings for the initial or maximum JVM heap. When the memory use goes above this value, <%=vars.product_name%> issues a warning, but operation continues. Besides setting the maximum memory to use for the member, this setting also tells <%=vars.product_name%> how to balance the load between members where the region is defined. For example, if one member sets this value to twice the value of another memberâs setting, <%=vars.product_name%> works to keep the ratio between the first and the second at two-to-one, regardless of how little memory the region consumes. This is a local parameter that applies only to the local member. A value of 0 disables local data caching. | 90% (of local heap) | | recovery-delay | Applies when `redundant-copies` is greater than zero. The number of milliseconds to wait after a member crashes before reestablishing redundancy for the region. A setting of -1 disables automatic recovery of redundancy after member failure. | -1 | | redundant-copies | Number of extra copies that the partitioned region must maintain for each entry. Range: 0-3. If you specify 1, this partitioned region maintains the original and one backup, for a total of two copies. A value of 0 disables redundancy. | 0 | | startup-recovery-delay | Applies when `redundant-copies` is greater than zero. The number of milliseconds a newly started member should wait before trying to satisfy redundancy of region data stored on other members. A setting of -1 disables automatic recovery of redundancy after new members join. | 0 | @@ -2527,7 +2527,7 @@ An event-handler plug-in that allows you to receive before-event notification fo ## <a id="id_xt4_m2q_rr" class="no-quick-link"></a><cache-listener> -An event-handler plug-in that receives after-event notification of changes to the region and its entries. Any number of cache listeners can be defined for a region in any member. Geode offers several listener types with callbacks to handle data and process events. Depending on the `data-policy` and the `interest-policy` subscription attributes, a cache listener may receive only events that originate in the local cache, or it may receive those events along with events that originate remotely. +An event-handler plug-in that receives after-event notification of changes to the region and its entries. Any number of cache listeners can be defined for a region in any member. <%=vars.product_name%> offers several listener types with callbacks to handle data and process events. Depending on the `data-policy` and the `interest-policy` subscription attributes, a cache listener may receive only events that originate in the local cache, or it may receive those events along with events that originate remotely. Specify the Java class for the cache listener and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](cache_xml.html#class-name_parameter). @@ -2564,7 +2564,7 @@ A compressor registers a custom class that extends `Compressor` to support compr ## <a id="id_kc4_n2q_rr" class="no-quick-link"></a><eviction-attributes> -Specifies whether and how to control a regionâs size. Size is controlled by removing least recently used (LRU) entries to make space for new ones. This may be done through destroy or overflow actions. You can configure your region for lru-heap-percentage with an eviction action of local-destroy using Geodeâs stored region attributes. +Specifies whether and how to control a regionâs size. Size is controlled by removing least recently used (LRU) entries to make space for new ones. This may be done through destroy or overflow actions. You can configure your region for lru-heap-percentage with an eviction action of local-destroy using stored region attributes. **Default:** Uses the lru-entry-count algorithm. @@ -2634,7 +2634,7 @@ Using the maximum attribute, specifies maximum region capacity based on entry co ## <a id="id_gpn_42q_rr" class="no-quick-link"></a><lru-heap-percentage> -Runs evictions when the Geode resource manager says to. The manager orders evictions when the total cache size is over the heap percentage limit specified in the manager configuration. You can declare a Java class that implements the ObjectSizer interface to measure the size of objects in the Region. +Runs evictions when the <%=vars.product_name%> resource manager says to. The manager orders evictions when the total cache size is over the heap percentage limit specified in the manager configuration. You can declare a Java class that implements the ObjectSizer interface to measure the size of objects in the Region. Specify the Java class and its initialization parameters with the `<class-name>` and `<parameter>` sub-elements. See [<class-name> and <parameter>](cache_xml.html#class-name_parameter). @@ -2771,7 +2771,7 @@ Specifies the binding for a data-source used in transaction management. See [Con ## <a id="id_jrf_q2q_rr" class="no-quick-link"></a><jndi-binding> -For every datasource that is bound to the JNDI tree, there should be one `<jndi-binding>` element. This element describes the property and the configuration of the datasource. Geode uses the attributes of the `<jndi-binding>` element for configuration. Use the `<config-property>` element to configure properties for the datasource. +For every datasource that is bound to the JNDI tree, there should be one `<jndi-binding>` element. This element describes the property and the configuration of the datasource. <%=vars.product_name%> uses the attributes of the `<jndi-binding>` element for configuration. Use the `<config-property>` element to configure properties for the datasource. We recommend that you set the username and password with the `user-name` and `password` jndi-binding attributes rather than using the `<config-property>` element. @@ -2828,7 +2828,7 @@ We recommend that you set the username and password with the `user-name` and `pa </tr> <tr class="odd"> <td>jndi-name</td> -<td>The <code class="ph codeph">jndi-name</code> attribute is the key binding parameter. If the value of jndi-name is a DataSource, it is bound as java:/myDatabase, where myDatabase is the name you assign to your data source. If the data source cannot be bound to JNDI at runtime, Geode logs a warning.</td> +<td>The <code class="ph codeph">jndi-name</code> attribute is the key binding parameter. If the value of jndi-name is a DataSource, it is bound as java:/myDatabase, where myDatabase is the name you assign to your data source. If the data source cannot be bound to JNDI at runtime, <%=vars.product_name%> logs a warning.</td> <td>Â </td> </tr> <tr class="even"> @@ -2862,7 +2862,7 @@ We recommend that you set the username and password with the `user-name` and `pa <tbody> <tr class="odd"> <td>XATransaction</td> -<td>Select this option when you want to use a<span class="keyword apiname">ManagedConnection</span> interface with a Java Transaction Manager to define transaction boundries. This option allows a <span class="keyword apiname">ManagedDataSource</span> to participate in a transaction with a Geode cache.</td> +<td>Select this option when you want to use a<span class="keyword apiname">ManagedConnection</span> interface with a Java Transaction Manager to define transaction boundries. This option allows a <span class="keyword apiname">ManagedDataSource</span> to participate in a transaction with a <%=vars.product_name%> cache.</td> </tr> <tr class="even"> <td>NoTransaction</td> @@ -3276,7 +3276,7 @@ Set of serializer or instantiator tags to register customer DataSerializer exten ## <a id="id_jsk_y2q_rr" class="no-quick-link"></a><serializer> -Allows you to configure the DataSerializer for this Geode member. It registers a custom class which extends DataSerializer to support custom serialization of non-modifiable object types inside Geode. +Allows you to configure the DataSerializer for this <%=vars.product_name%> member. It registers a custom class which extends DataSerializer to support custom serialization of non-modifiable object types inside <%=vars.product_name%>. Specify the Java class for the `DataSerializer` and its initialization parameters with the `<class-name>` sub-element. @@ -3284,7 +3284,7 @@ Specify the Java class for the `DataSerializer` and its initialization parameter ## <a id="id_p5t_y2q_rr" class="no-quick-link"></a><instantiator> -An Instantiator registers a custom class which implements the `DataSerializable` interface to support custom object serialization inside Geode. +An Instantiator registers a custom class which implements the `DataSerializable` interface to support custom object serialization inside <%=vars.product_name%>. Specify the Java class and its initialization parameters with the `<class-name>` sub-element. http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/handling_exceptions_and_failures.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/handling_exceptions_and_failures.html.md.erb b/geode-docs/reference/topics/handling_exceptions_and_failures.html.md.erb index 8d46db5..45fc7eb 100644 --- a/geode-docs/reference/topics/handling_exceptions_and_failures.html.md.erb +++ b/geode-docs/reference/topics/handling_exceptions_and_failures.html.md.erb @@ -19,14 +19,14 @@ See the License for the specific language governing permissions and limitations under the License. --> -Your application needs to catch certain classes to handle all the exceptions and system failures thrown by Apache Geode. +Your application needs to catch certain classes to handle all the exceptions and system failures thrown by <%=vars.product_name_long%>. -- `GemFireCheckedException`. This class is the abstract superclass of exceptions that are thrown and declared. Wherever possible, GemFire exceptions are checked exceptions. `GemFireCheckedException` is a Geode version of `java.lang.Exception`. -- `GemFireException`. This class is the abstract superclass of unchecked exceptions that are thrown to indicate conditions for which the developer should not normally need to check. You can look at the subclasses of `GemFireException` to see all the runtime exceptions in the GemFire system; see the class hierarchy in the online Java API documentation. `GemFireException` is a Geode version of java.lang.`RuntimeException`. You can also look at the method details in the `Region` API javadocs for Geode exceptions you may want to catch. -- `SystemFailure`. In addition to exception management, Geode provides a class to help you manage catastrophic failure in your distributed system, particularly in your application. The Javadocs for this class provide extensive guidance for managing failures in your system and your application. See `SystemFailure` in the `org.apache.geode` package. +- `GemFireCheckedException`. This class is the abstract superclass of exceptions that are thrown and declared. Wherever possible, GemFire exceptions are checked exceptions. `GemFireCheckedException` is a <%=vars.product_name%> version of `java.lang.Exception`. +- `GemFireException`. This class is the abstract superclass of unchecked exceptions that are thrown to indicate conditions for which the developer should not normally need to check. You can look at the subclasses of `GemFireException` to see all the runtime exceptions in the GemFire system; see the class hierarchy in the online Java API documentation. `GemFireException` is a <%=vars.product_name%> version of java.lang.`RuntimeException`. You can also look at the method details in the `Region` API javadocs for <%=vars.product_name%> exceptions you may want to catch. +- `SystemFailure`. In addition to exception management, <%=vars.product_name%> provides a class to help you manage catastrophic failure in your distributed system, particularly in your application. The Javadocs for this class provide extensive guidance for managing failures in your system and your application. See `SystemFailure` in the `org.apache.geode` package. To see the exceptions thrown by a specific method, refer to the method's online Java documentation. -A Geode system member can also throw exceptions generated by third-party software such as JGroups or `java.lang` classes. For assistance in handling these exceptions, see the vendor documentation. +A <%=vars.product_name%> system member can also throw exceptions generated by third-party software such as JGroups or `java.lang` classes. For assistance in handling these exceptions, see the vendor documentation. http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/memory_requirements_for_cache_data.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/memory_requirements_for_cache_data.html.md.erb b/geode-docs/reference/topics/memory_requirements_for_cache_data.html.md.erb index 150814a..4fa57d9 100644 --- a/geode-docs/reference/topics/memory_requirements_for_cache_data.html.md.erb +++ b/geode-docs/reference/topics/memory_requirements_for_cache_data.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode solutions architects need to estimate resource requirements for meeting application performance, scalability and availability goals. +<%=vars.product_name%> solutions architects need to estimate resource requirements for meeting application performance, scalability and availability goals. These requirements include estimates for the following resources: @@ -27,12 +27,12 @@ These requirements include estimates for the following resources: - number of machines - network bandwidth -The information here is only a guideline, and assumes a basic understanding of Geode. While no two applications or use cases are exactly alike, the information here should be a solid starting point, based on real-world experience. Much like with physical database design, ultimately the right configuration and physical topology for deployment is based on the performance requirements, application data access characteristics, and resource constraints (i.e., memory, CPU, and network bandwidth) of the operating environment. +The information here is only a guideline, and assumes a basic understanding of <%=vars.product_name%>. While no two applications or use cases are exactly alike, the information here should be a solid starting point, based on real-world experience. Much like with physical database design, ultimately the right configuration and physical topology for deployment is based on the performance requirements, application data access characteristics, and resource constraints (i.e., memory, CPU, and network bandwidth) of the operating environment. <a id="topic_ipt_dqz_j4"></a> -# Core Guidelines for Geode Data Region Design +# Core Guidelines for <%=vars.product_name%> Data Region Design The following guidelines apply to region design: @@ -46,9 +46,9 @@ The following guidelines apply to region design: The following guidelines should provide a rough estimate of the amount of memory consumed by your system. -Memory calculation about keys and entries (objects) and region overhead for them can be divided by the number of members of the distributed system for data placed in partitioned regions only. For other regions, the calculation is for each member that hosts the region. Memory used by sockets, threads, and the small amount of application overhead for Geode is per member. +Memory calculation about keys and entries (objects) and region overhead for them can be divided by the number of members of the distributed system for data placed in partitioned regions only. For other regions, the calculation is for each member that hosts the region. Memory used by sockets, threads, and the small amount of application overhead for <%=vars.product_name%> is per member. -For each entry added to a region, the Geode cache API consumes a certain amount of memory to store and manage the data. This overhead is required even when an entry is overflowed or persisted to disk. Thus objects on disk take up some JVM memory, even when they are paged to disk. The Java cache overhead introduced by a region, using a 32-bit JVM, can be approximated as listed below. +For each entry added to a region, the <%=vars.product_name%> cache API consumes a certain amount of memory to store and manage the data. This overhead is required even when an entry is overflowed or persisted to disk. Thus objects on disk take up some JVM memory, even when they are paged to disk. The Java cache overhead introduced by a region, using a 32-bit JVM, can be approximated as listed below. Actual memory use varies based on a number of factors, including the JVM you are using and the platform you are running on. For 64-bit JVMs, the usage will usually be larger than with 32-bit JVMs. As much as 80% more memory may be required for 64-bit JVMs, due to object references and headers using more memory. @@ -56,7 +56,7 @@ There are several additional considerations for calculating your memory requirem - **Size of your stored data.** To estimate the size of your stored data, determine first whether you are storing the data in serialized or non-serialized form. In general, the non-serialized form will be the larger of the two. See [Determining Object Serialization Overhead](#topic_psn_5tz_j4) - Objects in Geode are serialized for storage into partitioned regions and for all distribution activities, including moving data to disk for overflow and persistence. For optimum performance, Geode tries to reduce the number of times an object is serialized and deserialized, so your objects may be stored in serialized or non-serialized form in the cache. + Objects in <%=vars.product_name%> are serialized for storage into partitioned regions and for all distribution activities, including moving data to disk for overflow and persistence. For optimum performance, <%=vars.product_name%> tries to reduce the number of times an object is serialized and deserialized, so your objects may be stored in serialized or non-serialized form in the cache. - **Application object overhead for your data.** When calculating application overhead, make sure to count the key as well as the value, and to count every object if the key and/or value is a composite object. @@ -105,7 +105,7 @@ Keys are stored in object form except for certain classes where the storage of k **When to disable inline key storage.** In some cases, storing keys inline may introduce extra memory or CPU usage. If all of your keys are also referenced from some other object, then it is better to not inline the key. If you frequently ask for the key from the region, then you may want to keep the object form stored in the cache so that you do not need to recreate the object form constantly. Note that the basic operation of checking whether a key is in a region does not require the object form but uses the inline primitive data. -The key inlining feature can be disabled by specifying the following Geode property upon member startup: +The key inlining feature can be disabled by specifying the following <%=vars.product_name%> property upon member startup: ``` pre -Dgemfire.DISABLE_INLINE_REGION_KEYS=true @@ -180,19 +180,19 @@ The other index overhead estimates listed here also apply to Lucene indexes. ## <a id="topic_i1m_stz_j4" class="no-quick-link"></a>Estimating Management and Monitoring Overhead -Geode's JMX management and monitoring system contributes to memory overhead and should be accounted for when establishing the memory requirements for your deployment. Specifically, the memory footprint of any processes (such as locators) that are running as JMX managers can increase. +The <%=vars.product_name%> JMX management and monitoring system contributes to memory overhead and should be accounted for when establishing the memory requirements for your deployment. Specifically, the memory footprint of any processes (such as locators) that are running as JMX managers can increase. For each resource in the distributed system that is being managed and monitored by the JMX Manager (for example, each MXBean such as MemberMXBean, RegionMXBean, DiskStoreMXBean, LockServiceMXBean and so on), you should add 10 KB of required memory to the JMX Manager node. ## <a id="topic_psn_5tz_j4" class="no-quick-link"></a>Determining Object Serialization Overhead -Geode PDX serialization can provide significant space savings over Java Serializable in addition to better performance. In some cases we have seen savings of up to 65%, but the savings will vary depending on the domain objects. PDX serialization is most likely to provide the most space savings of all available options. DataSerializable is more compact, but it requires that objects are deserialized on access, so that should be taken into account. On the other hand, PDX serializable does not require deserialization for most operations, and because of that, it may provide greater space savings. +<%=vars.product_name%> PDX serialization can provide significant space savings over Java Serializable in addition to better performance. In some cases we have seen savings of up to 65%, but the savings will vary depending on the domain objects. PDX serialization is most likely to provide the most space savings of all available options. DataSerializable is more compact, but it requires that objects are deserialized on access, so that should be taken into account. On the other hand, PDX serializable does not require deserialization for most operations, and because of that, it may provide greater space savings. -In any case, the kinds and volumes of operations that would be done on the server side should be considered in the context of data serialization, as Geode has to deserialize data for some types of operations (access). For example, if a function invokes a get operation on the server side, the value returned from the get operation will be deserialized in most cases (the only time it will not be deserialized is when PDX serialization is used and the read-serialized attribute is set). The only way to find out the actual overhead is by running tests, and examining the memory usage. +In any case, the kinds and volumes of operations that would be done on the server side should be considered in the context of data serialization, as <%=vars.product_name%> has to deserialize data for some types of operations (access). For example, if a function invokes a get operation on the server side, the value returned from the get operation will be deserialized in most cases (the only time it will not be deserialized is when PDX serialization is used and the read-serialized attribute is set). The only way to find out the actual overhead is by running tests, and examining the memory usage. Some additional serialization guidelines and tips: -- If you are using compound objects, do not mix using standard Java serialization with with Geode serialization (either DataSerializable or PDX). Standard Java serialization functions correctly when mixed with Geode serialization, but it can end up producing many more serialized bytes. +- If you are using compound objects, do not mix using standard Java serialization with with <%=vars.product_name%> serialization (either DataSerializable or PDX). Standard Java serialization functions correctly when mixed with <%=vars.product_name%> serialization, but it can end up producing many more serialized bytes. To determine if you are using standard Java serialization, specify the `-DDataSerializer.DUMP_SERIALIZED=true` upon process execution. Then check your log for messages of this form: @@ -224,7 +224,7 @@ A note of caution-- if the domain object contains many domain objects as member Servers always maintain two outgoing connections to each of their peers. So for each peer a server has, there are four total connections: two going out to the peer and two coming in from the peer. -The server threads that service client requests also communicate with peers to distribute events and forward client requests. If the server's Geode connection property *conserve-sockets* is set to true (the default), these threads use the already-established peer connections for this communication. +The server threads that service client requests also communicate with peers to distribute events and forward client requests. If the server's <%=vars.product_name%> connection property *conserve-sockets* is set to true (the default), these threads use the already-established peer connections for this communication. If *conserve-sockets* is false, each thread that services clients establishes two of its own individual connections to its server peers, one to send, and one to receive. Each socket uses a file descriptor, so the number of available sockets is governed by two operating system settings: @@ -236,7 +236,7 @@ In servers with many threads servicing clients, if *conserve-sockets* is set to Since each client connection takes one server socket on a thread to handle the connection, and since that server acts as a proxy on partitioned regions to get results, or execute the function service on behalf of the client, for partitioned regions, if conserve sockets is set to false, this also results in a new socket on the server being opened to each peer. Thus N sockets are opened, where N is the number of peers. Large number of clients simultaneously connecting to a large set of peers with a partitioned region with conserve sockets set to false can cause a huge amount of memory to be consumed by socket. Set conserve-sockets to true in these instances. **Note:** -There is also JVM overhead for the thread stack for each client connection being processed, set at 256KB or 512KB for most JVMs . On some JVMs you can reduce it to 128KB. You can use the Geode `max-threads` property or the Geode `max-connections` property to limit the number of client threads and thus both thread overhead and socket overhead. +There is also JVM overhead for the thread stack for each client connection being processed, set at 256KB or 512KB for most JVMs . On some JVMs you can reduce it to 128KB. You can use the <%=vars.product_name%> `max-threads` property or the <%=vars.product_name%> `max-connections` property to limit the number of client threads and thus both thread overhead and socket overhead. The following table lists the memory requirements based on connections. @@ -286,7 +286,7 @@ The following table lists the memory requirements based on connections. <td>1 MB +</td> </tr> <tr class="even"> -<td><strong>Geode classes and JVM overhead</strong></td> +<td><strong><%=vars.product_name%> classes and JVM overhead</strong></td> <td>Roughly 50MB</td> </tr> <tr class="odd"> @@ -300,4 +300,4 @@ The following table lists the memory requirements based on connections. </tbody> </table> -<a id="topic_eww_rvz_j4"></a> + http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/non-ascii_strings_in_config_files.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/non-ascii_strings_in_config_files.html.md.erb b/geode-docs/reference/topics/non-ascii_strings_in_config_files.html.md.erb index 1f4e091..045140a 100644 --- a/geode-docs/reference/topics/non-ascii_strings_in_config_files.html.md.erb +++ b/geode-docs/reference/topics/non-ascii_strings_in_config_files.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Using Non-ASCII Strings in Apache Geode Property Files ---- +<% set_title("Using Non-ASCII Strings in", product_name_long, "Property Files") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,7 +17,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -You can specify Unicode (non-ASCII) characters in Apache Geode property files by using a `\uXXXX` escape sequence. +You can specify Unicode (non-ASCII) characters in <%=vars.product_name_long%> property files by using a `\uXXXX` escape sequence. For a supplementary character, you need two escape sequences, one for each of the two UTF-16 code units. The XXXX denotes the 4 hexadecimal digits for the value of the UTF-16 code unit. For example, a properties file might have the following entries: http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb b/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb index dfdaa39..1535bfa 100644 --- a/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb +++ b/geode-docs/reference/topics/region_shortcuts_reference.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -This topic describes the various region shortcuts you can use to configure Geode regions. +This topic describes the various region shortcuts you can use to configure <%=vars.product_name%> regions. ## <a id="reference_w2h_3cd_lk" class="no-quick-link"></a>LOCAL
