diff --git a/docs/reference/modules.asciidoc b/docs/reference/modules.asciidoc index 480401ac39d3b..32d1e7da1ff90 100644 --- a/docs/reference/modules.asciidoc +++ b/docs/reference/modules.asciidoc @@ -50,11 +50,6 @@ The modules in this section are: Information about the dedicated thread pools used in Elasticsearch. -<>:: - - Configure the transport networking layer, used internally by Elasticsearch - to communicate between nodes. - <>:: {ccs-cap} enables executing search requests across more than one cluster @@ -75,5 +70,3 @@ include::modules/network.asciidoc[] include::modules/node.asciidoc[] include::modules/threadpool.asciidoc[] - -include::modules/transport.asciidoc[] diff --git a/docs/reference/modules/transport.asciidoc b/docs/reference/modules/transport.asciidoc index 681965e5d199b..1440fb59f2f4c 100644 --- a/docs/reference/modules/transport.asciidoc +++ b/docs/reference/modules/transport.asciidoc @@ -1,9 +1,9 @@ [[modules-transport]] -== Transport +=== Transport -The transport module is used for internal communication between nodes +The transport networking layer is used for internal communication between nodes within the cluster. Each call that goes from one node to the other uses -the transport module (for example, when an HTTP GET request is processed +the transport layer (for example, when an HTTP GET request is processed by one node, and should actually be processed by another node that holds the data). The transport module is also used for the `TransportClient` in the {es} Java API. @@ -15,8 +15,8 @@ http://en.wikipedia.org/wiki/C10k_problem[C10k problem], as well as being the ideal solution for scatter (broadcast) / gather operations such as search in Elasticsearch. -[float] -=== Transport Settings +[[transport-settings]] +==== Transport settings The internal transport communicates over TCP. You can configure it with the following settings: @@ -57,8 +57,8 @@ transport connections. It also uses the common <>. -[float] -==== Transport Profiles +[[transport-profiles]] +===== Transport profiles Elasticsearch allows you to bind to multiple ports on different interfaces by the use of transport profiles. See this example configuration @@ -106,8 +106,8 @@ example above: * `tcp.send_buffer_size`: Configures the send buffer size of the socket * `tcp.receive_buffer_size`: Configures the receive buffer size of the socket -[float] -==== Long-lived idle connections +[[long-lived-connections]] +===== Long-lived idle connections Elasticsearch opens a number of long-lived TCP connections between each pair of nodes in the cluster, and some of these connections may be idle for an extended @@ -120,11 +120,9 @@ and ensuring that the keepalive interval is shorter than any timeout that might cause idle connections to be closed, or by setting `transport.ping_schedule` if keepalives cannot be configured. -[float] -==== Transport Compression -[float] -===== Request Compression +[[request-compression]] +===== Request compression By default, the `transport.compress` setting is `false` and network-level request compression is disabled between nodes in the cluster. This default @@ -139,8 +137,8 @@ request compression, you can set it on a per-remote cluster basis using the <>. -[float] -===== Response Compression +[[response-compression]] +===== Response compression The compression settings do not configure compression for responses. {es} will compress a response if the inbound request was compressed--even when compression @@ -148,10 +146,10 @@ is not enabled. Similarly, {es} will not compress a response if the inbound request was uncompressed--even when compression is enabled. -[float] -=== Transport Tracer +[[transport-tracer]] +==== Transport tracer -The transport module has a dedicated tracer logger which, when activated, logs incoming and out going requests. The log can be dynamically activated +The transport layer has a dedicated tracer logger which, when activated, logs incoming and out going requests. The log can be dynamically activated by setting the level of the `org.elasticsearch.transport.TransportService.tracer` logger to `TRACE`: [source,console] diff --git a/docs/reference/setup.asciidoc b/docs/reference/setup.asciidoc index 88a0ec0659491..ea0387dcb3a84 100644 --- a/docs/reference/setup.asciidoc +++ b/docs/reference/setup.asciidoc @@ -81,6 +81,8 @@ include::settings/sql-settings.asciidoc[] include::settings/transform-settings.asciidoc[] +include::modules/transport.asciidoc[] + include::settings/notification-settings.asciidoc[] include::setup/important-settings.asciidoc[]