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

[Auditbeat] improve docs for exclude_files option of file_integrity #35669

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

nicozanf
Copy link

@nicozanf nicozanf commented Jun 4, 2023

-- Type of change

  • Docs

What does this PR do?

The exclude_files option can be used for excluding directories, too, if recursive is set to true. Also (after spending hours on it) I've added a working example of a folder exclusion for Windows.

Why is it important?

It seems not documented elsewhere ;-)

Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have made corresponding change to the default configuration files
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

@nicozanf nicozanf requested a review from a team as a code owner June 4, 2023 09:41
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jun 4, 2023
@cla-checker-service
Copy link

cla-checker-service bot commented Jun 4, 2023

💚 CLA has been signed

@mergify
Copy link
Contributor

mergify bot commented Jun 4, 2023

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @nicozanf? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

@elasticmachine
Copy link
Collaborator

elasticmachine commented Jun 4, 2023

❕ Build Aborted

The PR is not allowed to run in the CI yet

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

Expand to view the summary

Build stats

  • Start Time: 2023-06-19T21:09:55.886+0000

  • Duration: 5 min 47 sec

Steps errors 2

Expand to view the steps failures

Load a resource file from a library
  • Took 0 min 0 sec . View more details here
  • Description: approval-list/elastic/beats.yml
Error signal
  • Took 0 min 0 sec . View more details here
  • Description: githubApiCall: The REST API call https://api.github.com/orgs/elastic/members/nicozanf return the message : java.lang.Exception: httpRequest: Failure connecting to the service https://api.github.com/orgs/elastic/members/nicozanf : httpRequest: Failure connecting to the service https://api.github.com/orgs/elastic/members/nicozanf : Code: 404Error: {"message":"User does not exist or is not a member of the organization","documentation_url":"https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user"}

🤖 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!)

@nicozanf nicozanf removed their assignment Jun 11, 2023
@nicozanf
Copy link
Author

/test

auditbeat/docs/modules/file_integrity.asciidoc Outdated Show resolved Hide resolved
auditbeat/docs/modules/file_integrity.asciidoc Outdated Show resolved Hide resolved
auditbeat/module/file_integrity/_meta/docs.asciidoc Outdated Show resolved Hide resolved
nicozanf and others added 5 commits June 19, 2023 22:39
The exclude_files option can be used for excluding directories, too, if recursive is set to true.
Also (after spending hours on it) I've added a working example of a folder exclusion for Windows.
Thank you @efd6 !

Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
Copy link
Contributor

mergify bot commented Feb 5, 2024

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @nicozanf? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

@andrewkroh andrewkroh added Auditbeat Team:Security-Linux Platform Linux Platform Team in Security Solution labels Feb 6, 2024
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Feb 6, 2024
@elasticmachine
Copy link
Collaborator

Pinging @elastic/sec-linux-platform (Team:Security-Linux Platform)

@andrewkroh andrewkroh added docs needs_team Indicates that the issue/PR needs a Team:* label labels Feb 6, 2024
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Feb 6, 2024
@andrewkroh andrewkroh changed the title DOCS: improve exclude_files option of file_integrity [Auditbeat] improve docs for exclude_files option of file_integrity Feb 6, 2024
Copy link
Contributor

mergify bot commented Feb 13, 2024

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b patch-1 upstream/patch-1
git merge upstream/main
git push upstream patch-1

1 similar comment
Copy link
Contributor

mergify bot commented Apr 15, 2024

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b patch-1 upstream/patch-1
git merge upstream/main
git push upstream patch-1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auditbeat docs Team:Security-Linux Platform Linux Platform Team in Security Solution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants