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

Add indexing pressure documentation #59456

Merged
merged 12 commits into from
Jul 21, 2020

Conversation

Tim-Brooks
Copy link
Contributor

This commit adds documentation about the new indexing pressure memory
limit setting and exposure of this metrics in node stats.

This commit adds documentation about the new indexing pressure memory
limit setting and exposure of this metrics in node stats.
@Tim-Brooks Tim-Brooks added >docs General docs changes :Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. v8.0.0 v7.9.0 labels Jul 13, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Jul 13, 2020
@elasticmachine
Copy link
Collaborator

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

@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label Jul 13, 2020
Copy link
Contributor

@ywelsch ywelsch left a comment

Choose a reason for hiding this comment

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

I've left some initial comments.

docs/reference/cluster/nodes-stats.asciidoc Outdated Show resolved Hide resolved
docs/reference/cluster/nodes-stats.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
@Tim-Brooks
Copy link
Contributor Author

TODO: When this is back ported to 7.9, the release doc comments should link to this new documentation page.

@Tim-Brooks Tim-Brooks requested a review from ywelsch July 17, 2020 04:09
@Tim-Brooks
Copy link
Contributor Author

I need to investigate why the linking is broken in one part.

@Tim-Brooks Tim-Brooks requested review from jrodewig and ywelsch July 17, 2020 19:31
@Tim-Brooks
Copy link
Contributor Author

@jrodewig - Any tips about how to solve my linking issue?

@Tim-Brooks
Copy link
Contributor Author

Specifically linking index-modules-indexing-pressure from node-stats.asciidoc

@Tim-Brooks
Copy link
Contributor Author

Actually I fixed the linking issue. This is ready for review @jrodewig

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. Left some non-blocking suggestions you can take or leave as you see fit.

docs/reference/cluster/nodes-stats.asciidoc Outdated Show resolved Hide resolved
docs/reference/cluster/nodes-stats.asciidoc Outdated Show resolved Hide resolved
Comment on lines 2121 to 2131
`coordinating_and_primary_bytes`::
(integer)
Bytes consumed by indexing requests in the coordinating or primary stage.

`replica_bytes`::
(integer)
Bytes consumed by indexing requests in the replica stage.

`all_bytes`::
(integer)
Bytes consumed by indexing requests in the coordinating, primary, or replica stage.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are human readable versions of these stats available?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is not. My understanding is that human readable versions is disabled by default. So I think we can add human readable interpretations in 7.10? @ywelsch I assume it is too late to make this change after feature freeze since it is kind of a feature?


`coordinating_and_primary_memory_limit_rejections`::
(integer)
Rejections of indexing requests in the coordinating or primary stage.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Rejections of indexing requests in the coordinating or primary stage.
Number of indexing requests rejected in the coordinating or primary stage.

docs/reference/cluster/nodes-stats.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
docs/reference/index-modules/indexing-pressure.asciidoc Outdated Show resolved Hide resolved
(integer)
Bytes consumed by indexing requests in the coordinating or primary stage. This
value is not the sum of coordinating_bytes and primary_bytes as a node can reuse
the coordinating bytes if the primary is executed locally.
Copy link
Contributor

Choose a reason for hiding this comment

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

if the primary "stage" is executed locally

=== Indexing stages

External indexing operations go through three stages: coordinating, primary, and
replica. See <<basic-write-model,here>>.
Copy link
Contributor

Choose a reason for hiding this comment

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

does this link need fixing? (<>)

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd remove the here text:

Suggested change
replica. See <<basic-write-model,here>>.
replica. See <<basic-write-model>>.

@Tim-Brooks Tim-Brooks merged commit 08506de into elastic:master Jul 21, 2020
Tim-Brooks added a commit that referenced this pull request Jul 22, 2020
This commit adds documentation about the new indexing pressure memory
limit setting and exposure of this metrics in node stats.
Tim-Brooks added a commit that referenced this pull request Jul 22, 2020
This commit adds documentation about the new indexing pressure memory
limit setting and exposure of this metrics in node stats.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.9.0 v7.10.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants