[28/31] incubator-tinkerpop git commit: Added a section for Gremlin Server metrics to reference docs.

[dk...@apache.org]

Added a section for Gremlin Server metrics to reference docs.


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

Branch: refs/heads/docker
Commit: c8732958f072691b3a040c4f5cdc36502882fa4e
Parents: 8f2fd15
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Mar 28 12:12:16 2016 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Mar 28 12:12:16 2016 -0400

----------------------------------------------------------------------
 .../src/reference/gremlin-applications.asciidoc | 27 ++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/c8732958/docs/src/reference/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc
index 8d4936a..379780c 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -1154,8 +1154,8 @@ Gremlin Server can accept requests and return results using different serializat
 serialization is configured by the `serializers` setting described in the table above.  Note that some serializers
 have additional configuration options as defined by the `serializers[X].config` setting.  The `config` setting is a
 `Map` where the keys and values get passed to the serializer at its initialization.  The available and/or expected
- keys are dependent on the serializer being used.  Gremlin Server comes packaged with two different serializers:
- GraphSON and Gryo.
+keys are dependent on the serializer being used.  Gremlin Server comes packaged with two different serializers:
+GraphSON and Gryo.
 
 GraphSON
 ++++++++
@@ -1222,6 +1222,29 @@ important to use cases where server types need to be coerced to client types (i.
 but not on the client).  Implementations should typically instantiate `ClassResolver` implementations that are
 extensions of the `GryoClassResolver` as this class is important to most serialization tasks in TinkerPop.
 
+Metrics
+^^^^^^^
+
+Gremlin Server produces metrics about its operations that can yield some insight into how it is performing. These
+metrics are exposed in a variety of ways:
+
+* Directly to the console where Gremlin Server is running
+* CSV file
+* link:http://ganglia.info/[Ganglia]
+* link:http://graphite.wikidot.com/[Graphite]
+* link:http://www.slf4j.org/[SLF4j]
+* link:https://en.wikipedia.org/wiki/Java_Management_Extensions[JMX]
+
+The configuration of each of these outputs is described in the Gremlin Server <<_configuring_2, Configuring>> section.
+Regardless of the output, the metrics gathered are the same. Each metric is prefixed with
+`org.apache.tinkerpop.gremlin.server.GremlinServer` and the following metrics are reported:
+
+* `sessions` - the number of sessions open at the time the metric was last measured.
+* `errors` - the number of total errors, mean rate, as well as the 1, 5, and 15-minute error rates.
+* `op.eval` - the number of script evaluations, mean rate, 1, 5, and 15 minute rates, minimum, maximum, median, mean,
+and standard deviation evaluation times, as well as the 75th, 95th, 98th, 99th and 99.9th percentile evaluation times
+(note that these time apply to both sessionless and in-session requests).
+
 Best Practices
 ~~~~~~~~~~~~~~