You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by dk...@apache.org on 2015/06/05 20:46:48 UTC
[18/26] incubator-tinkerpop git commit: Updates to docs/javadoc
around Gremlin Server Settings.
Updates to docs/javadoc around Gremlin Server Settings.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/0815f382
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/0815f382
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/0815f382
Branch: refs/heads/preprocessor
Commit: 0815f382239c2278dbeabf8a0abf35938570072b
Parents: 1a94fb9
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Jun 5 08:12:45 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Jun 5 08:12:45 2015 -0400
----------------------------------------------------------------------
docs/src/gremlin-applications.asciidoc | 9 ++++++++-
.../apache/tinkerpop/gremlin/server/Settings.java | 15 ++++++---------
2 files changed, 14 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/0815f382/docs/src/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/gremlin-applications.asciidoc b/docs/src/gremlin-applications.asciidoc
index 282702e..e0a55f0 100644
--- a/docs/src/gremlin-applications.asciidoc
+++ b/docs/src/gremlin-applications.asciidoc
@@ -473,10 +473,15 @@ The following table describes the various configuration options that Gremlin Ser
[width="100%",cols="3,10,^2",options="header"]
|=========================================================
|Key |Description |Default
-|channelizer |Defines the `Channelizer` implementation to use. A `Channelizer` is a "channel initializer" which Gremlin Server uses to define the type of processing pipeline to use. By allowing different `Channelizer` implementations, Gremlin Server can support different communication protocols (e.g. Websockets, Java NIO, etc.). |WebSocketChannelizer,HttpChannelizer
+|channelizer |The fully qualified classname of the `Channelizer` implementation to use. A `Channelizer` is a "channel initializer" which Gremlin Server uses to define the type of processing pipeline to use. By allowing different `Channelizer` implementations, Gremlin Server can support different communication protocols (e.g. Websockets, Java NIO, etc.). |WebSocketChannelizer
|graphs |A `Map` of `Graph` configuration files where the key of the `Map` becomes the name to which the `Graph` will be bound and the value is the file name of a `Graph` configuration file. |_none_
|gremlinPool |The number of "Gremlin" threads available to execute actual scripts in a `ScriptEngine`. This pool represents the workers available to handle blocking operations in Gremlin Server. |8
|host |The name of the host to bind the server to. |localhost
+|maxAccumulationBufferComponents |Maximum number of request components that can be aggregated for a message. |1024
+|maxChunkSize |The maximum length of the content or each chunk. If the content length exceeds this value, the transfer encoding of the decoded request will be converted to 'chunked' and the content will be split into multiple `HttpContent` objects. If the transfer encoding of the HTTP request is 'chunked' already, each chunk will be split into smaller chunks if the length of the chunk exceeds this value. |8192
+|maxContentLength |The maximum length of the aggregated content for a message. Works in concert with `maxChunkSize` where chunked requests are accumulated back into a single message. A request exceeding this size will return a `413 - Request Entity Too Large` status code. A response exceeding this size will raise an internal exception. |65536
+|maxHeaderSize |The maximum length of all headers. |8192
+|maxInitialLineLength |The maximum length of the initial line (e.g. "GET / HTTP/1.0") processed in a request, which essentially controls the maximum length of the submitted URI. |4096
|metrics.consoleReporter.enabled |Turns on console reporting of metrics. |false
|metrics.consoleReporter.interval |Time in milliseconds between reports of metrics to console. |180000
|metrics.csvReporter.enabled |Turns on CSV reporting of metrics. |false
@@ -518,6 +523,8 @@ The following table describes the various configuration options that Gremlin Ser
|ssl.trustCertChainFile |Trusted certificates for verifying the remote endpoint's certificate. The file should contain an X.509 certificate chain in PEM format. A system default will be used if this setting is not present. |_none_
|threadPoolBoss |The number of threads available to Gremlin Server for accepting connections. Should always be set to `1`. |1
|threadPoolWorker |The number of threads available to Gremlin Server for processing non-blocking reads and writes. |1
+|writeBufferHighWaterMark | If the number of bytes in the network send buffer exceeds this value then the channel is no longer writeable, accepting no additional writes until buffer is drained and the `writeBufferLowWaterMark` is met. |65536
+|writeBufferLowWaterMark | Once the number of bytes queued in the network send buffer exceeds the `writeBufferHighWaterMark`, the channel will not become writeable again until the buffer is drained and it drops below this value. |65536
|=========================================================
NOTE: Configuration of link:http://ganglia.sourceforge.net/[Ganglia] requires an additional library that is not packaged with Gremlin Server due to its LGPL licensing that conflicts with the TinkerPop's Apache 2.0 License. To run Gremlin Server with Ganglia monitoring, download the `org.acplt:oncrpc` jar from link:http://repo1.maven.org/maven2/org/acplt/oncrpc/1.0.7/[here] and copy it to the Gremlin Server `/lib` directory before starting the server.
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/0815f382/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
index 1fa98b6..c1d331a 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
@@ -89,14 +89,13 @@ public class Settings {
public int resultIterationBatchSize = 64;
/**
- * The maximum length of the initial line (e.g. {@code "GET / HTTP/1.0"}) processed in a request, which typically
+ * The maximum length of the initial line (e.g. {@code "GET / HTTP/1.0"}) processed in a request, which essentially
* controls the maximum length of the submitted URI. This setting ties to the Netty {@code HttpRequestDecoder}.
*/
public int maxInitialLineLength = 4096;
/**
- * The maximum length of all headers. If the sum of the length of each header exceeds this value. This setting
- * ties to the Netty {@code HttpRequestDecoder}
+ * The maximum length of all headers. This setting ties to the Netty {@code HttpRequestDecoder}
*/
public int maxHeaderSize = 8192;
@@ -104,8 +103,7 @@ public class Settings {
* The maximum length of the content or each chunk. If the content length exceeds this value, the transfer
* encoding of the decoded request will be converted to 'chunked' and the content will be split into multiple
* {@code HttpContent}s. If the transfer encoding of the HTTP request is 'chunked' already, each chunk will be
- * split into smaller chunks if the length of the chunk exceeds this value. This setting ties to the Netty
- * {@code HttpRequestDecoder}
+ * split into smaller chunks if the length of the chunk exceeds this value.
*/
public int maxChunkSize = 8192;
@@ -115,7 +113,7 @@ public class Settings {
* return a 413 - Request Entity Too Large status code. A response exceeding this size will raise an internal
* exception.
*/
- public int maxContentLength = 65536;
+ public int maxContentLength = 1024 * 64;
/**
* Maximum number of request components that can be aggregated for a message.
@@ -124,7 +122,7 @@ public class Settings {
/**
* If the number of bytes in the network send buffer exceeds this value then the channel is no longer writeable,
- * accepting no additional writes until buffer is drained and the low water mark is met.
+ * accepting no additional writes until buffer is drained and the {@link #writeBufferLowWaterMark} is met.
*/
public int writeBufferHighWaterMark = 1024 * 64;
@@ -135,8 +133,7 @@ public class Settings {
public int writeBufferLowWaterMark = 1024 * 32;
/**
- * The full class name of the {@link Channelizer} to use in
- * Gremlin Server.
+ * The full class name of the {@link Channelizer} to use in Gremlin Server.
*/
public String channelizer = WebSocketChannelizer.class.getName();