geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kmil...@apache.org
Subject incubator-geode git commit: GEODE-2090 Update off-heap statistics documentation
Date Thu, 10 Nov 2016 16:58:32 GMT
Repository: incubator-geode
Updated Branches:
  refs/heads/develop e7e372368 -> 88e5d0f15


GEODE-2090 Update off-heap statistics documentation

- add/correct the gfsh show metrics command reference
page to include the offheap category for when the member
is specified
- in the list of OffHeapMemoryStats, correct the name of
a statistic:  compactions should be defragmentations


Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/88e5d0f1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/88e5d0f1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/88e5d0f1

Branch: refs/heads/develop
Commit: 88e5d0f154b919d1f73316cd0ea01970e40a4067
Parents: e7e3723
Author: Karen Miller <kmiller@pivotal.io>
Authored: Wed Nov 9 16:36:48 2016 -0800
Committer: Karen Miller <kmiller@pivotal.io>
Committed: Thu Nov 10 08:58:19 2016 -0800

----------------------------------------------------------------------
 geode-docs/reference/statistics/statistics_list.html.md.erb  | 2 +-
 geode-docs/tools_modules/gfsh/command-pages/show.html.md.erb | 7 +++++--
 2 files changed, 6 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/88e5d0f1/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
index 02ed6a7..7f7b76f 100644
--- a/geode-docs/reference/statistics/statistics_list.html.md.erb
+++ b/geode-docs/reference/statistics/statistics_list.html.md.erb
@@ -1012,7 +1012,7 @@ These statistics quantify the use of off-heap memory. The primary statistics
are
 
 | Statistic             | Description                                                   
                                                                                         
                                                                                         
                                                                                         
                                                                                         
                                                                                         
   |
 |-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `compactions`         | The total number of times the off-heap memory manager has invoked
the defragmentation algorithm on the off-heap memory space.                              
                                                                                         
                                                                                         
                                                                                         
                                                                                         
|
+| `defragmentations`         | The total number of times the off-heap memory manager has
invoked the defragmentation algorithm on the off-heap memory space.                      
                                                                                         
                                                                                         
                                                                                         
                                                                                         
        |
 | `defragmentationsInProgress` | The number of defragmentation operations currently in progress.
                                                                                         
                                                                                         
                                                                                         
                                                                                         
                                            |
 | `defragmentationTime` | The total number of nanoseconds spent running the defragmentation
algorithm on off-heap memory space fragments.                                            
                                                                                         
                                                                                         
                                                                                         
                                                                                         
|
 | `fragmentation`       | This statistic gives an indication of the level of external fragmentation
in the off-heap memory space by providing a ratio of the current number of fragments of free
space to the largest number of fragments that could be formed from that free space. It is
expressed as a percentage; the higher this value, the more fragmented the free space currently
is. This statistic is 0 if the memory manager has never run its defragmentation algorithm
on the off-heap space, and it is recalculated after each defragmentation. |

http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/88e5d0f1/geode-docs/tools_modules/gfsh/command-pages/show.html.md.erb
----------------------------------------------------------------------
diff --git a/geode-docs/tools_modules/gfsh/command-pages/show.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/show.html.md.erb
index 98009f1..881c1c6 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/show.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/show.html.md.erb
@@ -123,6 +123,10 @@ r=server1 --lines=5".
 
 Display or export metrics for the entire distributed system, a member or a region.
 
+When no command line arguments are given,
+metrics under the categories of cluster, cache, diskstore, and query
+are displayed.
+
 **Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use
this command.
 
 **Syntax:**
@@ -167,9 +171,8 @@ show metrics [--member=value] [--region=value] [--file=value]
 <td><span class="keyword parmname">\-\-categories</span></td>
 <td>Categories available based upon the parameters specified (listed above) are:
 <ul>
-<li><strong>no parameters specified</strong>: cluster, cache, diskstore,
query</li>
 <li><strong>region specified</strong>: cluster, region, partition, diskstore,
callback, eviction</li>
-<li><strong>member specified</strong>: member, jvm, region, serialization,
communication, function, transaction, diskstore, lock, eviction, distribution</li>
+<li><strong>member specified</strong>: member, jvm, region, serialization,
communication, function, transaction, diskstore, lock, eviction, distribution, offheap</li>
 <li><strong>member and region specified</strong>: region, partition, diskstore,
callback, eviction</li>
 </ul></td>
 </tr>


Mime
View raw message