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

Update filesystem and fsstat docs to update the definition of a "file" #30631

Merged
merged 12 commits into from
Mar 2, 2022

Conversation

fearful-symmetry
Copy link
Contributor

What does this PR do?

I recently realized that what the system/fsstat and system/filesystem calls files are in fact inodes. A lot of users might not even notice the difference, as the total count of files and used inodes can be fairly similar, but I figured it was at least worth updating the docs for anything that decides to dig deeper. It would be nice to update the fields themselves to be *.inodes where appropriate, but we can't really do that without breaking existing mappings, and aliasing the fields seems confusing in its own right, as files and inodes are conceptually rather different.

Why is it important?

This is a doc change that more accurately describes what some of the fields actually mean.

Checklist

  • I have made corresponding changes to the documentation
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

@fearful-symmetry fearful-symmetry added docs Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team v8.2.0 labels Mar 1, 2022
@fearful-symmetry fearful-symmetry requested a review from a team March 1, 2022 22:59
@fearful-symmetry fearful-symmetry self-assigned this Mar 1, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Mar 1, 2022
@mergify
Copy link
Contributor

mergify bot commented Mar 1, 2022

This pull request does not have a backport label. Could you fix it @fearful-symmetry? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v./d./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Mar 1, 2022
@fearful-symmetry fearful-symmetry added backport-v8.2.0 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Mar 1, 2022
@elasticmachine
Copy link
Collaborator

elasticmachine commented Mar 2, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-03-02T18:32:49.920+0000

  • Duration: 92 min 13 sec

Test stats 🧪

Test Results
Failed 0
Passed 7751
Skipped 2015
Total 9766

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@cmacknz
Copy link
Member

cmacknz commented Mar 2, 2022

The other option here would be to have the metrics actually report the number of files instead of inodes, and add new metrics for inodes.

I don't think this affects correcting the documentation, but should we have an issue to consider doing that?

@fearful-symmetry
Copy link
Contributor Author

@cmacknz so, there's no good, OS-independent, filesystem-independent way to get the number of files. Doing something equivalent find -type f can be super slow and potentially hammer metricbeat and/or the filesystem. We could potentially derive something, but I'm not sure how much more accurate that would be than just telling users that the inode count is probably close.

@cmacknz
Copy link
Member

cmacknz commented Mar 2, 2022

@cmacknz so, there's no good, OS-independent, filesystem-independent way to get the number of files. Doing something equivalent find -type f can be super slow and potentially hammer metricbeat and/or the filesystem. We could potentially derive something, but I'm not sure how much more accurate that would be than just telling users that the inode count is probably close.

Thanks, that makes sense. If you are updating the code comments can you add this explanation there as well? That will save the next person trying to understand this some time.

@fearful-symmetry fearful-symmetry merged commit 02d45e2 into elastic:main Mar 2, 2022
@v1v
Copy link
Member

v1v commented Mar 8, 2022

@fearful-symmetry , I'm afraid the backport-v8.2.0 is not yet available, and likely it points to main since main is 8.2 based. What branch would you need to backport this particular PR to? The backport definitions can be found in https://github.com/elastic/beats/blob/main/.mergify.yml#L210-L248

@fearful-symmetry
Copy link
Contributor Author

@v1v so, I actually assumed it would be in 8.2, I think I just keep adding the backport label out of habit, since that's a little closer to how the backports worked pre 8.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v8.2.0 Automated backport with mergify docs Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team v8.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants