Skip to content

Commit

Permalink
Drop transport client from ping_schedule docs (#89264)
Browse files Browse the repository at this point in the history
The docs for `transport.ping_schedule` note that the transport client
defaults to a 5s ping schedule, but this is no longer relevant. This
commit drops this from the docs, and also moves the docs for this
setting further down the page to reflect its relative unimportance.
  • Loading branch information
DaveCTurner authored Aug 11, 2022
1 parent 0bf31b7 commit 616fd07
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/reference/modules/transport.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,6 @@ Configures the compression scheme for `transport.compress`. The options are
upgraded to a version supporting `lz4`, the traffic will be sent uncompressed.
Defaults to `lz4`.

`transport.ping_schedule`::
(<<static-cluster-setting,Static>>, <<time-units,time value>>)
Schedule a regular application-level ping message to ensure that transport
connections between nodes are kept alive. Defaults to `5s` in the transport
client and `-1` (disabled) elsewhere. It is preferable to correctly configure
TCP keep-alives instead of using this feature, because TCP keep-alives apply to
all kinds of long-lived connections and not just to transport connections.

`transport.tcp.keep_alive`::
(<<static-cluster-setting,Static>>, boolean)
Configures the `SO_KEEPALIVE` option for transport sockets, which determines
Expand Down Expand Up @@ -122,6 +114,14 @@ The size of the TCP send buffer for transport traffic. Defaults to
The size of the TCP receive buffer for transport traffic. Defaults to
`network.tcp.receive_buffer_size`.

`transport.ping_schedule`::
(<<static-cluster-setting,Static>>, <<time-units,time value>>)
Configures the time between sending application-level pings on all transport
connections to promptly detect when a transport connection has failed. Defaults
to `-1` meaning that application-level pings are not sent. You should use TCP
keepalives (see `transport.tcp.keep_alive`) instead of application-level pings
wherever possible.

[[transport-profiles]]
===== Transport profiles

Expand Down

0 comments on commit 616fd07

Please sign in to comment.