-
Notifications
You must be signed in to change notification settings - Fork 24.7k
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
Note in docs about interpreting IO stats when running in docker #113676
Note in docs about interpreting IO stats when running in docker #113676
Conversation
Documentation preview: |
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-data-management (Team:Data Management) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it'd be better to use more neutral wording here. The stats we expose aren't inaccurate, they are an accurate reflection of something that might not be exactly what you expect.
Maybe we should call out explicitly that these stats come from /proc/diskstats
and leave it up to the user to worry about whether that's what they want or not.
Co-authored-by: David Turner <[email protected]>
I think you are right about more natural language but I do want to try and highlight this specific example as not all users may be immediately familiar with How about:
|
Nit: these stats relate to block devices rather than filesystems. Also I'd rather avoid the passive voice ("care is needed", "are correctly interpreted"). How about this?
|
Looks good. Have made that change. Thanks for the assist! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-authored-by: David Turner <[email protected]>
💚 Backport successful
|
…tic#113676) * Note in docs about incorrect IO stats when running in docker * Update docs/reference/cluster/nodes-stats.asciidoc Co-authored-by: David Turner <[email protected]> * Requested PR changes to wording * Update docs/reference/cluster/nodes-stats.asciidoc Co-authored-by: David Turner <[email protected]> --------- Co-authored-by: David Turner <[email protected]>
) (#113685) * Note in docs about incorrect IO stats when running in docker * Update docs/reference/cluster/nodes-stats.asciidoc * Requested PR changes to wording * Update docs/reference/cluster/nodes-stats.asciidoc --------- Co-authored-by: David Turner <[email protected]>
This PR adds documentation describing possible inaccuracies in the FS statistics from the
_nodes/stats
endpoint when running inside a container