TINKERPOP-1644 Docs for new metrics in Gremlin Server

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

Branch: refs/heads/TINKERPOP-1642
Commit: 37976526f1eac9fd06858f962f979aa98d3e5346
Parents: 9eb248e
Author: Stephen Mallette <[email protected]>
Authored: Thu Mar 9 13:35:44 2017 -0500
Committer: Stephen Mallette <[email protected]>
Committed: Fri Mar 10 11:13:03 2017 -0500

----------------------------------------------------------------------
 docs/src/reference/gremlin-applications.asciidoc   |  5 +++++
 docs/src/upgrade/release-3.2.x-incubating.asciidoc | 10 ++++++++++
 2 files changed, 15 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/37976526/docs/src/reference/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/gremlin-applications.asciidoc 
b/docs/src/reference/gremlin-applications.asciidoc
index 8e0edc2..37244e0 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -1560,6 +1560,11 @@ and standard deviation evaluation times, as well as the 
75th, 95th, 98th, 99th a
 * `op.traversal` - the number of `Traveral` executions, 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.
+* `engine-name.session.session-id.*` - metrics related to different 
`GremlinScriptEngine` instanc configured for
+session-based requests where "engine-name" will be the actual name of the 
engine, such as "gremlin-groovy" and
+"session-id" will be the identifier for the session itself.
+* `engine-name.sessionless.*` - metrics related to different 
`GremlinScriptEngine` instanc configured for sessionless
+requests where "engine-name" will be the actual name of the engine, such as 
"gremlin-groovy".
 
 Best Practices
 ~~~~~~~~~~~~~~

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/37976526/docs/src/upgrade/release-3.2.x-incubating.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/upgrade/release-3.2.x-incubating.asciidoc 
b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
index 78c276b..d01f58f 100644
--- a/docs/src/upgrade/release-3.2.x-incubating.asciidoc
+++ b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
@@ -32,6 +32,16 @@ Please see the 
link:https://github.com/apache/tinkerpop/blob/3.2.5/CHANGELOG.asc
 Upgrading for Users
 ~~~~~~~~~~~~~~~~~~~
 
+GremlinScriptEngine Metrics
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The `GremlinScriptEngine` has a number of new metrics about its cache size and 
script compilation times which should
+be helpful in understanding usage problems. As `GremlinScriptEngine` instances 
are used in Gremlin Server these metrics
+are naturally exposed as part of the standard 
link:http://tinkerpop.apache.org/docs/current/reference/#_metrics[metrics]
+set. Note that metrics are captured for both sessionless requests as well as 
for each individual session that is opened.
+
+See: https://issues.apache.org/jira/browse/TINKERPOP-1644[TINKERPOP-1644]
+
 Gremlin-Python Driver
 ^^^^^^^^^^^^^^^^^^^^^
 Gremlin-Python now offers a more complete driver implementation that uses 
connection pooling and

Reply via email to