Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.x] [DOCS] Relocate transport module content (#55472) #57425

Merged
merged 1 commit into from
Jun 1, 2020
Merged

[7.x] [DOCS] Relocate transport module content (#55472) #57425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docs/reference/modules.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,6 @@ The modules in this section are:

Information about the dedicated thread pools used in Elasticsearch.

<<modules-transport,Transport>>::

Configure the transport networking layer, used internally by Elasticsearch
to communicate between nodes.

<<modules-cross-cluster-search, {ccs-cap}>>::

{ccs-cap} enables executing search requests across more than one cluster
Expand All @@ -75,5 +70,3 @@ include::modules/network.asciidoc[]
include::modules/node.asciidoc[]

include::modules/threadpool.asciidoc[]

include::modules/transport.asciidoc[]
34 changes: 16 additions & 18 deletions docs/reference/modules/transport.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -57,8 +57,8 @@ transport connections.
It also uses the common
<<modules-network,network settings>>.

[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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -139,19 +137,19 @@ request compression, you can set it on a per-remote cluster basis using the
<<remote-cluster-settings,`cluster.remote.${cluster_alias}.transport.compress` setting>>.


[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
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]
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/setup.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down