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

x-pack/filebeat : Sanitize trace log filename to support multiple OS #35143

Merged
merged 6 commits into from
Apr 20, 2023

Conversation

bhapas
Copy link
Contributor

@bhapas bhapas commented Apr 20, 2023

What does this PR do?

This PR sanitizes the request.tracer.filename in filebeat config to replace : and / characters with _ character.

Why is it important?

There is a problem with different path separators between HFS+ (colon, ':') and UFS (slash, '/'). This also means that HFS+ file names may contain the slash character and not colons, while the opposite is true for UFS file names. Reference

So the file structure seems to be corrupted in MacOS if the filename has : and the same happens in Unix based systems if the filename has /. Hence replacing them with _.

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.

@bhapas bhapas added the bug label Apr 20, 2023
@bhapas bhapas self-assigned this Apr 20, 2023
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 20, 2023
@mergify
Copy link
Contributor

mergify bot commented Apr 20, 2023

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @bhapas? 🙏.
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 Apr 20, 2023

💚 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: 2023-04-20T12:10:05.117+0000

  • Duration: 74 min 8 sec

Test stats 🧪

Test Results
Failed 0
Passed 2883
Skipped 175
Total 3058

💚 Flaky test report

Tests succeeded.

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

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 20, 2023
@bhapas bhapas added needs_team Indicates that the issue/PR needs a Team:* label backport-v8.7.0 Automated backport with mergify labels Apr 20, 2023
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 20, 2023
@bhapas bhapas marked this pull request as ready for review April 20, 2023 09:49
@bhapas bhapas requested a review from a team as a code owner April 20, 2023 09:49
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

Copy link
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

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

nits

x-pack/filebeat/input/httpjson/input.go Outdated Show resolved Hide resolved
@bhapas bhapas merged commit b47e4fd into elastic:main Apr 20, 2023
@bhapas bhapas deleted the fix-log-path branch April 20, 2023 14:19
mergify bot pushed a commit that referenced this pull request Apr 20, 2023
…35143)

* Sanitize trace log filename for multiple OS

* Fix PR comments

(cherry picked from commit b47e4fd)
Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

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

Given that pretty much every operating system imposes some limits on file name length, I think it would be a good idea to impose some sort guard against really long IDs.

The id can be set to any value by a user and for stateful inputs Filebeat appends the URL. So this ID value could get really long. Perhaps we impose and document some arbitrary limit like * will include the first 64 characters of the input id.

bhapas added a commit that referenced this pull request Apr 20, 2023
…35143) (#35144)

* Sanitize trace log filename for multiple OS

* Fix PR comments

(cherry picked from commit b47e4fd)

Co-authored-by: Bharat Pasupula <[email protected]>
@bhapas
Copy link
Contributor Author

bhapas commented Apr 20, 2023

Given that pretty much every operating system imposes some limits on file name length, I think it would be a good idea to impose some sort guard against really long IDs.

The id can be set to any value by a user and for stateful inputs Filebeat appends the URL. So this ID value could get really long. Perhaps we impose and document some arbitrary limit like * will include the first 64 characters of the input id.

I had some discussion with Dan about this. May be we can take this in a separate issue to see what would be a nicer way to do this

@andrewkroh
Copy link
Member

May be we can take this in a separate issue

Sure. #35157

chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
…35143)

* Sanitize trace log filename for multiple OS

* Fix PR comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v8.7.0 Automated backport with mergify bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants