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.

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

indices.recovery.max_bytes_per_sec may be per-node #54633

Conversation

DaveCTurner
Copy link
Contributor

The indices.recovery.max_bytes_per_sec recovery bandwidth limit can differ
between nodes if it is not set dynamically, but today this is not obvious. This
commit adds a paragraph to its documentation clarifying how to set different
bandwidth limits on each node.

The `indices.recovery.max_bytes_per_sec` recovery bandwidth limit can differ
between nodes if it is not set dynamically, but today this is not obvious. This
commit adds a paragraph to its documentation clarifying how to set different
bandwidth limits on each node.
@DaveCTurner DaveCTurner added >docs General docs changes :Distributed/Recovery Anything around constructing a new shard, either from a local or a remote source. v8.0.0 v7.8.0 labels Apr 2, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/Recovery)

Comment on lines 44 to 46
`indices.recovery.max_concurrent_file_chunks`
(<<cluster-update-settings,Dynamic>>, Expert):: Number of file chunk requests
sent in parallel for each recovery. Defaults to `2`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't render properly because :: falls on a different line.
I think we can move the parenthetical info inside the definition like this:

Suggested change
`indices.recovery.max_concurrent_file_chunks`
(<<cluster-update-settings,Dynamic>>, Expert):: Number of file chunk requests
sent in parallel for each recovery. Defaults to `2`.
`indices.recovery.max_concurrent_file_chunks`::
(<<cluster-update-settings,Dynamic>>, Expert)
Number of file chunk requests sent in parallel for each recovery. Defaults to
`2`.

@@ -17,24 +16,34 @@ You can view a list of in-progress and completed recoveries using the
==== Peer recovery settings

`indices.recovery.max_bytes_per_sec` (<<cluster-update-settings,Dynamic>>)::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Github won't let me suggest, but we may want to move the parenthetical inside the definition as with indices.recovery.max_concurrent_file_chunks.

Comment on lines 35 to 37
if you are using <<overview-index-lifecycle-management,Index Lifecycle
Management>> then you may restrict the recovery bandwidth on your warm nodes
more than on your hot nodes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slight reword

Suggested change
if you are using <<overview-index-lifecycle-management,Index Lifecycle
Management>> then you may restrict the recovery bandwidth on your warm nodes
more than on your hot nodes.
if you are use <<overview-index-lifecycle-management,Index Lifecycle
Management>>, you may give hot nodes a higher recovery bandwidth limit than
warm nodes.

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, but some of the formatting is broken here:
https://github.com/elastic/elasticsearch/pull/54633/files#r402317243

I also suggested moving the parenthetical information for the setting definitions into
the definition itself. I think this makes the defs a bit more readable and helps us wrap
lines.

I left some other wording suggestions, but they're optional. Thanks @DaveCTurner.

@DaveCTurner
Copy link
Contributor Author

Thanks for picking up the broken formatting -- looks better now IMO. Ready for another look.

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @DaveCTurner.

@DaveCTurner DaveCTurner merged commit ac1b6eb into elastic:master Apr 2, 2020
@DaveCTurner DaveCTurner deleted the 2020-04-02-recover-bandwidth-per-node-setting branch April 2, 2020 17:14
DaveCTurner added a commit that referenced this pull request Apr 2, 2020
The `indices.recovery.max_bytes_per_sec` recovery bandwidth limit can differ
between nodes if it is not set dynamically, but today this is not obvious. This
commit adds a paragraph to its documentation clarifying how to set different
bandwidth limits on each node.

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
DaveCTurner added a commit that referenced this pull request Apr 2, 2020
The `indices.recovery.max_bytes_per_sec` recovery bandwidth limit can differ
between nodes if it is not set dynamically, but today this is not obvious. This
commit adds a paragraph to its documentation clarifying how to set different
bandwidth limits on each node.

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
DaveCTurner added a commit that referenced this pull request Apr 2, 2020
The `indices.recovery.max_bytes_per_sec` recovery bandwidth limit can differ
between nodes if it is not set dynamically, but today this is not obvious. This
commit adds a paragraph to its documentation clarifying how to set different
bandwidth limits on each node.

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed/Recovery Anything around constructing a new shard, either from a local or a remote source. >docs General docs changes v7.6.3 v7.7.1 v7.8.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants