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/feature/GEODE-1279 Commit: 13ad4b6e07d80cd9961f6fbd634213c462315073 Parents: c1129c7 Author: Dave Barnes <[email protected]> Authored: Mon Aug 14 15:22:16 2017 -0700 Committer: Dave Barnes <[email protected]> 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.
