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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Metricbeat: Document unavailable and unknown as filesystem.ignore_types values #36946

Merged
merged 9 commits into from
Nov 3, 2023
Merged

[DOCS] Metricbeat: Document unavailable and unknown as filesystem.ignore_types values #36946

merged 9 commits into from
Nov 3, 2023

Conversation

jrodewig
Copy link
Contributor

Documents unavailable and unknown as valid values for the filesystem.ignore_types array. Also adds a related example.

Closes #35187.

@jrodewig jrodewig added docs v8.10.0 v8.11.0 v8.12.0 backport-v8.10.0 Automated backport with mergify backport-v8.11.0 Automated backport with mergify labels Oct 23, 2023
@jrodewig jrodewig requested a review from a team as a code owner October 23, 2023 19:57
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Oct 23, 2023
@jrodewig jrodewig requested a review from bczifra October 23, 2023 19:57
jrodewig
jrodewig commented Oct 23, 2023
View reviewed changes
metricbeat/module/system/filesystem/_meta/docs.asciidoc Outdated
Comment on lines 21 to 23
To ignore unavailable volumes, such as CD-ROM drives, include `unavailable` as a
value in the array. To ignore unknown filesystems, include `unknown` as a value
in the array.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@elastic/elastic-agent-data-plane Let me know if can elaborate more here. It seems a bit thin at the moment.

Copy link
Contributor

Choose a reason for hiding this comment

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

where does this documentation for the unavailable and unknown values come from? I don't see anything on linux that specifically handles those values. If that's something that's only available on windows, we should specify that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for calling this out. I've updated the text to note that the values only applies to Windows here: 51636bb

Here are links to the related code:

https://github.com/elastic/gosigar/blob/master/sys/windows/syscall_windows.go#L349
https://github.com/andrewkroh/beats/blob/cbdba8aa1645a896023e387b370b5b88960f3176/metricbeat/module/system/filesystem/helper.go#L179C38-L179C46

I couldn't find the source for unknown but it seems to a common value based on #35187

@jrodewig jrodewig mentioned this pull request Oct 23, 2023
Closed
@elasticmachine
Copy link
Collaborator

elasticmachine commented Oct 23, 2023 •
edited by jenkins-beats-ci bot
Loading

💚 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

  • Duration: 9 min 7 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the 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!)

@pierrehilbert pierrehilbert added the Team:Elastic-Agent Label for the Agent team label Oct 24, 2023
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Oct 24, 2023
@jrodewig jrodewig merged commit 5dcec50 into elastic:main Nov 3, 2023
8 checks passed
@jrodewig jrodewig deleted the document-unavailable-unknown-ignore-types branch November 3, 2023 17:06
mergify bot pushed a commit that referenced this pull request Nov 3, 2023
@jrodewig @mergify
[DOCS] Metricbeat: Document unavailable and unknown as `filesyste…
d89fe1c 
…m.ignore_types` values (#36946)

Documents `unavailable` and `unknown` as valid values for the `filesystem.ignore_types` array. Also adds a related example.

Closes #35187.

(cherry picked from commit 5dcec50)
mergify bot pushed a commit that referenced this pull request Nov 3, 2023
@jrodewig @mergify
[DOCS] Metricbeat: Document unavailable and unknown as `filesyste…
add7c5a 
…m.ignore_types` values (#36946)

Documents `unavailable` and `unknown` as valid values for the `filesystem.ignore_types` array. Also adds a related example.

Closes #35187.

(cherry picked from commit 5dcec50)
This was referenced Nov 3, 2023
Merged
Merged
pierrehilbert pushed a commit that referenced this pull request Nov 5, 2023
@mergify @jrodewig
[DOCS] Metricbeat: Document unavailable and unknown as `filesyste…
a749ddc 
…m.ignore_types` values (#36946) (#37030)

Documents `unavailable` and `unknown` as valid values for the `filesystem.ignore_types` array. Also adds a related example.

Closes #35187.

(cherry picked from commit 5dcec50)

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
pierrehilbert pushed a commit that referenced this pull request Nov 6, 2023
@mergify @jrodewig
[DOCS] Metricbeat: Document unavailable and unknown as `filesyste…
9de162f 
…m.ignore_types` values (#36946) (#37029)

Documents `unavailable` and `unknown` as valid values for the `filesystem.ignore_types` array. Also adds a related example.

Closes #35187.

(cherry picked from commit 5dcec50)

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
@jrodewig @Scholar-Li
[DOCS] Metricbeat: Document unavailable and unknown as `filesyste…
f06059b 
…m.ignore_types` values (elastic#36946)

Documents `unavailable` and `unknown` as valid values for the `filesystem.ignore_types` array. Also adds a related example.

Closes elastic#35187.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bczifra bczifra bczifra left review comments

@fearful-symmetry fearful-symmetry fearful-symmetry approved these changes

Assignees

@jrodewig jrodewig

Labels
backport-v8.10.0 Automated backport with mergify backport-v8.11.0 Automated backport with mergify docs Team:Elastic-Agent Label for the Agent team v8.10.0 v8.11.0 v8.12.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document unknown as filesystem.ignore_types metricbeat configuration value
5 participants
@jrodewig @elasticmachine @fearful-symmetry @bczifra @pierrehilbert