You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2017/08/14 22:23:29 UTC
[1/5] geode git commit: GEODE-3395 Variable-ize product version and
name in user guide - Reference section
Repository: geode
Updated Branches:
refs/heads/develop c1129c7ab -> 13ad4b6e0
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
[5/5] geode git commit: GEODE-3395 Variable-ize product version and
name in user guide - Reference section
Posted by db...@apache.org.
GEODE-3395 Variable-ize product version and name in user guide - Reference section
Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/13ad4b6e
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/13ad4b6e
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/13ad4b6e
Branch: refs/heads/develop
Commit: 13ad4b6e07d80cd9961f6fbd634213c462315073
Parents: c1129c7
Author: Dave Barnes <db...@pivotal.io>
Authored: Mon Aug 14 15:22:16 2017 -0700
Committer: Dave Barnes <db...@pivotal.io>
Committed: Mon Aug 14 15:22:58 2017 -0700
----------------------------------------------------------------------
geode-book/Gemfile.lock | 2 +-
.../source/subnavs/geode-subnav.erb | 54 +-
.../how_region_versioning_works.html.md.erb | 4 +-
.../disk_free_space_monitoring.html.md.erb | 2 +-
.../heap_use/off_heap_management.html.md.erb | 2 +-
.../region_compression.html.md.erb | 2 +-
geode-docs/reference/book_intro.html.md.erb | 20 +-
.../statistics/statistics_list.html.md.erb | 1310 ------------------
.../reference/statistics_list.html.md.erb | 1310 ++++++++++++++++++
.../topics/cache-elements-list.html.md.erb | 4 +-
.../reference/topics/cache_xml.html.md.erb | 50 +-
.../chapter_overview_cache_xml.html.md.erb | 8 +-
...chapter_overview_regionshortcuts.html.md.erb | 54 +-
.../client-cache-elements-list.html.md.erb | 2 +-
.../reference/topics/client-cache.html.md.erb | 42 +-
.../topics/gemfire_properties.html.md.erb | 46 +-
.../reference/topics/gfe_cache_xml.html.md.erb | 78 +-
...handling_exceptions_and_failures.html.md.erb | 10 +-
...mory_requirements_for_cache_data.html.md.erb | 30 +-
...on-ascii_strings_in_config_files.html.md.erb | 6 +-
.../region_shortcuts_reference.html.md.erb | 2 +-
21 files changed, 1516 insertions(+), 1522 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-book/Gemfile.lock
----------------------------------------------------------------------
diff --git a/geode-book/Gemfile.lock b/geode-book/Gemfile.lock
index 5f6b59a..232c3b3 100644
--- a/geode-book/Gemfile.lock
+++ b/geode-book/Gemfile.lock
@@ -198,7 +198,7 @@ PLATFORMS
ruby
DEPENDENCIES
- bookbindery
+ bookbindery (= 10.1.7)
libv8 (= 3.16.14.7)
BUNDLED WITH
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-book/master_middleman/source/subnavs/geode-subnav.erb
----------------------------------------------------------------------
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 52e31a7..838b265 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -2997,86 +2997,86 @@ gfsh</a>
<a href="/docs/guide/12/reference/topics/memory_requirements_for_cache_data.html">Memory Requirements for Cached Data</a>
</li>
<li class="has_submenu">
- <a href="/docs/guide/12/reference/statistics/statistics_list.html">Geode Statistics List</a>
+ <a href="/docs/guide/12/reference/statistics_list.html">Geode Statistics List</a>
<ul>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_DEF8D3644D3246AB8F06FE09A37DC5C8">Cache Performance (CachePerfStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_DEF8D3644D3246AB8F06FE09A37DC5C8">Cache Performance (CachePerfStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_EF5C2C59BFC74FFB8607F9571AB9A471">Cache Server (CacheServerStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_EF5C2C59BFC74FFB8607F9571AB9A471">Cache Server (CacheServerStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_B08C0783BBF9489E8BB48B4AEC597C62">Client-Side Notifications (CacheClientUpdaterStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_B08C0783BBF9489E8BB48B4AEC597C62">Client-Side Notifications (CacheClientUpdaterStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_04B7D7387E584712B7710B5ED1E876BB">Client-to-Server Messaging Performance (ClientStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_04B7D7387E584712B7710B5ED1E876BB">Client-to-Server Messaging Performance (ClientStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_6C247F61DB834C079A16BE92789D4692">Client Connection Pool (PoolStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_6C247F61DB834C079A16BE92789D4692">Client Connection Pool (PoolStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_66C0E7748501480B85209D57D24256D5">Continuous Querying (CQStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_66C0E7748501480B85209D57D24256D5">Continuous Querying (CQStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_D4ABED3FF94245C0BEE0F6FC9481E867">Delta Propagation (DeltaPropagationStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_D4ABED3FF94245C0BEE0F6FC9481E867">Delta Propagation (DeltaPropagationStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_6C2BECC63A83456190B029DEDB8F4BE3">Disk Space Usage (DiskDirStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_6C2BECC63A83456190B029DEDB8F4BE3">Disk Space Usage (DiskDirStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_983BFC6D53C74829A04A91C39E06315F">Disk Usage and Performance (DiskRegionStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_983BFC6D53C74829A04A91C39E06315F">Disk Usage and Performance (DiskRegionStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_ACB4161F10D64BC0B15871D003FF6FDF">Distributed System Messaging (DistributionStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_ACB4161F10D64BC0B15871D003FF6FDF">Distributed System Messaging (DistributionStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_78D346A580724E1EA645E31626EECE40">Distributed Lock Services (DLockStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_78D346A580724E1EA645E31626EECE40">Distributed Lock Services (DLockStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_5E212DDB0E8640689AD0A4659512E17A">Function Execution (FunctionServiceStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_5E212DDB0E8640689AD0A4659512E17A">Function Execution (FunctionServiceStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_C4199A541B1F4B82B6178C416C0FAE4B">Gateway Queue (GatewayStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_C4199A541B1F4B82B6178C416C0FAE4B">Gateway Queue (GatewayStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_86A61860024B480592DAC67FFB882538">Indexes (IndexStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_86A61860024B480592DAC67FFB882538">Indexes (IndexStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_607C3867602E410CAE5FAB26A7FF1CB9">JVM Performance</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_607C3867602E410CAE5FAB26A7FF1CB9">JVM Performance</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_C48B654F973E4B44AD825D459C23A6CD">Locator (LocatorStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_C48B654F973E4B44AD825D459C23A6CD">Locator (LocatorStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#LuceneStats">Lucene Indexes (LuceneIndexStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#LuceneStats">Lucene Indexes (LuceneIndexStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#topic_ohc_tjk_w5">Off-Heap (OffHeapMemoryStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#topic_ohc_tjk_w5">Off-Heap (OffHeapMemoryStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_923B28F01BC3416786D3AFBD87F22A5E">Operating System Statistics - Linux</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_923B28F01BC3416786D3AFBD87F22A5E">Operating System Statistics - Linux</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_35AC170770C944C3A336D9AEC2D2F7C5">Partitioned Regions (PartitionedRegion<partitioned_region_name>Statistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_35AC170770C944C3A336D9AEC2D2F7C5">Partitioned Regions (PartitionedRegion<partitioned_region_name>Statistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_374FBD92A3B74F6FA08AA23047929B4F">Region Entry Eviction – Count-Based (LRUStatistics)
+ <a href="/docs/guide/12/reference/statistics_list.html#section_374FBD92A3B74F6FA08AA23047929B4F">Region Entry Eviction – Count-Based (LRUStatistics)
</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_3D2AA2BCE5B6485699A7B6ADD1C49FF7">Region Entry Eviction – Size-based (LRUStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_3D2AA2BCE5B6485699A7B6ADD1C49FF7">Region Entry Eviction – Size-based (LRUStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_5362EF9AECBC48D69475697109ABEDFA">Server Notifications for All Clients (CacheClientNotifierStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_5362EF9AECBC48D69475697109ABEDFA">Server Notifications for All Clients (CacheClientNotifierStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_E03865F509E543D9B8F9462B3DA6255E">Server Notifications for Single Client (CacheClientProxyStatistics)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_E03865F509E543D9B8F9462B3DA6255E">Server Notifications for Single Client (CacheClientProxyStatistics)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_3AB1C0AA55014163A2BBF68E13D25E3A">Server-to-Client Messaging Performance (ClientSubscriptionStats)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_3AB1C0AA55014163A2BBF68E13D25E3A">Server-to-Client Messaging Performance (ClientSubscriptionStats)</a>
</li>
<li>
- <a href="/docs/guide/12/reference/statistics/statistics_list.html#section_55F3AF6413474317902845EE4996CC21">Statistics Collection (StatSampler)</a>
+ <a href="/docs/guide/12/reference/statistics_list.html#section_55F3AF6413474317902845EE4996CC21">Statistics Collection (StatSampler)</a>
</li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/developing/distributed_regions/how_region_versioning_works.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/developing/distributed_regions/how_region_versioning_works.html.md.erb b/geode-docs/developing/distributed_regions/how_region_versioning_works.html.md.erb
index c8b98f7..9911d31 100644
--- a/geode-docs/developing/distributed_regions/how_region_versioning_works.html.md.erb
+++ b/geode-docs/developing/distributed_regions/how_region_versioning_works.html.md.erb
@@ -75,7 +75,7 @@ A Geode member or client that receives an update message first compares the upda
An identical version stamp indicates that multiple Geode members updated the same entry at the same time. To resolve a concurrent update, a Geode member always applies (or keeps) the region entry that has the highest membership ID; the region entry having the lower membership ID is discarded.
**Note:**
-When a Geode member discards an update message (either for an out-of-order update or when resolving a concurrent update), it does not pass the discarded event to an event listener for the region. You can track the number of discarded updates for each member using the `conflatedEvents` statistic. See [Geode Statistics List](../../reference/statistics/statistics_list.html#statistics_list). Some members may discard an update while other members apply the update, depending on the order in which each member receives the update. For this reason, the `conflatedEvents` statistic differs for each Geode member. The example below describes this behavior in more detail.
+When a Geode member discards an update message (either for an out-of-order update or when resolving a concurrent update), it does not pass the discarded event to an event listener for the region. You can track the number of discarded updates for each member using the `conflatedEvents` statistic. See [Geode Statistics List](../../reference/statistics_list.html#statistics_list). Some members may discard an update while other members apply the update, depending on the order in which each member receives the update. For this reason, the `conflatedEvents` statistic differs for each Geode member. The example below describes this behavior in more detail.
The following example shows how a concurrent update is handled in a distributed system of three Geode members. Assume that Members A, B, and C have membership IDs of 1, 2, and 3, respectively. Each member currently stores an entry, X, in their caches at version C2 (the entry was last updated by member C):
@@ -110,7 +110,7 @@ A tombstone for a replicated or partitioned region expires after 10 minutes. Exp
**Note:**
To avoid out-of-memory errors, a Geode member also initiates garbage collection for tombstones when the amount of free memory drops below 30 percent of total memory.
-You can monitor the total number of tombstones in a cache using the `tombstoneCount` statistic in `CachePerfStats`. The `tombstoneGCCount` statistic records the total number of tombstone garbage collection cycles that a member has performed. `replicatedTombstonesSize` and `nonReplicatedTombstonesSize` show the approximate number of bytes that are currently consumed by tombstones in replicated or partitioned regions, and in non-replicated regions, respectively. See [Geode Statistics List](../../reference/statistics/statistics_list.html#statistics_list).
+You can monitor the total number of tombstones in a cache using the `tombstoneCount` statistic in `CachePerfStats`. The `tombstoneGCCount` statistic records the total number of tombstone garbage collection cycles that a member has performed. `replicatedTombstonesSize` and `nonReplicatedTombstonesSize` show the approximate number of bytes that are currently consumed by tombstones in replicated or partitioned regions, and in non-replicated regions, respectively. See [Geode Statistics List](../../reference/statistics_list.html#statistics_list).
## <a id="topic_321B05044B6641FCAEFABBF5066BD399__section_4D0140E96A3141EB8D983D0A43464097" class="no-quick-link"></a>About Region.clear() Operations
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/managing/disk_storage/disk_free_space_monitoring.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/managing/disk_storage/disk_free_space_monitoring.html.md.erb b/geode-docs/managing/disk_storage/disk_free_space_monitoring.html.md.erb
index 837ac25..0fef3d3 100644
--- a/geode-docs/managing/disk_storage/disk_free_space_monitoring.html.md.erb
+++ b/geode-docs/managing/disk_storage/disk_free_space_monitoring.html.md.erb
@@ -52,6 +52,6 @@ You can obtain statistics on disk space usage and the performance of disk space
- `volumeFreeSpaceChecks`
- `volumeFreeSpaceTime`
-See [Disk Space Usage (DiskDirStatistics)](../../reference/statistics/statistics_list.html#section_6C2BECC63A83456190B029DEDB8F4BE3).
+See [Disk Space Usage (DiskDirStatistics)](../../reference/statistics_list.html#section_6C2BECC63A83456190B029DEDB8F4BE3).
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/managing/heap_use/off_heap_management.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/managing/heap_use/off_heap_management.html.md.erb b/geode-docs/managing/heap_use/off_heap_management.html.md.erb
index 05f33e1..3e1515d 100644
--- a/geode-docs/managing/heap_use/off_heap_management.html.md.erb
+++ b/geode-docs/managing/heap_use/off_heap_management.html.md.erb
@@ -189,7 +189,7 @@ For example:
## <a id="managing-off-heap-memory__section_o4s_tg5_gv" class="no-quick-link"></a>Tuning Off-heap Memory Usage
-Geode collects statistics on off-heap memory usage which you can view with the gfsh `show metrics` command. See [Off-Heap (OffHeapMemoryStats)](../../reference/statistics/statistics_list.html#topic_ohc_tjk_w5) for a description of available off-heap statistics.
+Geode collects statistics on off-heap memory usage which you can view with the gfsh `show metrics` command. See [Off-Heap (OffHeapMemoryStats)](../../reference/statistics_list.html#topic_ohc_tjk_w5) for a description of available off-heap statistics.
Off-heap memory is optimized, by default, for storing values of 128 KB in size. This figure is known as the "maximum optimized stored value size," which we will denote here by *maxOptStoredValSize*. If your data typically runs larger, you can enhance performance by increasing the OFF\_HEAP\_FREE\_LIST\_COUNT system parameter to a number larger than `maxOptStoredValSize/8`, where *maxOptStoredValSize* is expressed in KB (1024 bytes). So, the default values correspond to:
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/managing/region_compression/region_compression.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/managing/region_compression/region_compression.html.md.erb b/geode-docs/managing/region_compression/region_compression.html.md.erb
index 754dc85..ac351dd 100644
--- a/geode-docs/managing/region_compression/region_compression.html.md.erb
+++ b/geode-docs/managing/region_compression/region_compression.html.md.erb
@@ -221,6 +221,6 @@ The following statistics provide monitoring for cache compression:
- `preCompressedBytes`
- `postCompressedBytes`
-See [Cache Performance (CachePerfStats)](../../reference/statistics/statistics_list.html#section_DEF8D3644D3246AB8F06FE09A37DC5C8) for statistic descriptions.
+See [Cache Performance (CachePerfStats)](../../reference/statistics_list.html#section_DEF8D3644D3246AB8F06FE09A37DC5C8) for statistic descriptions.
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/book_intro.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/book_intro.html.md.erb b/geode-docs/reference/book_intro.html.md.erb
index e05e618..a7390f4 100644
--- a/geode-docs/reference/book_intro.html.md.erb
+++ b/geode-docs/reference/book_intro.html.md.erb
@@ -1,6 +1,4 @@
----
-title: Reference
----
+<% set_title(product_name_long, "Reference") %>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
@@ -19,11 +17,11 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-*Reference* documents Apache Geode properties, region attributes, the `cache.xml` file, cache memory requirements, and statistics.
+*Reference* documents <%=vars.product_name_long%> properties, region attributes, the `cache.xml` file, cache memory requirements, and statistics.
-- **[gemfire.properties and gfsecurity.properties (Geode Properties)](../reference/topics/gemfire_properties.html)**
+- **[gemfire.properties and gfsecurity.properties (<%=vars.product_name%> Properties)](../reference/topics/gemfire_properties.html)**
- You use the `gemfire.properties` settings to join a distributed system and configure system member behavior. Distributed system members include applications, the cache server, the locator, and other Geode processes.
+ You use the `gemfire.properties` settings to join a distributed system and configure system member behavior. Distributed system members include applications, the cache server, the locator, and other <%=vars.product_name%> processes.
- **[cache.xml](../reference/topics/chapter_overview_cache_xml.html)**
@@ -31,18 +29,18 @@ limitations under the License.
- **[Region Shortcuts](../reference/topics/chapter_overview_regionshortcuts.html)**
- 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.
- **[Exceptions and System Failures](../reference/topics/handling_exceptions_and_failures.html)**
- 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%>.
- **[Memory Requirements for Cached Data](../reference/topics/memory_requirements_for_cache_data.html)**
- 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.
-- **[Geode Statistics List](../reference/statistics/statistics_list.html)**
+- **[<%=vars.product_name%> Statistics List](statistics_list.html)**
- This section describes the primary statistics gathered by Geode when statistics are enabled.
+ This section describes the primary statistics gathered by <%=vars.product_name%> when statistics are enabled.
[2/5] geode git commit: GEODE-3395 Variable-ize product version and
name in user guide - Reference section
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/cache-elements-list.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/cache-elements-list.html.md.erb b/geode-docs/reference/topics/cache-elements-list.html.md.erb
index 2b1c035..3f4872a 100644
--- a/geode-docs/reference/topics/cache-elements-list.html.md.erb
+++ b/geode-docs/reference/topics/cache-elements-list.html.md.erb
@@ -1,4 +1,4 @@
----
+--
title: "<cache> Element Hierarchy"
---
@@ -19,7 +19,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-This section shows the hierarchy of `<cache>` element sub-elements that you use to configure Geode caches and servers.
+This section shows the hierarchy of `<cache>` element sub-elements that you use to configure <%=vars.product_name%> caches and servers.
For details, see [<cache> Element Reference](cache_xml.html#cache_xml_cache).
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/cache_xml.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/cache_xml.html.md.erb b/geode-docs/reference/topics/cache_xml.html.md.erb
index cf5d2b3..a8acd89 100644
--- a/geode-docs/reference/topics/cache_xml.html.md.erb
+++ b/geode-docs/reference/topics/cache_xml.html.md.erb
@@ -21,9 +21,9 @@ limitations under the License.
<a id="cache_xml_cache"></a>
-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`
@@ -244,7 +244,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">
@@ -259,12 +259,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">
@@ -293,13 +293,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>
@@ -494,7 +494,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>
@@ -549,7 +549,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>](#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`
@@ -958,7 +958,7 @@ Specifies the configuration for the Portable Data eXchange (PDX) method of seria
## <a id="pdx-serializer_24898989679" 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>](#class-name_parameter).
@@ -1004,7 +1004,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">
<b>Note:</b>
<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>
@@ -1100,7 +1100,7 @@ Specifies a region attributes template that can be named (by `id`) and reference
</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
@@ -1277,7 +1277,7 @@ Specifies a region attributes template that can be named (by `id`) and reference
<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">
<b>Note:</b>
-<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">
<b>Note:</b>
@@ -1315,7 +1315,7 @@ Specifies a region attributes template that can be named (by `id`) and reference
</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
@@ -1338,7 +1338,7 @@ Specifies a region attributes template that can be named (by `id`) and reference
<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">
<b>Note:</b>
-<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>
@@ -1902,7 +1902,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 |
@@ -2220,7 +2220,7 @@ An event-handler plug-in that allows you to receive before-event notification fo
## <a id="cache-listener" 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>](#class-name_parameter).
@@ -2257,7 +2257,7 @@ A compressor registers a custom class that extends `Compressor` to support compr
## <a id="eviction-attributes" 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.
@@ -2327,7 +2327,7 @@ Using the maximum attribute, specifies maximum region capacity based on entry co
## <a id="lru-heap-percentage" 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>](#class-name_parameter).
@@ -2464,7 +2464,7 @@ Specifies the binding for a data-source used in transaction management. See [Con
## <a id="jndi-binding" 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.
@@ -2521,7 +2521,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">
@@ -2555,7 +2555,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>
@@ -2733,7 +2733,7 @@ Describes an index to be created on a region. The index node, if any, should all
## <a id="luceneindex" class="no-quick-link"></a><lucene:index>
Describes a Lucene index to be created on a region. The `lucene` namespace
-and the scoping operator (`:`) must be specified, as the Geode `cache`
+and the scoping operator (`:`) must be specified, as the <%=vars.product_name%> `cache`
namespace also defines an `index` element (for OQL indexes).
**API:** `org.apache.geode.cache.lucene` package
@@ -3032,7 +3032,7 @@ Set of serializer or instantiator tags to register customer DataSerializer exten
## <a id="serializer" 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.
@@ -3040,7 +3040,7 @@ Specify the Java class for the `DataSerializer` and its initialization parameter
## <a id="instantiator" 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/chapter_overview_cache_xml.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb b/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb
index 2e47eb9..379d320 100644
--- a/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb
+++ b/geode-docs/reference/topics/chapter_overview_cache_xml.html.md.erb
@@ -30,18 +30,18 @@ You can configure most elements of the cache.xml file and apply it to your entir
- **[<cache> Element Hierarchy](../../reference/topics/cache-elements-list.html)**
- This section shows the hierarchy of `<cache>` element sub-elements that you use to configure Geode caches and servers.
+ This section shows the hierarchy of `<cache>` element sub-elements that you use to configure <%=vars.product_name%> caches and servers.
- **[<cache> Element Reference](../../reference/topics/cache_xml.html#cache_xml_cache)**
- 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.
- **[<client-cache> Element Hierarchy](../../reference/topics/client-cache-elements-list.html)**
- This section shows the hierarchy of `<client-cache>` element sub-elements that you use to configure Geode caches and clients.
+ This section shows the hierarchy of `<client-cache>` element sub-elements that you use to configure <%=vars.product_name%> caches and clients.
- **[<client-cache> Element Reference](../../reference/topics/client-cache.html)**
- This section documents all `cache.xml` elements that you use to configure Geode clients. All elements are sub-elements of the `<client-cache>` element.
+ This section documents all `cache.xml` elements that you use to configure <%=vars.product_name%> clients. All elements are sub-elements of the `<client-cache>` element.
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb b/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb
index 4a107ec..1b266e9 100644
--- a/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb
+++ b/geode-docs/reference/topics/chapter_overview_regionshortcuts.html.md.erb
@@ -19,9 +19,9 @@ 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.
-Region shortcuts are groupings of pre-configured attributes that define the characteristics of a region. You can use a region shortcut as a starting point when configuring regions and you can add additional configurations to customize your application. To reference a region shortcut in a Geode `cache.xml` file, use the `refid` attribute of the `<region>` element. For example:
+Region shortcuts are groupings of pre-configured attributes that define the characteristics of a region. You can use a region shortcut as a starting point when configuring regions and you can add additional configurations to customize your application. To reference a region shortcut in a <%=vars.product_name%> `cache.xml` file, use the `refid` attribute of the `<region>` element. For example:
``` pre
<region name="myRegion" refid="PARTITION_REDUNDANT"/>
@@ -52,56 +52,56 @@ If you change the cache.xml file that defines a region, you must restart the mem
For more information about configuring regions, see [Region Management](../../basic_config/data_regions/managing_data_regions.html).
-For more information about using the various types of Geode regions and when to use them, see [Region Types](../../developing/region_options/region_types.html#region_types).
+For more information about using the various types of <%=vars.product_name%> regions and when to use them, see [Region Types](../../developing/region_options/region_types.html#region_types).
-- **[Region Shortcuts Quick Reference](../../reference/topics/region_shortcuts_table.html)**
+- **[Region Shortcuts Quick Reference](region_shortcuts_table.html)**
This section provides a quick reference for all region shortcuts.
-- **[LOCAL](../../reference/topics/region_shortcuts_reference.html#reference_w2h_3cd_lk)**
+- **[LOCAL](region_shortcuts_reference.html#reference_w2h_3cd_lk)**
-- **[LOCAL\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_wd5_lpy_lk)**
+- **[LOCAL\_HEAP\_LRU](region_shortcuts_reference.html#reference_wd5_lpy_lk)**
-- **[LOCAL\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_adk_y4y_lk)**
+- **[LOCAL\_OVERFLOW](region_shortcuts_reference.html#reference_adk_y4y_lk)**
-- **[LOCAL\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_l5r_y4y_lk)**
+- **[LOCAL\_PERSISTENT](region_shortcuts_reference.html#reference_l5r_y4y_lk)**
-- **[LOCAL\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_a45_y4y_lk)**
+- **[LOCAL\_PERSISTENT\_OVERFLOW](region_shortcuts_reference.html#reference_a45_y4y_lk)**
-- **[PARTITION](../../reference/topics/region_shortcuts_reference.html#reference_ow5_4qy_lk)**
+- **[PARTITION](region_shortcuts_reference.html#reference_ow5_4qy_lk)**
-- **[PARTITION\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_twx_y4y_lk)**
+- **[PARTITION\_HEAP\_LRU](region_shortcuts_reference.html#reference_twx_y4y_lk)**
-- **[PARTITION\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_js1_z4y_lk)**
+- **[PARTITION\_OVERFLOW](region_shortcuts_reference.html#reference_js1_z4y_lk)**
-- **[PARTITION\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_d4k_jpy_lk)**
+- **[PARTITION\_PERSISTENT](region_shortcuts_reference.html#reference_d4k_jpy_lk)**
-- **[PARTITION\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_v5l_jpy_lk)**
+- **[PARTITION\_PERSISTENT\_OVERFLOW](region_shortcuts_reference.html#reference_v5l_jpy_lk)**
-- **[PARTITION\_PROXY](../../reference/topics/region_shortcuts_reference.html#reference_v4m_jpy_lk)**
+- **[PARTITION\_PROXY](region_shortcuts_reference.html#reference_v4m_jpy_lk)**
-- **[PARTITION\_PROXY\_REDUNDANT](../../reference/topics/region_shortcuts_reference.html#reference_c1n_jpy_lk)**
+- **[PARTITION\_PROXY\_REDUNDANT](region_shortcuts_reference.html#reference_c1n_jpy_lk)**
-- **[PARTITION\_REDUNDANT](../../reference/topics/region_shortcuts_reference.html#reference_shn_jpy_lk)**
+- **[PARTITION\_REDUNDANT](region_shortcuts_reference.html#reference_shn_jpy_lk)**
-- **[PARTITION\_REDUNDANT\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_m4n_jpy_lk)**
+- **[PARTITION\_REDUNDANT\_HEAP\_LRU](region_shortcuts_reference.html#reference_m4n_jpy_lk)**
-- **[PARTITION\_REDUNDANT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_own_jpy_lk)**
+- **[PARTITION\_REDUNDANT\_OVERFLOW](region_shortcuts_reference.html#reference_own_jpy_lk)**
-- **[PARTITION\_REDUNDANT\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_bd4_jpy_lk)**
+- **[PARTITION\_REDUNDANT\_PERSISTENT](region_shortcuts_reference.html#reference_bd4_jpy_lk)**
-- **[PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_xqq_tvc_lk)**
+- **[PARTITION\_REDUNDANT\_PERSISTENT\_OVERFLOW](region_shortcuts_reference.html#reference_xqq_tvc_lk)**
-- **[REPLICATE](../../reference/topics/region_shortcuts_reference.html#reference_wq4_jpy_lk)**
+- **[REPLICATE](region_shortcuts_reference.html#reference_wq4_jpy_lk)**
-- **[REPLICATE\_HEAP\_LRU](../../reference/topics/region_shortcuts_reference.html#reference_xx4_jpy_lk)**
+- **[REPLICATE\_HEAP\_LRU](region_shortcuts_reference.html#reference_xx4_jpy_lk)**
-- **[REPLICATE\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_t2p_jpy_lk)**
+- **[REPLICATE\_OVERFLOW](region_shortcuts_reference.html#reference_t2p_jpy_lk)**
-- **[REPLICATE\_PERSISTENT](../../reference/topics/region_shortcuts_reference.html#reference_emp_jpy_lk)**
+- **[REPLICATE\_PERSISTENT](region_shortcuts_reference.html#reference_emp_jpy_lk)**
-- **[REPLICATE\_PERSISTENT\_OVERFLOW](../../reference/topics/region_shortcuts_reference.html#reference_tsp_jpy_lk)**
+- **[REPLICATE\_PERSISTENT\_OVERFLOW](region_shortcuts_reference.html#reference_tsp_jpy_lk)**
-- **[REPLICATE\_PROXY](../../reference/topics/region_shortcuts_reference.html#reference_n1q_jpy_lk)**
+- **[REPLICATE\_PROXY](region_shortcuts_reference.html#reference_n1q_jpy_lk)**
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/client-cache-elements-list.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/client-cache-elements-list.html.md.erb b/geode-docs/reference/topics/client-cache-elements-list.html.md.erb
index cd99f65..0d26303 100644
--- a/geode-docs/reference/topics/client-cache-elements-list.html.md.erb
+++ b/geode-docs/reference/topics/client-cache-elements-list.html.md.erb
@@ -19,7 +19,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-This section shows the hierarchy of `<client-cache>` element sub-elements that you use to configure Geode caches and clients.
+This section shows the hierarchy of `<client-cache>` element sub-elements that you use to configure <%=vars.product_name%> caches and clients.
For details, see [<client-cache> Element Reference.](client-cache.html)
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/topics/client-cache.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/client-cache.html.md.erb b/geode-docs/reference/topics/client-cache.html.md.erb
index 99e5b39..83043f7 100644
--- a/geode-docs/reference/topics/client-cache.html.md.erb
+++ b/geode-docs/reference/topics/client-cache.html.md.erb
@@ -20,9 +20,9 @@ limitations under the License.
-->
<a id="cc-client-cache"></a>
-This section documents all `cache.xml` elements that you use to configure Geode clients. All elements are sub-elements of the `<client-cache>` element.
+This section documents all `cache.xml` elements that you use to configure <%=vars.product_name%> clients. All elements are sub-elements of the `<client-cache>` element.
-For Geode server configuration, see [<cache> Element Reference](cache_xml.html).
+For <%=vars.product_name%> server configuration, see [<cache> Element Reference](cache_xml.html).
API: `org.apache.geode.cache.client.ClientCacheFactory` and `PoolFactory` interfaces.
@@ -511,7 +511,7 @@ Specifies the configuration for the Portable Data eXchange (PDX) method of seria
## <a id="cc-pdx-serializer" 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).
@@ -557,7 +557,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>
@@ -659,7 +659,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
@@ -836,7 +836,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:**
@@ -874,7 +874,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
@@ -897,7 +897,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>
@@ -1483,7 +1483,7 @@ An event-handler plug-in that allows you to receive before-event notification fo
## <a id="cc-cache-listener" 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).
@@ -1503,7 +1503,7 @@ Specify the Java class for the cache listener and its initialization parameters
## <a id="cc-eviction-attributes" 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.
@@ -1573,7 +1573,7 @@ Using the maximum attribute, specifies maximum region capacity based on entry co
## <a id="cc-lru-heap-percentage" 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).
@@ -1710,7 +1710,7 @@ Specifies the binding for a data-source used in transaction management. See [Con
## <a id="cc-jndi-binding" 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.
@@ -1767,7 +1767,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">
@@ -1801,7 +1801,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>
@@ -1956,7 +1956,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>
@@ -2058,7 +2058,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
@@ -2235,7 +2235,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 region shortccuts in <code class="ph codeph">RegionShortcut</code> and <code class="ph codeph">ClientRegionShortcut</code>.</p>
</div>
<div class="note note">
**Note:**
@@ -2273,7 +2273,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
@@ -2296,7 +2296,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>
@@ -2637,7 +2637,7 @@ Set of serializer or instantiator tags to register customer DataSerializer exten
## <a id="cc-serializer" 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.
@@ -2645,7 +2645,7 @@ Specify the Java class for the `DataSerializer` and its initialization parameter
## <a id="cc-instantiator" 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/gemfire_properties.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/topics/gemfire_properties.html.md.erb b/geode-docs/reference/topics/gemfire_properties.html.md.erb
index 238803e..a226618 100644
--- a/geode-docs/reference/topics/gemfire_properties.html.md.erb
+++ b/geode-docs/reference/topics/gemfire_properties.html.md.erb
@@ -1,6 +1,4 @@
----
-title: gemfire.properties and gfsecurity.properties (Geode Properties)
----
+<% set_title("gemfire.properties and gfsecurity.properties:", product_name, "Properties") %>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
@@ -19,13 +17,13 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-You use the `gemfire.properties` settings to join a distributed system and configure system member behavior. Distributed system members include applications, the cache server, the locator, and other Geode processes.
+You use the `gemfire.properties` settings to join a distributed system and configure system member behavior. Distributed system members include applications, the cache server, the locator, and other <%=vars.product_name%> processes.
You can place any security-related (properties that begin with `security-*`) configuration properties in `gemfire.properties` into a separate `gfsecurity.properties` file. Placing these configuration settings in a separate file allows you to restrict access to security configuration data. This way, you can still allow read or write access for your `gemfire.properties` file.
You can also define provider-specific properties ("ssl" properties) in `gfsecurity.properties` instead of defining them at the command-line or in your environment.
-You can specify non-ASCII text in your properties files by using Unicode escape sequences. See [Using Non-ASCII Strings in Apache Geode Property Files](non-ascii_strings_in_config_files.html) for more details.
+You can specify non-ASCII text in your properties files by using Unicode escape sequences. See [Using Non-ASCII Strings in <%=vars.product_name_long%> Property Files](non-ascii_strings_in_config_files.html) for more details.
**Note:**
Unless otherwise indicated, these settings only affect activities within this distributed system - not activities between clients and servers or between a gateway sender and gateway receiver in a multi-site installation.
@@ -106,7 +104,7 @@ Valid values are in the range 0...2147483647</td>
</tr>
<tr class="even">
<td>bind-address</td>
-<td>Relevant only for multi-homed hosts - machines with multiple network interface cards. Specifies the adapter card the cache binds to for peer-to-peer communication. Also specifies the default location for Geode servers to listen on, which is used unless overridden by the <code class="ph codeph">server-bind-address</code>. An empty string causes the member to listen on the default card for the machine. This is a machine-wide attribute used for system member and client/server communication. It has no effect on locator location, unless the locator is embedded in a member process.
+<td>Relevant only for multi-homed hosts - machines with multiple network interface cards. Specifies the adapter card the cache binds to for peer-to-peer communication. Also specifies the default location for <%=vars.product_name%> servers to listen on, which is used unless overridden by the <code class="ph codeph">server-bind-address</code>. An empty string causes the member to listen on the default card for the machine. This is a machine-wide attribute used for system member and client/server communication. It has no effect on locator location, unless the locator is embedded in a member process.
<p>Specify the IP address, not the hostname, because each network card may not have a unique hostname. An empty string (the default) causes the member to listen on the default card for the machine.</p></td>
<td>S, L</td>
<td><em>not set</em></td>
@@ -131,7 +129,7 @@ Valid values are in the range 0...2147483647</td>
</tr>
<tr class="odd">
<td>conserve-sockets</td>
-<td>Specifies whether sockets are shared by the system member’s threads. If true, threads share, and a minimum number of sockets are used to connect to the distributed system. If false, every application thread has its own sockets for distribution purposes. You can override this setting for individual threads inside your application. Where possible, it is better to set conserve-sockets to true and enable the use of specific extra sockets in the application code if needed. WAN deployments increase the messaging demands on a Geode system. To avoid hangs related to WAN messaging, always set <code class="ph codeph">conserve-sockets=false</code> for Geode members that participate in a WAN deployment.</td>
+<td>Specifies whether sockets are shared by the system member’s threads. If true, threads share, and a minimum number of sockets are used to connect to the distributed system. If false, every application thread has its own sockets for distribution purposes. You can override this setting for individual threads inside your application. Where possible, it is better to set conserve-sockets to true and enable the use of specific extra sockets in the application code if needed. WAN deployments increase the messaging demands on a <%=vars.product_name%> system. To avoid hangs related to WAN messaging, always set <code class="ph codeph">conserve-sockets=false</code> for <%=vars.product_name%> members that participate in a WAN deployment.</td>
<td>S, L</td>
<td>true</td>
</tr>
@@ -144,13 +142,13 @@ Valid values are in the range 0...2147483647</td>
<tr class="odd">
<td>deploy-working-dir</td>
<td>Working directory used when deploying JAR application files to distributed system members. This directory can be local and unique to the member or a shared resource.
-See <a href="../../configuring/cluster_config/deploying_application_jars.html">Deploying Application JARs to Apache Geode Members</a> for more information.</td>
+See <a href="../../configuring/cluster_config/deploying_application_jars.html">Deploying Application JARs to <%=vars.product_name_long%> Members</a> for more information.</td>
<td>S</td>
<td>. (current directory)</td>
</tr>
<tr class="even">
<td>disable-auto-reconnect</td>
-<td>By default, a Geode member (both locators and servers) will attempt to reconnect and reinitialize the cache after it has been forced out of the distributed system by a network partition event or has otherwise been shunned by other members. Use this property to turn off the autoreconnect behavior.
+<td>By default, a <%=vars.product_name%> member (both locators and servers) will attempt to reconnect and reinitialize the cache after it has been forced out of the distributed system by a network partition event or has otherwise been shunned by other members. Use this property to turn off the autoreconnect behavior.
See <a href="../../managing/autoreconnect/member-reconnect.html">Handling Forced Cache Disconnection Using Autoreconnect</a> for more details.</td>
<td>S, L</td>
<td>false</td>
@@ -205,7 +203,7 @@ This setting must be the same for every member of a given distributed system and
</tr>
<tr class="even">
<td>enforce-unique-host</td>
-<td>Whether partitioned regions will put redundant copies of the same data in different members running on the same physical machine. By default, Geode tries to put redundant copies on different machines, but it will put them on the same machine if no other machines are available. Setting this property to true prevents this and requires different machines for redundant copies.</td>
+<td>Whether partitioned regions will put redundant copies of the same data in different members running on the same physical machine. By default, <%=vars.product_name%> tries to put redundant copies on different machines, but it will put them on the same machine if no other machines are available. Setting this property to true prevents this and requires different machines for redundant copies.</td>
<td>S</td>
<td>false</td>
</tr>
@@ -218,13 +216,13 @@ See <a href="../../configuring/cluster_config/using_member_groups.html">Using Me
</tr>
<tr class="even">
<td>http-service-bind-address</td>
-<td>If set, then the Geode member binds the embedded HTTP service to the specified address. If this property is not set but the HTTP service is enabled using <code class="ph codeph">http-service-port</code>, then Geode binds the HTTP service to the member's local address. Used by the Geode Pulse Web application and the developer REST API service.</td>
+<td>If set, then the <%=vars.product_name%> member binds the embedded HTTP service to the specified address. If this property is not set but the HTTP service is enabled using <code class="ph codeph">http-service-port</code>, then <%=vars.product_name%> binds the HTTP service to the member's local address. Used by the <%=vars.product_name%> Pulse Web application and the developer REST API service.</td>
<td>S</td>
<td><em>not set</em></td>
</tr>
<tr class="odd">
<td>http-service-port</td>
-<td>If non-zero, then Geode starts an embedded HTTP service that listens on this port. The HTTP service is used to host the Geode Pulse Web application and the development REST API service. If you are hosting the Pulse web app on your own Web server and are not using the development REST API service, then disable this embedded HTTP service by setting this property to zero. Ignored if <code class="ph codeph">jmx-manager</code> and <code class="ph codeph">start-dev-rest-api</code> are both set to false.</td>
+<td>If non-zero, then <%=vars.product_name%> starts an embedded HTTP service that listens on this port. The HTTP service is used to host the <%=vars.product_name%> Pulse Web application and the development REST API service. If you are hosting the Pulse web app on your own Web server and are not using the development REST API service, then disable this embedded HTTP service by setting this property to zero. Ignored if <code class="ph codeph">jmx-manager</code> and <code class="ph codeph">start-dev-rest-api</code> are both set to false.</td>
<td>S</td>
<td>7070</td>
</tr>
@@ -254,7 +252,7 @@ See <a href="../../configuring/cluster_config/using_member_groups.html">Using Me
</tr>
<tr class="even">
<td>jmx-manager-port</td>
-<td>The port this JMX Manager will listen to for client connections. If this property is set to zero then Geode will not allow remote client connections but you can alternatively use the standard system properties supported by the JVM for configuring access from remote JMX clients. Ignored if <code class="ph codeph">jmx-manager</code> is false.</td>
+<td>The port this JMX Manager will listen to for client connections. If this property is set to zero then <%=vars.product_name%> will not allow remote client connections but you can alternatively use the standard system properties supported by the JVM for configuring access from remote JMX clients. Ignored if <code class="ph codeph">jmx-manager</code> is false.</td>
<td>S, L</td>
<td>1099</td>
</tr>
@@ -266,7 +264,7 @@ See <a href="../../configuring/cluster_config/using_member_groups.html">Using Me
</tr>
<tr class="even">
<td>jmx-manager-update-rate</td>
-<td>The rate, in milliseconds, at which this member will push updates to any JMX Managers. Currently this value should be greater than or equal to the statistic-sample-rate. Setting this value too high will cause stale values to be seen by gfsh and Geode Pulse.</td>
+<td>The rate, in milliseconds, at which this member will push updates to any JMX Managers. Currently this value should be greater than or equal to the statistic-sample-rate. Setting this value too high will cause stale values to be seen by gfsh and <%=vars.product_name%> Pulse.</td>
<td>S, L</td>
<td>2000</td>
</tr>
@@ -348,7 +346,7 @@ See <a href="../../configuring/cluster_config/using_member_groups.html">Using Me
<td>mcast-address</td>
<td>Address used to discover other members of the distributed system. Only used if mcast-port is non-zero. This attribute must be consistent across the distributed system. Select different multicast addresses and different ports for different distributed systems. Do not just use different addresses. Some operating systems may not keep communication separate between systems that use unique addresses but the same port number.
<p>This default multicast address was assigned by IANA
-(<a href="http://www.iana.org/assignments/multicast-addresses">http://www.iana.org/assignments/multicast-addresses</a>). Consult the IANA chart when selecting another multicast address to use with Geode.</p>
+(<a href="http://www.iana.org/assignments/multicast-addresses">http://www.iana.org/assignments/multicast-addresses</a>). Consult the IANA chart when selecting another multicast address to use with <%=vars.product_name%>.</p>
<div class="note note">
**Note:**
<p>This setting controls only peer-to-peer communication and does not apply to client/server or multi-site communication. If multicast is enabled, distributed regions use it for most communication. Partitioned regions only use multicast for a few purposes, and mainly use either TCP or UDP unicast.</p>
@@ -422,7 +420,7 @@ See <a href="../../configuring/cluster_config/using_member_groups.html">Using Me
</tr>
<tr class="even">
<td>member-timeout</td>
-<td>Geode uses the <code class="ph codeph">member-timeout</code> server configuration, specified in milliseconds, to detect the abnormal termination of members. The configuration setting is used in two ways: 1) First it is used during the UDP heartbeat detection process. When a member detects that a heartbeat datagram is missing from the member that it is monitoring after the time interval of 2 * the value of <code class="ph codeph">member-timeout</code>, the detecting member attempts to form a TCP/IP stream-socket connection with the monitored member as described in the next case. 2) The property is then used again during the TCP/IP stream-socket connection. If the suspected process does not respond to the <em>are you alive</em> datagram within the time period specified in <code class="ph codeph">member-timeout</code>, the membership coordinator sends out a new membership view that notes the member's failure.
+<td><%=vars.product_name%> uses the <code class="ph codeph">member-timeout</code> server configuration, specified in milliseconds, to detect the abnormal termination of members. The configuration setting is used in two ways: 1) First it is used during the UDP heartbeat detection process. When a member detects that a heartbeat datagram is missing from the member that it is monitoring after the time interval of 2 * the value of <code class="ph codeph">member-timeout</code>, the detecting member attempts to form a TCP/IP stream-socket connection with the monitored member as described in the next case. 2) The property is then used again during the TCP/IP stream-socket connection. If the suspected process does not respond to the <em>are you alive</em> datagram within the time period specified in <code class="ph codeph">member-timeout</code>, the membership coordinator sends out a new membership view that notes the member's failure.
<p>Valid values are in the range 1000..600000.</p></td>
<td>S, L</td>
<td>5000</td>
@@ -430,10 +428,10 @@ See <a href="../../configuring/cluster_config/using_member_groups.html">Using Me
<tr class="odd">
<td>membership-port-range</td>
<td>The range of ports available for unicast UDP messaging and for TCP failure detection. This is specified as two integers separated by a hyphen. Different members can use different ranges.
-<p>Geode randomly chooses at least two unique integers from this range for the member, one for UDP unicast messaging and the other for TCP failure detection messaging. If tcp-port is configured to 0, it will also randomly select a port from this range for TCP sockets used for peer-to-peer communication only.</p>
+<p><%=vars.product_name%> randomly chooses at least two unique integers from this range for the member, one for UDP unicast messaging and the other for TCP failure detection messaging. If tcp-port is configured to 0, it will also randomly select a port from this range for TCP sockets used for peer-to-peer communication only.</p>
<p>Therefore, the specified range must include at least three available port numbers (UDP, FD_SOCK, and TCP DirectChannel).</p>
<p>The system uniquely identifies the member using the combined host IP address and UDP port number.</p>
-<p>You may want to restrict the range of ports that Geode uses so the product can run in an environment where routers only allow traffic on certain ports.</p></td>
+<p>You may want to restrict the range of ports that <%=vars.product_name%> uses so the product can run in an environment where routers only allow traffic on certain ports.</p></td>
<td>S, L</td>
<td>1024-65535</td>
</tr>
@@ -465,7 +463,7 @@ off-heap-memory-size=120g</code></pre></td>
</tr>
<tr class="even">
<td>redundancy-zone</td>
-<td>Defines this member's redundancy zone. Used to separate member's into different groups for satisfying partitioned region redundancy. If this property is set, Geode will not put redundant copies of data in members with the same redundancy zone setting.
+<td>Defines this member's redundancy zone. Used to separate member's into different groups for satisfying partitioned region redundancy. If this property is set, <%=vars.product_name%> will not put redundant copies of data in members with the same redundancy zone setting.
See <a href="../../developing/partitioned_regions/configuring_ha_for_pr.html">Configure High Availability for a Partitioned Region</a> for more details.</td>
<td>S</td>
<td><em>not set</em></td>
@@ -569,7 +567,7 @@ Any security-related (properties that begin with <code class="ph codeph">securit
</tr>
<tr class="even">
<td>server-bind-address</td>
-<td>Relevant only for multi-homed hosts - machines with multiple network interface cards. Network adapter card a Geode server binds to for client/server communication. You can use this to separate the server’s client/server communication from its peer-to-peer communication, spreading the traffic load.
+<td>Relevant only for multi-homed hosts - machines with multiple network interface cards. Network adapter card a <%=vars.product_name%> server binds to for client/server communication. You can use this to separate the server’s client/server communication from its peer-to-peer communication, spreading the traffic load.
<p>This is a machine-wide attribute used for communication with clients in client/server and multi-site installations. This setting has no effect on locator configuration.</p>
<p>Specify the IP address, not the hostname, because each network card may not have a unique hostname.</p>
<p>An empty string causes the servers to listen on the same card used for peer-to-peer communication. This is either the <code class="ph codeph">bind-address</code> or, if that is not set, the machine’s default card.</p></td>
@@ -703,14 +701,14 @@ If you only specify the port, the address assigned to the member is used for the
</tr>
<tr class="odd">
<td>tcp-port</td>
-<td>The TCP port to listen on for cache communications. If set to zero, the operating system selects an available port. Each process on a machine must have its own TCP port. Note that some operating systems restrict the range of ports usable by non-privileged users, and using restricted port numbers can cause runtime errors in Geode startup.
+<td>The TCP port to listen on for cache communications. If set to zero, the operating system selects an available port. Each process on a machine must have its own TCP port. Note that some operating systems restrict the range of ports usable by non-privileged users, and using restricted port numbers can cause runtime errors in <%=vars.product_name%> startup.
<p>Valid values are in the range 0..65535.</p></td>
<td>S, L</td>
<td>0</td>
</tr>
<tr class="even">
<td>tombstone-gc-threshold</td>
-<td>The number of tombstones that can accumulate before the Geode member triggers garbage collection for tombstones.
+<td>The number of tombstones that can accumulate before the <%=vars.product_name%> member triggers garbage collection for tombstones.
See <a href="../../developing/distributed_regions/how_region_versioning_works.html#topic_321B05044B6641FCAEFABBF5066BD399">How Destroy and Clear Operations Are Resolved</a>.</td>
<td>S</td>
<td>100000</td>
@@ -752,6 +750,6 @@ See <a href="../../developing/distributed_regions/how_region_versioning_works.ht
</tbody>
</table>
-- **[Using Non-ASCII Strings in Apache Geode Property Files](../../reference/topics/non-ascii_strings_in_config_files.html)**
+- **[Using Non-ASCII Strings in <%=vars.product_name_long%> Property Files](../../reference/topics/non-ascii_strings_in_config_files.html)**
- 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.
[3/5] geode git commit: GEODE-3395 Variable-ize product version and
name in user guide - Reference section
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/statistics_list.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/statistics_list.html.md.erb b/geode-docs/reference/statistics_list.html.md.erb
new file mode 100644
index 0000000..f26075d
--- /dev/null
+++ b/geode-docs/reference/statistics_list.html.md.erb
@@ -0,0 +1,1310 @@
+---
+title: Geode Statistics List
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<a id="statistics_list"></a>
+
+
+This section describes the primary statistics gathered by Geode when statistics are enabled.
+
+All statistics gathering requires the `gemfire.properties` `statistic-sampling-enabled` in `gemfire.properties` file to be true. Statistics that use time require the `gemfire.properties` `enable-time-statistics` to be true.
+
+Performance statistics are collected for each Java application or cache server that connects to a distributed system.
+
+- **[Cache Performance (CachePerfStats)](#section_DEF8D3644D3246AB8F06FE09A37DC5C8)**
+
+- **[Cache Server (CacheServerStats)](#section_EF5C2C59BFC74FFB8607F9571AB9A471)**
+
+- **[Client-Side Notifications (CacheClientUpdaterStats)](#section_B08C0783BBF9489E8BB48B4AEC597C62)**
+
+- **[Client-to-Server Messaging Performance (ClientStats)](#section_04B7D7387E584712B7710B5ED1E876BB)**
+
+- **[Client Connection Pool (PoolStats)](#section_6C247F61DB834C079A16BE92789D4692)**
+
+- **[Continuous Querying (CQStatistics)](#section_66C0E7748501480B85209D57D24256D5)**
+
+- **[Delta Propagation (DeltaPropagationStatistics)](#section_D4ABED3FF94245C0BEE0F6FC9481E867)**
+
+- **[Disk Space Usage (DiskDirStatistics)](#section_6C2BECC63A83456190B029DEDB8F4BE3)**
+
+- **[Disk Usage and Performance (DiskRegionStatistics)](#section_983BFC6D53C74829A04A91C39E06315F)**
+
+- **[Distributed System Messaging (DistributionStats)](#section_ACB4161F10D64BC0B15871D003FF6FDF)**
+
+- **[Distributed Lock Services (DLockStats)](#section_78D346A580724E1EA645E31626EECE40)**
+
+- **[Function Execution (FunctionServiceStatistics)](#section_5E211DDB0E8640689AD0A4659511E17A)**
+
+- **[Gateway Queue (GatewayStatistics)](#section_C4199A541B1F4B82B6178C416C0FAE4B)**
+
+- **[Indexes (IndexStats)](#section_86A61860024B480592DAC67FFB882538)**
+
+- **[JVM Performance](#section_607C3867602E410CAE5FAB26A7FF1CB9)**
+
+- **[Locator (LocatorStatistics)](#section_C48B654F973E4B44AD825D459C23A6CD)**
+
+- **[Lucene Indexes (LuceneIndexStats)](#LuceneStats)**
+
+- **[Off-Heap (OffHeapMemoryStats)](#topic_ohc_tjk_w5)**
+
+- **[Operating System Statistics - Linux](#section_923B28F01BC3416786D3AFBD87F22A5E)**
+
+- **[Partitioned Regions (PartitionedRegion<partitioned\_region\_name>Statistics)](#section_35AC170770C944C3A336D9AEC2D2F7C5)**
+
+- **[Region Entry Eviction – Count-Based (LRUStatistics)](#section_374FBD92A3B74F6FA08AA23047929B4F)**
+
+- **[Region Entry Eviction – Size-based (LRUStatistics)](#section_3D2AA2BCE5B6485699A7B6ADD1C49FF7)**
+
+- **[Server Notifications for All Clients (CacheClientNotifierStatistics)](#section_5362EF9AECBC48D69475697109ABEDFA)**
+
+- **[Server Notifications for Single Client (CacheClientProxyStatistics)](#section_E03865F509E543D9B8F9462B3DA6255E)**
+
+- **[Server-to-Client Messaging Performance (ClientSubscriptionStats)](#section_3AB1C0AA55014163A2BBF68E13D25E3A)**
+
+- **[Statistics Collection (StatSampler)](#section_55F3AF6413474317902845EE4996CC21)**
+
+## <a id="section_DEF8D3644D3246AB8F06FE09A37DC5C8" class="no-quick-link"></a>Cache Performance (CachePerfStats)
+
+Statistics for the Geode cache. These can be used to determine the type and number of cache operations being performed and how much time they consume.
+
+Regarding Geode cache transactions, transaction-related statistics are compiled and stored as properties in the CachePerfStats statistic resource. Because the transaction’s data scope is the cache, these statistics are collected on a per-cache basis.
+
+The primary statistics are:
+
+| Statistic | Description |
+|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `cacheListenerCallsCompleted` | Total number of times a cache listener call has completed. |
+| `cacheListenerCallsInProgress` | Current number of threads doing a cache listener call. |
+| `cacheListenerCallTime` | Total time spent doing cache listener calls. |
+| `cacheWriterCallsCompleted` | Total number of times a cache writer call has completed. |
+| `cacheWriterCallsInProgress` | Current number of threads doing a cache writer call. |
+| `cacheWriterCallTime` | Total time spent doing cache writer calls. |
+| `compressions` | Total number of compression operations. |
+| `compressTime` | Total time, in nanoseconds, spent compressing data. |
+| `conflatedEvents` | The number of events that were conflated, and not delivered to event listeners or gateway senders on this member. Events are typically conflated because a later event was already applied to the cache, or because a concurrent event was ignored to ensure cache consistency. Note that some members may discard an update while other members apply the update, depending on the order in which each member receives the update. For this reason, the `conflatedEvents` statistic will differ for each Geode member. See [Consistency for Region Updates](../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
+| `creates` | The total number of times an entry is added to this cache. |
+| `decompressions` | Total number of decompression operations. |
+| `decompressTime` | Total time, in nanoseconds, spent decompressing data. |
+| `destroys` | The total number of times a cache object entry has been destroyed in this cache. |
+| `eventQueueSize` | The number of cache events waiting to be processed. |
+| `eventQueueThrottleCount` | The total number of times a thread was delayed in adding an event to the event queue. |
+| `eventQueueThrottleTime` | The total amount of time, in nanoseconds, spent delayed by the event queue throttle. |
+| `eventThreads` | The number of threads currently processing events. |
+| `getInitialImageKeysReceived` | Total number of keys received while doing getInitialImage operations. |
+| `getInitialImagesCompleted` | Total number of times getInitialImages initiated by this cache have completed. |
+| `getInitialImagesInProgressDesc` | Current number of getInitialImage operations currently in progress. |
+| `getInitialImageTime` | Total time spent doing getInitialImages for region creation. |
+| `getsDesc` | The total number of times a successful get has been done on this cache. |
+| `getTime` | Total time spent doing get operations from this cache (including netsearch and netload). |
+| `invalidates` | The total number of times an existing cache object entry value in this cache has been invalidated. |
+| `loadsCompleted` | Total number of times a load on this cache has completed as a result of either a local get() or a remote netload. |
+| `loadsInProgress` | Current number of threads in this cache doing a cache load. |
+| `loadTime` | Total time spent invoking loaders on this cache. |
+| `misses` | Total number of times a get on the cache did not find a value already in local memory. The number of hits (that is, gets that did not miss) can be calculated by subtracting misses from gets. |
+| `netloadsCompleted` | Total number of times a network load initiated on this cache has completed. |
+| `netloadsInProgress` | Current number of threads doing a network load initiated by a get() in this cache. |
+| `netloadTime` | Total time spent doing network loads on this cache. |
+| `netsearchesCompleted` | Total number of times network searches initiated by this cache have completed. |
+| `netsearchesInProgress` | Current number of threads doing a network search initiated by a get() in this cache. |
+| `netsearchTimeDesc` | Total time spent doing network searches for cache values. |
+| `nonReplicatedTombstonesSize` | The approximate number of bytes that are currently consumed by tombstones in non-replicated regions. See [Consistency for Region Updates](../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
+| `partitionedRegions` | The current number of partitioned regions in the cache. |
+| `postCompressedBytes` | Total number of bytes after compressing. |
+| `preCompressedBytes` | Total number of bytes before compressing. |
+| `putAlls` | The total number of times a map is added or replaced in this cache as a result of a local operation. Note, this only counts putAlls done explicitly on this cache; it does not count updates pushed from other caches. |
+| `putallTime` | Total time spent replacing a map in this cache as a result of a local operation. This includes synchronizing on the map, invoking cache callbacks, sending messages to other caches and waiting for responses (if required). |
+| `puts` | The total number of times an entry is added or replaced in this cache as a result of a local operation (put(), create(), or get() which results in load, netsearch, or netloading a value). Note, this only counts puts done explicitly on this cache; it does not count updates pushed from other caches. |
+| `putTime` | Total time spent adding or replacing an entry in this cache as a result of a local operation. This includes synchronizing on the map, invoking cache callbacks, sending messages to other caches, and waiting for responses (if required). |
+| `queryExecutions` | Total number of times some query has been executed. |
+| `queryExecutionTime` | Total time spent executing queries. |
+| `regions` | The current number of regions in the cache. |
+| `replicatedTombstonesSize` | The approximate number of bytes that are currently consumed by tombstones in replicated or partitioned regions. See [Consistency for Region Updates](../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
+| `tombstoneCount` | The total number of tombstone entries created for performing concurrency checks. See [Consistency for Region Updates](../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
+| `tombstoneGCCount` | The total number of tombstone garbage collection cycles that a member has performed. See [Consistency for Region Updates](../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
+| `txCommitChanges` | Total number of changes made by committed transactions. |
+| `txCommits` | Total number of times a transaction commit has succeeded. |
+| `txCommitTime` | The total amount of time, in nanoseconds, spent doing successful transaction commits. |
+| `txConflictCheckTime` | The total amount of time, in nanoseconds, spent doing conflict checks during transaction commit. |
+| `txFailedLifeTime` | The total amount of time, in nanoseconds, spent in a transaction before a failed commit. The time measured starts at transaction begin and ends when commit is called. |
+| `txFailureChanges` | Total number of changes lost by failed transactions. |
+| `txFailures` | Total number of times a transaction commit has failed. |
+| `txFailureTime` | The total amount of time, in nanoseconds, spent doing failed transaction commits. |
+| `txRollbackChanges` | Total number of changes lost by explicit transaction rollbacks. |
+| `txRollbackLifeTime` | The total amount of time, in nanoseconds, spent in a transaction before an explicit rollback. The time measured starts at transaction begin and ends when rollback is called. |
+| `txRollbacks` | Total number of times a transaction has been explicitly rolled back. |
+| `txRollbackTime` | The total amount of time, in nanoseconds, spent doing explicit transaction rollbacks. |
+| `txSuccessLifeTime` | The total amount of time, in nanoseconds, spent in a transaction before a successful commit. The time measured starts at transaction begin and ends when commit is called. |
+| `updates` | The total number of updates originating remotely that have been applied to this cache. |
+| `updateTime` | Total time spent performing an update. |
+
+## <a id="section_EF5C2C59BFC74FFB8607F9571AB9A471" class="no-quick-link"></a>Cache Server (CacheServerStats)
+
+Statistics used for cache servers and for gateway receivers are recorded in CacheServerStats in a cache server. The primary statistics are:
+
+| Statistic | Description |
+|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| `abandonedReadRequests` | Number of read operations (requests) abandoned by clients. |
+| `abandonedWriteRequests` | Number of write operations (requests) abandoned by clients. |
+| `acceptsInProgress` | Current number of server accepts that are attempting to do the initial handshake with the client. |
+| `acceptThreadStarts` | Total number of threads created (starts) to deal with an accepted socket. Note, this is not the current number of threads. |
+| `batchSize` | The size (in bytes) of the batches received. |
+| `clearRegionRequests` | Number of cache client operations clearRegion requests. |
+| `clearRegionResponses` | Number of clearRegion responses written to the cache client. |
+| `clientNotificationRequests` | Number of cache client operations notification requests. |
+| `clientReadyRequests` | Number of cache client ready requests. |
+| `clientReadyResponses` | Number of client ready responses written to the cache client. |
+| `closeConnectionRequests` | Number of cache client close connection operations requests. |
+| `connectionLoad` | The load from client to server connections as reported by the load probe installed in this server. |
+| `connectionsTimedOut` | Total number of connections that have been timed out by the server because of client inactivity. |
+| `connectionThreads` | Current number of threads dealing with a client connection. |
+| `connectionThreadStarts` | Total number of threads created (starts) to deal with a client connection. Note, this is not the current number of threads. |
+| `containsKeyRequests` | Number of cache client operations containsKey requests. |
+| `containsKeyResponses` | Number of containsKey responses written to the cache client. |
+| `currentClientConnections` | Number of sockets accepted. |
+| `currentClients` | Number of client virtual machines (clients) connected. |
+| `destroyRegionRequests` | Number of cache client operations destroyRegion requests. |
+| `destroyRegionResponses` | Number of destroyRegion responses written to the cache client. |
+| `destroyRequests` | Number of cache client operations destroy requests. |
+| `destroyResponses` | Number of destroy responses written to the cache client. |
+| `failedConnectionAttempts` | Number of failed connection attempts. |
+| `getRequests` | Number of cache client operations get requests. |
+| `getResponses` | Number of getResponses written to the cache client. |
+| `loadPerConnection` | The estimate of how much load i.s added for each new connection as reported by the load probe installed in this server. |
+| `loadPerQueue` | The estimate of how much load would be added for each new subscription connection as reported by the load probe installed in this server. |
+| `messageBytesBeingReceived` | Current number of bytes consumed by messages being received or processed. |
+| `messagesBeingReceived` | Current number of messages being received off the network or being processed after reception. |
+| `outOfOrderGatewayBatchIds` | Number of Out of Order batch IDs (batches). |
+| `processBatchRequests` | Number of cache client operations processBatch requests. |
+| `processBatchResponses` | Number of processBatch responses written to the cache client. |
+| `processBatchTime` | Total time, in nanoseconds, spent in processing a cache client processBatch request. |
+| `processClearRegionTime` | Total time, in nanoseconds, spent in processing a cache client clearRegion request, including the time to clear the region from the cache. |
+| `processClientNotificationTime` | Total time, in nanoseconds, spent in processing a cache client notification request. |
+| `processClientReadyTime` | Total time, in nanoseconds, spent in processing a cache client ready request, including the time to destroy an object from the cache. |
+| `processCloseConnectionTime` | Total time, in nanoseconds, spent in processing a cache client close connection request. |
+| `processContainsKeyTime` | Total time spent, in nanoseconds, processing a containsKey request. |
+| `processDestroyRegionTime` | Total time, in nanoseconds, spent in processing a cache client destroyRegion request, including the time to destroy the region from the cache. |
+| `processDestroyTime` | Total time, in nanoseconds, spent in processing a cache client destroy request, including the time to destroy an object from the cache. |
+| `processGetTime` | Total time, in nanoseconds, spent in processing a cache client get request, including the time to get an object from the cache. |
+| `processPutAllTime` | Total time, in nanoseconds, spent in processing a cache client putAll request, including the time to put all objects into the cache. |
+| `processPutTime` | Total time, in nanoseconds, spent in processing a cache client put request, including the time to put an object into the cache. |
+| `processQueryTime` | Total time, in nanoseconds, spent in processing a cache client query request, including the time to destroy an object from the cache. |
+| `processUpdateClientNotificationTime` | Total time, in nanoseconds, spent in processing a client notification update request. |
+| `putAllRequests` | Number of cache client operations putAll requests. |
+| `putAllResponses` | Number of putAllResponses written to the cache client. |
+| `putRequests` | Number of cache client operations put requests. |
+| `putResponses` | Number of putResponses written to the cache client. |
+| `queryRequests` | Number of cache client operations query requests. |
+| `queryResponses` | Number of query responses written to the cache client. |
+| `queueLoad` | The load from subscription queues as reported by the load probe installed in this server |
+| `readClearRegionRequestTime` | Total time, in nanoseconds, spent in reading clearRegion requests. |
+| `readClientNotificationRequestTime` | Total time, in nanoseconds, spent in reading client notification requests. |
+| `readClientReadyRequestTime` | Total time, in nanoseconds, spent in reading cache client ready requests. |
+| `readCloseConnectionRequestTime` | Total time, in nanoseconds, spent in reading close connection requests. |
+| `readContainsKeyRequestTime` | Total time, in nanoseconds, spent reading containsKey requests. |
+| `readDestroyRegionRequestTime` | Total time, in nanoseconds, spent in reading destroyRegion requests. |
+| `readDestroyRequestTime` | Total time, in nanoseconds, spent in reading destroy requests. |
+| `readGetRequestTime` | Total time, in nanoseconds, spent in reading get requests. |
+| `readProcessBatchRequestTime` | Total time, in nanoseconds, spent in reading processBatch requests. |
+| `readPutAllRequestTime` | Total time, in nanoseconds, spent in reading putAll requests. |
+| `readPutRequestTime` | Total time, in nanoseconds, spent in reading put requests. |
+| `readQueryRequestTime` | Total time, in nanoseconds, spent in reading query requests. |
+| `readUpdateClientNotificationRequestTime` | Total time, in nanoseconds, spent in reading client notification update requests. |
+| `receivedBytes` | Total number of bytes received from clients. |
+| `sentBytes` | Total number of bytes sent to clients. |
+| `threadQueueSize` | Current number of connections waiting for a thread to start processing their message. |
+| `updateClientNotificationRequests` | Number of cache client notification update requests. |
+| `writeClearRegionResponseTime` | Total time, in nanoseconds, spent in writing clearRegion responses. |
+| `writeClientReadyResponseTime` | Total time, in nanoseconds, spent in writing client ready responses. |
+| `writeContainsKeyResponseTime` | Total time, in nanoseconds, spent writing containsKey responses. |
+| `writeDestroyRegionResponseTime` | Total time, in nanoseconds, spent in writing destroyRegion responses. |
+| `writeDestroyResponseTime` | Total time, in nanoseconds, spent in writing destroy responses. |
+| `writeGetResponseTime` | Total time, in nanoseconds, spent in writing get responses. |
+| `writeProcessBatchResponseTime` | Total time, in nanoseconds, spent in writing processBatch responses. |
+| `writePutAllResponseTime` | Total time, in nanoseconds, spent in writing putAll responses. |
+| `writePutResponseTime` | Total time, in nanoseconds, spent in writing put responses. |
+| `writeQueryResponseTime` | Total time, in nanoseconds, spent in writing query responses. |
+
+## <a id="section_B08C0783BBF9489E8BB48B4AEC597C62" class="no-quick-link"></a>Client-Side Notifications (CacheClientUpdaterStats)
+
+Statistics in a client that pertain to server-to-client data pushed from the server over a queue to the client (they are the client side of the server’s `CacheClientNotifierStatistics`) :
+
+| Statistic | Description |
+|-----------------------------|----------------------------------------------------------------------------------------------|
+| `receivedBytes` | Total number of bytes received from the server. |
+| `messagesBeingReceived` | Current number of message being received off the network or being processed after reception. |
+| `messageBytesBeingReceived` | Current number of bytes consumed by messages being received or processed. |
+
+## <a id="section_04B7D7387E584712B7710B5ED1E876BB" class="no-quick-link"></a>Client-to-Server Messaging Performance (ClientStats)
+
+These statistics are in a client and they describe all the messages sent from the client to a specific server. The primary statistics are:
+
+| Statistic | Description |
+|----------------------------------------|-----------------------------------------------------------------------------------------------|
+| `clearFailures` | Total number of clear attempts that have failed. |
+| `clears` | Total number of clears completed successfully. |
+| `clearSendFailures` | Total number of clearSends that have failed. |
+| `clearSends` | Total number of clearSends that have completed successfully. |
+| `clearSendsInProgress` | Current number of clearSends being executed. |
+| `clearSendTime` | Total amount of time, in nanoseconds, spent doing clearSends. |
+| `clearsInProgress` | Current number of clears being executed. |
+| `clearTime` | Total amount of time, in nanoseconds, spent doing clears. |
+| `clearTimeouts` | Total number of clear attempts that have timed out. |
+| `closeConFailures` | Total number of closeCon attempts that have failed. |
+| `closeCons` | Total number of closeCons that have completed successfully. |
+| `closeConSendFailures` | Total number of closeConSends that have failed. |
+| `closeConSends` | Total number of closeConSends that have completed successfully. |
+| `closeConSendsInProgress` | Current number of closeConSends being executed. |
+| `closeConSendTime` | Total amount of time, in nanoseconds, spent doing closeConSends. |
+| `closeConsInProgress` | Current number of closeCons being executed. |
+| `closeConTime` | Total amount of time, in nanoseconds, spent doing closeCons. |
+| `closeConTimeouts` | Total number of closeCon attempts that have timed out. |
+| `connections` | Current number of connections. |
+| `connects` | Total number of times a connection has been created. |
+| `containsKeyFailures` | Total number of containsKey attempts that have failed. |
+| `containsKeys` | Total number of containsKeys that completed successfully. |
+| `containsKeySendFailures` | Total number of containsKeySends that have failed. |
+| `containsKeySends` | Total number of containsKeySends that have completed successfully. |
+| `containsKeySendsInProgress` | Current number of containsKeySends being executed. |
+| `containsKeySendTime` | Total amount of time, in nanoseconds, spent doing containsKeyends. |
+| `containsKeysInProgress` | Current number of containsKeys being executed. |
+| `containsKeyTime` | Total amount of time, in nanoseconds, spent doing containsKeys. |
+| `containsKeyTimeouts` | Total number of containsKey attempts that have timed out. |
+| `destroyFailures` | Total number of destroy attempts that have failed. |
+| `destroyRegionFailures` | Total number of destroyRegion attempts that have failed. |
+| `destroyRegions` | Total number of destroyRegions that have completed successfully. |
+| `destroyRegionSendFailures` | Total number of destroyRegionSends that have failed. |
+| `destroyRegionSends` | Total number of destroyRegionSends that have completed successfully. |
+| `destroyRegionSendsInProgress` | Current number of destroyRegionSends being executed. |
+| `destroyRegionSendTime` | Total amount of time, in nanoseconds, spent doing destroyRegionSends. |
+| `destroyRegionsInProgress` | Current number of destroyRegions being executed. |
+| `destroyRegionTime` | Total amount of time, in nanoseconds, spent doing destroyRegions. |
+| `destroyRegionTimeouts` | Total number of destroyRegion attempts that have timed out. |
+| `destroys` | Total number of destroys that have completed successfully. |
+| `destroySendFailures` | Total number of destroySends that have failed. |
+| `destroySends` | Total number of destroySends that have completed successfully. |
+| `destroySendsInProgress` | Current number of destroySends being executed. |
+| `destroySendTime` | Total amount of time, in nanoseconds, spent doing destroySends. |
+| `destroysInProgress` | Current number of destroys being executed. |
+| `destroyTime` | Total amount of time, in nanoseconds, spent doing destroys. |
+| `destroyTimeouts` | Total number of destroy attempts that have timed out. |
+| `disconnects` | Total number of times a connection has been destroyed. |
+| `gatewayBatchFailures` | Total number of gatewayBatch attempts that have failed. |
+| `gatewayBatchs` | Total number of gatewayBatchs completed successfully. |
+| `gatewayBatchSendFailures` | Total number of gatewayBatchSends that have failed. |
+| `gatewayBatchSends` | Total number of gatewayBatchSends that have completed successfully. |
+| `gatewayBatchSendsInProgress` | Current number of gatewayBatchSends being executed. |
+| `gatewayBatchSendTime` | Total amount of time, in nanoseconds, spent doing gatewayBatchSends. |
+| `gatewayBatchsInProgress` | Current number of gatewayBatchs being executed. |
+| `gatewayBatchTime` | Total amount of time, in nanoseconds, spent doing gatewayBatchs. |
+| `gatewayBatchTimeouts`
<TRUNCATED>
[4/5] geode git commit: GEODE-3395 Variable-ize product version and
name in user guide - Reference section
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/geode/blob/13ad4b6e/geode-docs/reference/statistics/statistics_list.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/reference/statistics/statistics_list.html.md.erb b/geode-docs/reference/statistics/statistics_list.html.md.erb
deleted file mode 100644
index 49e416e..0000000
--- a/geode-docs/reference/statistics/statistics_list.html.md.erb
+++ /dev/null
@@ -1,1310 +0,0 @@
----
-title: Geode Statistics List
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-<a id="statistics_list"></a>
-
-
-This section describes the primary statistics gathered by Geode when statistics are enabled.
-
-All statistics gathering requires the `gemfire.properties` `statistic-sampling-enabled` in `gemfire.properties` file to be true. Statistics that use time require the `gemfire.properties` `enable-time-statistics` to be true.
-
-Performance statistics are collected for each Java application or cache server that connects to a distributed system.
-
-- **[Cache Performance (CachePerfStats)](#section_DEF8D3644D3246AB8F06FE09A37DC5C8)**
-
-- **[Cache Server (CacheServerStats)](#section_EF5C2C59BFC74FFB8607F9571AB9A471)**
-
-- **[Client-Side Notifications (CacheClientUpdaterStats)](#section_B08C0783BBF9489E8BB48B4AEC597C62)**
-
-- **[Client-to-Server Messaging Performance (ClientStats)](#section_04B7D7387E584712B7710B5ED1E876BB)**
-
-- **[Client Connection Pool (PoolStats)](#section_6C247F61DB834C079A16BE92789D4692)**
-
-- **[Continuous Querying (CQStatistics)](#section_66C0E7748501480B85209D57D24256D5)**
-
-- **[Delta Propagation (DeltaPropagationStatistics)](#section_D4ABED3FF94245C0BEE0F6FC9481E867)**
-
-- **[Disk Space Usage (DiskDirStatistics)](#section_6C2BECC63A83456190B029DEDB8F4BE3)**
-
-- **[Disk Usage and Performance (DiskRegionStatistics)](#section_983BFC6D53C74829A04A91C39E06315F)**
-
-- **[Distributed System Messaging (DistributionStats)](#section_ACB4161F10D64BC0B15871D003FF6FDF)**
-
-- **[Distributed Lock Services (DLockStats)](#section_78D346A580724E1EA645E31626EECE40)**
-
-- **[Function Execution (FunctionServiceStatistics)](#section_5E211DDB0E8640689AD0A4659511E17A)**
-
-- **[Gateway Queue (GatewayStatistics)](#section_C4199A541B1F4B82B6178C416C0FAE4B)**
-
-- **[Indexes (IndexStats)](#section_86A61860024B480592DAC67FFB882538)**
-
-- **[JVM Performance](#section_607C3867602E410CAE5FAB26A7FF1CB9)**
-
-- **[Locator (LocatorStatistics)](#section_C48B654F973E4B44AD825D459C23A6CD)**
-
-- **[Lucene Indexes (LuceneIndexStats)](#LuceneStats)**
-
-- **[Off-Heap (OffHeapMemoryStats)](#topic_ohc_tjk_w5)**
-
-- **[Operating System Statistics - Linux](#section_923B28F01BC3416786D3AFBD87F22A5E)**
-
-- **[Partitioned Regions (PartitionedRegion<partitioned\_region\_name>Statistics)](#section_35AC170770C944C3A336D9AEC2D2F7C5)**
-
-- **[Region Entry Eviction – Count-Based (LRUStatistics)](#section_374FBD92A3B74F6FA08AA23047929B4F)**
-
-- **[Region Entry Eviction – Size-based (LRUStatistics)](#section_3D2AA2BCE5B6485699A7B6ADD1C49FF7)**
-
-- **[Server Notifications for All Clients (CacheClientNotifierStatistics)](#section_5362EF9AECBC48D69475697109ABEDFA)**
-
-- **[Server Notifications for Single Client (CacheClientProxyStatistics)](#section_E03865F509E543D9B8F9462B3DA6255E)**
-
-- **[Server-to-Client Messaging Performance (ClientSubscriptionStats)](#section_3AB1C0AA55014163A2BBF68E13D25E3A)**
-
-- **[Statistics Collection (StatSampler)](#section_55F3AF6413474317902845EE4996CC21)**
-
-## <a id="section_DEF8D3644D3246AB8F06FE09A37DC5C8" class="no-quick-link"></a>Cache Performance (CachePerfStats)
-
-Statistics for the Geode cache. These can be used to determine the type and number of cache operations being performed and how much time they consume.
-
-Regarding Geode cache transactions, transaction-related statistics are compiled and stored as properties in the CachePerfStats statistic resource. Because the transaction’s data scope is the cache, these statistics are collected on a per-cache basis.
-
-The primary statistics are:
-
-| Statistic | Description |
-|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `cacheListenerCallsCompleted` | Total number of times a cache listener call has completed. |
-| `cacheListenerCallsInProgress` | Current number of threads doing a cache listener call. |
-| `cacheListenerCallTime` | Total time spent doing cache listener calls. |
-| `cacheWriterCallsCompleted` | Total number of times a cache writer call has completed. |
-| `cacheWriterCallsInProgress` | Current number of threads doing a cache writer call. |
-| `cacheWriterCallTime` | Total time spent doing cache writer calls. |
-| `compressions` | Total number of compression operations. |
-| `compressTime` | Total time, in nanoseconds, spent compressing data. |
-| `conflatedEvents` | The number of events that were conflated, and not delivered to event listeners or gateway senders on this member. Events are typically conflated because a later event was already applied to the cache, or because a concurrent event was ignored to ensure cache consistency. Note that some members may discard an update while other members apply the update, depending on the order in which each member receives the update. For this reason, the `conflatedEvents` statistic will differ for each Geode member. See [Consistency for Region Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
-| `creates` | The total number of times an entry is added to this cache. |
-| `decompressions` | Total number of decompression operations. |
-| `decompressTime` | Total time, in nanoseconds, spent decompressing data. |
-| `destroys` | The total number of times a cache object entry has been destroyed in this cache. |
-| `eventQueueSize` | The number of cache events waiting to be processed. |
-| `eventQueueThrottleCount` | The total number of times a thread was delayed in adding an event to the event queue. |
-| `eventQueueThrottleTime` | The total amount of time, in nanoseconds, spent delayed by the event queue throttle. |
-| `eventThreads` | The number of threads currently processing events. |
-| `getInitialImageKeysReceived` | Total number of keys received while doing getInitialImage operations. |
-| `getInitialImagesCompleted` | Total number of times getInitialImages initiated by this cache have completed. |
-| `getInitialImagesInProgressDesc` | Current number of getInitialImage operations currently in progress. |
-| `getInitialImageTime` | Total time spent doing getInitialImages for region creation. |
-| `getsDesc` | The total number of times a successful get has been done on this cache. |
-| `getTime` | Total time spent doing get operations from this cache (including netsearch and netload). |
-| `invalidates` | The total number of times an existing cache object entry value in this cache has been invalidated. |
-| `loadsCompleted` | Total number of times a load on this cache has completed as a result of either a local get() or a remote netload. |
-| `loadsInProgress` | Current number of threads in this cache doing a cache load. |
-| `loadTime` | Total time spent invoking loaders on this cache. |
-| `misses` | Total number of times a get on the cache did not find a value already in local memory. The number of hits (that is, gets that did not miss) can be calculated by subtracting misses from gets. |
-| `netloadsCompleted` | Total number of times a network load initiated on this cache has completed. |
-| `netloadsInProgress` | Current number of threads doing a network load initiated by a get() in this cache. |
-| `netloadTime` | Total time spent doing network loads on this cache. |
-| `netsearchesCompleted` | Total number of times network searches initiated by this cache have completed. |
-| `netsearchesInProgress` | Current number of threads doing a network search initiated by a get() in this cache. |
-| `netsearchTimeDesc` | Total time spent doing network searches for cache values. |
-| `nonReplicatedTombstonesSize` | The approximate number of bytes that are currently consumed by tombstones in non-replicated regions. See [Consistency for Region Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
-| `partitionedRegions` | The current number of partitioned regions in the cache. |
-| `postCompressedBytes` | Total number of bytes after compressing. |
-| `preCompressedBytes` | Total number of bytes before compressing. |
-| `putAlls` | The total number of times a map is added or replaced in this cache as a result of a local operation. Note, this only counts putAlls done explicitly on this cache; it does not count updates pushed from other caches. |
-| `putallTime` | Total time spent replacing a map in this cache as a result of a local operation. This includes synchronizing on the map, invoking cache callbacks, sending messages to other caches and waiting for responses (if required). |
-| `puts` | The total number of times an entry is added or replaced in this cache as a result of a local operation (put(), create(), or get() which results in load, netsearch, or netloading a value). Note, this only counts puts done explicitly on this cache; it does not count updates pushed from other caches. |
-| `putTime` | Total time spent adding or replacing an entry in this cache as a result of a local operation. This includes synchronizing on the map, invoking cache callbacks, sending messages to other caches, and waiting for responses (if required). |
-| `queryExecutions` | Total number of times some query has been executed. |
-| `queryExecutionTime` | Total time spent executing queries. |
-| `regions` | The current number of regions in the cache. |
-| `replicatedTombstonesSize` | The approximate number of bytes that are currently consumed by tombstones in replicated or partitioned regions. See [Consistency for Region Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
-| `tombstoneCount` | The total number of tombstone entries created for performing concurrency checks. See [Consistency for Region Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
-| `tombstoneGCCount` | The total number of tombstone garbage collection cycles that a member has performed. See [Consistency for Region Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045). |
-| `txCommitChanges` | Total number of changes made by committed transactions. |
-| `txCommits` | Total number of times a transaction commit has succeeded. |
-| `txCommitTime` | The total amount of time, in nanoseconds, spent doing successful transaction commits. |
-| `txConflictCheckTime` | The total amount of time, in nanoseconds, spent doing conflict checks during transaction commit. |
-| `txFailedLifeTime` | The total amount of time, in nanoseconds, spent in a transaction before a failed commit. The time measured starts at transaction begin and ends when commit is called. |
-| `txFailureChanges` | Total number of changes lost by failed transactions. |
-| `txFailures` | Total number of times a transaction commit has failed. |
-| `txFailureTime` | The total amount of time, in nanoseconds, spent doing failed transaction commits. |
-| `txRollbackChanges` | Total number of changes lost by explicit transaction rollbacks. |
-| `txRollbackLifeTime` | The total amount of time, in nanoseconds, spent in a transaction before an explicit rollback. The time measured starts at transaction begin and ends when rollback is called. |
-| `txRollbacks` | Total number of times a transaction has been explicitly rolled back. |
-| `txRollbackTime` | The total amount of time, in nanoseconds, spent doing explicit transaction rollbacks. |
-| `txSuccessLifeTime` | The total amount of time, in nanoseconds, spent in a transaction before a successful commit. The time measured starts at transaction begin and ends when commit is called. |
-| `updates` | The total number of updates originating remotely that have been applied to this cache. |
-| `updateTime` | Total time spent performing an update. |
-
-## <a id="section_EF5C2C59BFC74FFB8607F9571AB9A471" class="no-quick-link"></a>Cache Server (CacheServerStats)
-
-Statistics used for cache servers and for gateway receivers are recorded in CacheServerStats in a cache server. The primary statistics are:
-
-| Statistic | Description |
-|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
-| `abandonedReadRequests` | Number of read operations (requests) abandoned by clients. |
-| `abandonedWriteRequests` | Number of write operations (requests) abandoned by clients. |
-| `acceptsInProgress` | Current number of server accepts that are attempting to do the initial handshake with the client. |
-| `acceptThreadStarts` | Total number of threads created (starts) to deal with an accepted socket. Note, this is not the current number of threads. |
-| `batchSize` | The size (in bytes) of the batches received. |
-| `clearRegionRequests` | Number of cache client operations clearRegion requests. |
-| `clearRegionResponses` | Number of clearRegion responses written to the cache client. |
-| `clientNotificationRequests` | Number of cache client operations notification requests. |
-| `clientReadyRequests` | Number of cache client ready requests. |
-| `clientReadyResponses` | Number of client ready responses written to the cache client. |
-| `closeConnectionRequests` | Number of cache client close connection operations requests. |
-| `connectionLoad` | The load from client to server connections as reported by the load probe installed in this server. |
-| `connectionsTimedOut` | Total number of connections that have been timed out by the server because of client inactivity. |
-| `connectionThreads` | Current number of threads dealing with a client connection. |
-| `connectionThreadStarts` | Total number of threads created (starts) to deal with a client connection. Note, this is not the current number of threads. |
-| `containsKeyRequests` | Number of cache client operations containsKey requests. |
-| `containsKeyResponses` | Number of containsKey responses written to the cache client. |
-| `currentClientConnections` | Number of sockets accepted. |
-| `currentClients` | Number of client virtual machines (clients) connected. |
-| `destroyRegionRequests` | Number of cache client operations destroyRegion requests. |
-| `destroyRegionResponses` | Number of destroyRegion responses written to the cache client. |
-| `destroyRequests` | Number of cache client operations destroy requests. |
-| `destroyResponses` | Number of destroy responses written to the cache client. |
-| `failedConnectionAttempts` | Number of failed connection attempts. |
-| `getRequests` | Number of cache client operations get requests. |
-| `getResponses` | Number of getResponses written to the cache client. |
-| `loadPerConnection` | The estimate of how much load i.s added for each new connection as reported by the load probe installed in this server. |
-| `loadPerQueue` | The estimate of how much load would be added for each new subscription connection as reported by the load probe installed in this server. |
-| `messageBytesBeingReceived` | Current number of bytes consumed by messages being received or processed. |
-| `messagesBeingReceived` | Current number of messages being received off the network or being processed after reception. |
-| `outOfOrderGatewayBatchIds` | Number of Out of Order batch IDs (batches). |
-| `processBatchRequests` | Number of cache client operations processBatch requests. |
-| `processBatchResponses` | Number of processBatch responses written to the cache client. |
-| `processBatchTime` | Total time, in nanoseconds, spent in processing a cache client processBatch request. |
-| `processClearRegionTime` | Total time, in nanoseconds, spent in processing a cache client clearRegion request, including the time to clear the region from the cache. |
-| `processClientNotificationTime` | Total time, in nanoseconds, spent in processing a cache client notification request. |
-| `processClientReadyTime` | Total time, in nanoseconds, spent in processing a cache client ready request, including the time to destroy an object from the cache. |
-| `processCloseConnectionTime` | Total time, in nanoseconds, spent in processing a cache client close connection request. |
-| `processContainsKeyTime` | Total time spent, in nanoseconds, processing a containsKey request. |
-| `processDestroyRegionTime` | Total time, in nanoseconds, spent in processing a cache client destroyRegion request, including the time to destroy the region from the cache. |
-| `processDestroyTime` | Total time, in nanoseconds, spent in processing a cache client destroy request, including the time to destroy an object from the cache. |
-| `processGetTime` | Total time, in nanoseconds, spent in processing a cache client get request, including the time to get an object from the cache. |
-| `processPutAllTime` | Total time, in nanoseconds, spent in processing a cache client putAll request, including the time to put all objects into the cache. |
-| `processPutTime` | Total time, in nanoseconds, spent in processing a cache client put request, including the time to put an object into the cache. |
-| `processQueryTime` | Total time, in nanoseconds, spent in processing a cache client query request, including the time to destroy an object from the cache. |
-| `processUpdateClientNotificationTime` | Total time, in nanoseconds, spent in processing a client notification update request. |
-| `putAllRequests` | Number of cache client operations putAll requests. |
-| `putAllResponses` | Number of putAllResponses written to the cache client. |
-| `putRequests` | Number of cache client operations put requests. |
-| `putResponses` | Number of putResponses written to the cache client. |
-| `queryRequests` | Number of cache client operations query requests. |
-| `queryResponses` | Number of query responses written to the cache client. |
-| `queueLoad` | The load from subscription queues as reported by the load probe installed in this server |
-| `readClearRegionRequestTime` | Total time, in nanoseconds, spent in reading clearRegion requests. |
-| `readClientNotificationRequestTime` | Total time, in nanoseconds, spent in reading client notification requests. |
-| `readClientReadyRequestTime` | Total time, in nanoseconds, spent in reading cache client ready requests. |
-| `readCloseConnectionRequestTime` | Total time, in nanoseconds, spent in reading close connection requests. |
-| `readContainsKeyRequestTime` | Total time, in nanoseconds, spent reading containsKey requests. |
-| `readDestroyRegionRequestTime` | Total time, in nanoseconds, spent in reading destroyRegion requests. |
-| `readDestroyRequestTime` | Total time, in nanoseconds, spent in reading destroy requests. |
-| `readGetRequestTime` | Total time, in nanoseconds, spent in reading get requests. |
-| `readProcessBatchRequestTime` | Total time, in nanoseconds, spent in reading processBatch requests. |
-| `readPutAllRequestTime` | Total time, in nanoseconds, spent in reading putAll requests. |
-| `readPutRequestTime` | Total time, in nanoseconds, spent in reading put requests. |
-| `readQueryRequestTime` | Total time, in nanoseconds, spent in reading query requests. |
-| `readUpdateClientNotificationRequestTime` | Total time, in nanoseconds, spent in reading client notification update requests. |
-| `receivedBytes` | Total number of bytes received from clients. |
-| `sentBytes` | Total number of bytes sent to clients. |
-| `threadQueueSize` | Current number of connections waiting for a thread to start processing their message. |
-| `updateClientNotificationRequests` | Number of cache client notification update requests. |
-| `writeClearRegionResponseTime` | Total time, in nanoseconds, spent in writing clearRegion responses. |
-| `writeClientReadyResponseTime` | Total time, in nanoseconds, spent in writing client ready responses. |
-| `writeContainsKeyResponseTime` | Total time, in nanoseconds, spent writing containsKey responses. |
-| `writeDestroyRegionResponseTime` | Total time, in nanoseconds, spent in writing destroyRegion responses. |
-| `writeDestroyResponseTime` | Total time, in nanoseconds, spent in writing destroy responses. |
-| `writeGetResponseTime` | Total time, in nanoseconds, spent in writing get responses. |
-| `writeProcessBatchResponseTime` | Total time, in nanoseconds, spent in writing processBatch responses. |
-| `writePutAllResponseTime` | Total time, in nanoseconds, spent in writing putAll responses. |
-| `writePutResponseTime` | Total time, in nanoseconds, spent in writing put responses. |
-| `writeQueryResponseTime` | Total time, in nanoseconds, spent in writing query responses. |
-
-## <a id="section_B08C0783BBF9489E8BB48B4AEC597C62" class="no-quick-link"></a>Client-Side Notifications (CacheClientUpdaterStats)
-
-Statistics in a client that pertain to server-to-client data pushed from the server over a queue to the client (they are the client side of the server’s `CacheClientNotifierStatistics`) :
-
-| Statistic | Description |
-|-----------------------------|----------------------------------------------------------------------------------------------|
-| `receivedBytes` | Total number of bytes received from the server. |
-| `messagesBeingReceived` | Current number of message being received off the network or being processed after reception. |
-| `messageBytesBeingReceived` | Current number of bytes consumed by messages being received or processed. |
-
-## <a id="section_04B7D7387E584712B7710B5ED1E876BB" class="no-quick-link"></a>Client-to-Server Messaging Performance (ClientStats)
-
-These statistics are in a client and they describe all the messages sent from the client to a specific server. The primary statistics are:
-
-| Statistic | Description |
-|----------------------------------------|-----------------------------------------------------------------------------------------------|
-| `clearFailures` | Total number of clear attempts that have failed. |
-| `clears` | Total number of clears completed successfully. |
-| `clearSendFailures` | Total number of clearSends that have failed. |
-| `clearSends` | Total number of clearSends that have completed successfully. |
-| `clearSendsInProgress` | Current number of clearSends being executed. |
-| `clearSendTime` | Total amount of time, in nanoseconds, spent doing clearSends. |
-| `clearsInProgress` | Current number of clears being executed. |
-| `clearTime` | Total amount of time, in nanoseconds, spent doing clears. |
-| `clearTimeouts` | Total number of clear attempts that have timed out. |
-| `closeConFailures` | Total number of closeCon attempts that have failed. |
-| `closeCons` | Total number of closeCons that have completed successfully. |
-| `closeConSendFailures` | Total number of closeConSends that have failed. |
-| `closeConSends` | Total number of closeConSends that have completed successfully. |
-| `closeConSendsInProgress` | Current number of closeConSends being executed. |
-| `closeConSendTime` | Total amount of time, in nanoseconds, spent doing closeConSends. |
-| `closeConsInProgress` | Current number of closeCons being executed. |
-| `closeConTime` | Total amount of time, in nanoseconds, spent doing closeCons. |
-| `closeConTimeouts` | Total number of closeCon attempts that have timed out. |
-| `connections` | Current number of connections. |
-| `connects` | Total number of times a connection has been created. |
-| `containsKeyFailures` | Total number of containsKey attempts that have failed. |
-| `containsKeys` | Total number of containsKeys that completed successfully. |
-| `containsKeySendFailures` | Total number of containsKeySends that have failed. |
-| `containsKeySends` | Total number of containsKeySends that have completed successfully. |
-| `containsKeySendsInProgress` | Current number of containsKeySends being executed. |
-| `containsKeySendTime` | Total amount of time, in nanoseconds, spent doing containsKeyends. |
-| `containsKeysInProgress` | Current number of containsKeys being executed. |
-| `containsKeyTime` | Total amount of time, in nanoseconds, spent doing containsKeys. |
-| `containsKeyTimeouts` | Total number of containsKey attempts that have timed out. |
-| `destroyFailures` | Total number of destroy attempts that have failed. |
-| `destroyRegionFailures` | Total number of destroyRegion attempts that have failed. |
-| `destroyRegions` | Total number of destroyRegions that have completed successfully. |
-| `destroyRegionSendFailures` | Total number of destroyRegionSends that have failed. |
-| `destroyRegionSends` | Total number of destroyRegionSends that have completed successfully. |
-| `destroyRegionSendsInProgress` | Current number of destroyRegionSends being executed. |
-| `destroyRegionSendTime` | Total amount of time, in nanoseconds, spent doing destroyRegionSends. |
-| `destroyRegionsInProgress` | Current number of destroyRegions being executed. |
-| `destroyRegionTime` | Total amount of time, in nanoseconds, spent doing destroyRegions. |
-| `destroyRegionTimeouts` | Total number of destroyRegion attempts that have timed out. |
-| `destroys` | Total number of destroys that have completed successfully. |
-| `destroySendFailures` | Total number of destroySends that have failed. |
-| `destroySends` | Total number of destroySends that have completed successfully. |
-| `destroySendsInProgress` | Current number of destroySends being executed. |
-| `destroySendTime` | Total amount of time, in nanoseconds, spent doing destroySends. |
-| `destroysInProgress` | Current number of destroys being executed. |
-| `destroyTime` | Total amount of time, in nanoseconds, spent doing destroys. |
-| `destroyTimeouts` | Total number of destroy attempts that have timed out. |
-| `disconnects` | Total number of times a connection has been destroyed. |
-| `gatewayBatchFailures` | Total number of gatewayBatch attempts that have failed. |
-| `gatewayBatchs` | Total number of gatewayBatchs completed successfully. |
-| `gatewayBatchSendFailures` | Total number of gatewayBatchSends that have failed. |
-| `gatewayBatchSends` | Total number of gatewayBatchSends that have completed successfully. |
-| `gatewayBatchSendsInProgress` | Current number of gatewayBatchSends being executed. |
-| `gatewayBatchSendTime` | Total amount of time, in nanoseconds, spent doing gatewayBatchSends. |
-| `gatewayBatchsInProgress` | Current number of gatewayBatchs being executed. |
-| `gatewayBatchTime` | Total amount of time, in nanoseconds, spent doing gatewayBatchs.
<TRUNCATED>