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

(Doc+) Error "number of documents in the index can't exceed" #110449

Merged
merged 9 commits into from
Jul 16, 2024

Conversation

stefnestor
Copy link
Contributor

@stefnestor stefnestor commented Jul 4, 2024

👋 howdy, team! This adds resolution outline for error under Troubleshooting shard-related errors ... which induces ongoing, lowkey support

Number of documents in the index can't exceed [2147483519]

Kindly correct resolution steps as needed 🙂 .

👋 howdy, team! 

This adds resolution outline for error ... which induces ongoing, lowkey support
```
Number of documents in the index can't exceed [2147483519]
```
@stefnestor stefnestor added >enhancement >docs General docs changes :Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team labels Jul 4, 2024
Copy link
Contributor

github-actions bot commented Jul 4, 2024

Documentation preview:

@elasticsearchmachine

This comment was marked as outdated.

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine added the external-contributor Pull request authored by a developer outside the Elasticsearch team label Jul 4, 2024
@stefnestor
Copy link
Contributor Author

Thanks, @idegtiarenko ! I've updated error wording to match your PR #110481 while leaving a NOTE tag so current+historical users can still search the previous error string.

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

I'm hesitant to include this section in size-your-shards.asciidoc since it's not really sizing guidance. I worry that users will see this limit as a target, when in fact the recommended sizing is described further up as aiming for ≤200M docs. I think it's good information to include in the manual for sure, but I'd prefer it to be somewhere in the troubleshooting area of the docs rather than here.

I'd also like to make it so that the error message (see #110481) includes a link to the docs we're adding here.

docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: David Turner <[email protected]>
@stefnestor
Copy link
Contributor Author

I'm hesitant to include this section ...

@DaveCTurner, my interpretation of Troubleshoot shard-related errors at the bottom of the shard sizing page is for messages/errors when you fall out of best practices. However as always, I don't presume to know where your team would like the content as long as it can searchably exist in official docs 🙏

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

TIL there's a troubleshooting section at the bottom of the size-your-shards page. Ok, this seems to me like a good spot to write these words.

docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

A little editorial review for clarity here, I think mainly we can be a bit more concise here :)

docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
stefnestor and others added 2 commits July 11, 2024 09:57
Co-authored-by: David Turner <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

I suspect the most helpful thing we can do to make these docs more discoverable is to include a link to them from the exception message. @stefnestor are you comfortable including that change here or would you rather we did that in a follow-up? See e.g. #110681 as a model example of this kind of thing.

docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
docs/reference/how-to/size-your-shards.asciidoc Outdated Show resolved Hide resolved
@stefnestor
Copy link
Contributor Author

I suspect the most helpful thing ...

@DaveCTurner I applaud linking the error to the docs, but the linked PR does not look like a trivial change (at least to me who has only briefly coded Java & is not familiar with the ES code base), so I would prefer we handle it after separately.

@DaveCTurner
Copy link
Contributor

the linked PR does not look like a trivial change (at least to me who has only briefly coded Java & is not familiar with the ES code base), so I would prefer we handle it after separately.

Sure, no probs, I'll look after that once this is merged.

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

LGTM

@DaveCTurner DaveCTurner dismissed leemthompo’s stale review July 12, 2024 07:23

All points addressed

@leemthompo leemthompo added auto-backport-and-merge Automatically create backport pull requests and merge when ready v8.15.0 labels Jul 16, 2024
@leemthompo leemthompo merged commit 512bca8 into main Jul 16, 2024
6 checks passed
@leemthompo leemthompo deleted the stefnestor-patch-6 branch July 16, 2024 09:39
stefnestor added a commit to stefnestor/elasticsearch that referenced this pull request Jul 16, 2024
…#110449)

* (Doc+) Error "number of documents in the index can't exceed"

👋 howdy, team! 

This adds resolution outline for error ... which induces ongoing, lowkey support
```
Number of documents in the index can't exceed [2147483519]
```

* feedback

* feedback

Co-authored-by: David Turner <[email protected]>

* feedback

Co-authored-by: David Turner <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>

* feedback

* feedback

* Test change to address docs check failure

* Revert test change

* Test docs check

---------

Co-authored-by: David Turner <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.15

DaveCTurner added a commit to DaveCTurner/elasticsearch that referenced this pull request Jul 16, 2024
elasticsearchmachine pushed a commit that referenced this pull request Jul 16, 2024
#110910)

* (Doc+) Error "number of documents in the index can't exceed"

👋 howdy, team! 

This adds resolution outline for error ... which induces ongoing, lowkey support
```
Number of documents in the index can't exceed [2147483519]
```

* feedback

* feedback



* feedback




* feedback

* feedback

* Test change to address docs check failure

* Revert test change

* Test docs check

---------

Co-authored-by: David Turner <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
DaveCTurner added a commit that referenced this pull request Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport-and-merge Automatically create backport pull requests and merge when ready :Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. >docs General docs changes >enhancement external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Distributed Meta label for distributed team Team:Docs Meta label for docs team v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants