Repository: geode Updated Branches: refs/heads/develop d0cfba9b5 -> 001f66242 (forced update)
GEODE-2251: Improve Statistics Interface/Implementation graphics Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/001f6624 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/001f6624 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/001f6624 Branch: refs/heads/develop Commit: 001f662423ac48d7e9ec1039d0a4fea90b78109e Parents: 6992fcf Author: Dave Barnes <dbar...@pivotal.io> Authored: Tue Dec 27 15:35:15 2016 -0800 Committer: Dave Barnes <dbar...@pivotal.io> Committed: Tue Dec 27 16:10:31 2016 -0800 ---------------------------------------------------------------------- geode-docs/images/Statistics-implementation.png | Bin 0 -> 28057 bytes geode-docs/images/Statistics-interfaces.png | Bin 0 -> 28312 bytes geode-docs/images/statistics-1.gif | Bin 8644 -> 0 bytes .../application_defined_statistics.html.md.erb | 28 +++++++++++++++++-- 4 files changed, 26 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/001f6624/geode-docs/images/Statistics-implementation.png ---------------------------------------------------------------------- diff --git a/geode-docs/images/Statistics-implementation.png b/geode-docs/images/Statistics-implementation.png new file mode 100644 index 0000000..4e3bf91 Binary files /dev/null and b/geode-docs/images/Statistics-implementation.png differ http://git-wip-us.apache.org/repos/asf/geode/blob/001f6624/geode-docs/images/Statistics-interfaces.png ---------------------------------------------------------------------- diff --git a/geode-docs/images/Statistics-interfaces.png b/geode-docs/images/Statistics-interfaces.png new file mode 100644 index 0000000..412b51c Binary files /dev/null and b/geode-docs/images/Statistics-interfaces.png differ http://git-wip-us.apache.org/repos/asf/geode/blob/001f6624/geode-docs/images/statistics-1.gif ---------------------------------------------------------------------- diff --git a/geode-docs/images/statistics-1.gif b/geode-docs/images/statistics-1.gif deleted file mode 100644 index 75652f5..0000000 Binary files a/geode-docs/images/statistics-1.gif and /dev/null differ http://git-wip-us.apache.org/repos/asf/geode/blob/001f6624/geode-docs/managing/statistics/application_defined_statistics.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/statistics/application_defined_statistics.html.md.erb b/geode-docs/managing/statistics/application_defined_statistics.html.md.erb index 2ae5068..34461da 100644 --- a/geode-docs/managing/statistics/application_defined_statistics.html.md.erb +++ b/geode-docs/managing/statistics/application_defined_statistics.html.md.erb @@ -32,8 +32,32 @@ The Geode package, `org.apache.geode`, includes the following interfaces for def The statistics interfaces are instantiated using statistics factory methods that are included in the package. For coding examples, see the online Java API documentation for `StatisticsFactory` and `StatisticsTypeFactory`. -As an example, an application server might collect statistics on each client session in order to gauge whether client requests are being processed in a satisfactory manner. Long request queues or long server response times could prompt some capacity-management action such as starting additional application servers. To set this up, each session-state data point is identified and defined in a `StatisticDescriptor` instance. One instance might be a `RequestsInQueue` gauge, a non-negative integer that increments and decrements. Another could be a `RequestCount` counter, an integer that always increments. A list of these descriptors is used to instantiate a `SessionStateStats` `StatisticsType`. When a client connects, the application server uses the `StatisticsType` object to create a session-specific `Statistics` object. The server then uses the `Statistics` methods to modify and retrieve the clientâs statistics. This figure illustrates the relationships between the statistics interfa ces and shows the implementation of this use case. +As an example, an application server might collect statistics on each client session in order to +gauge whether client requests are being processed in a satisfactory manner. Long request queues or +long server response times could prompt some capacity-management action such as starting additional +application servers. To set this up, each session-state data point is identified and defined in a +`StatisticDescriptor` instance. One instance might be a `RequestsInQueue` gauge, a non-negative +integer that increments and decrements. Another could be a `RequestCount` counter, an integer that +always increments. A list of these descriptors is used to instantiate a `SessionStateStats` +`StatisticsType`. When a client connects, the application server uses the `StatisticsType` object to +create a session-specific `Statistics` object. The server then uses the `Statistics` methods to +modify and retrieve the clientâs statistics. The figures below illustrate the relationships between the +statistics interfaces and show the implementation of this use case. -<img src="../../images/statistics-1.gif" id="application_defined_statistics__image_1fb717d9-4fe3-43c2-aeaa-bdceda5639d8" class="image" /> +<img src="../../images/Statistics-interfaces.png" class="image" /> + +*The Statistics Interfaces* + +Each `StatisticDescriptor` contains one piece of statistical information. `StatisticalDesriptor`s +are collected into a `StatisticsType`. The `StatisticsType` is instantiated to create a `Statistics` +object. + +<img src="../../images/Statistics-implementation.png" class="image" /> + +*Statistics Implementation* + +The `StatisticDescriptor`s shown here hold three pieces of statistical information about client +session state. These are collected into a `SessionStateStats StatisticsType`. With this type, the +server creates a `Statistics` object for each client that connects.
