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

Rename log.path field to log.file.path to be ECS complicant #27761

Merged
merged 4 commits into from
Sep 10, 2021

Conversation

kvch
Copy link
Contributor

@kvch kvch commented Sep 6, 2021

What does this PR do?

The PR renames log.path to log.file.path in filestream input events.

Why is it important?

The old log.path is not ECS compliant and inconsistent with the old log input.

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.

Closes #27776

@kvch kvch added breaking change backport-v7.15.0 Automated backport with mergify backport-v7.16.0 Automated backport with mergify labels Sep 6, 2021
@kvch kvch requested a review from ruflin September 6, 2021 10:52
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Sep 6, 2021
@kvch kvch added the Team:Elastic-Agent Label for the Agent team label Sep 6, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/agent (Team:Agent)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Sep 6, 2021
@ruflin
Copy link
Member

ruflin commented Sep 6, 2021

It seems this is a breaking change. Will this potentially have some side effects?

@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 6, 2021

💚 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: 2021-09-10T11:29:13.004+0000

  • Duration: 142 min 48 sec

  • Commit: f1c2aeb

Test stats 🧪

Test Results
Failed 0
Passed 53916
Skipped 5324
Total 59240

Trends 🧪

Image of Build Times

Image of Tests

💚 Flaky test report

Tests succeeded.

Expand to view the summary

Test stats 🧪

Test Results
Failed 0
Passed 53916
Skipped 5324
Total 59240

@weltenwort
Copy link
Member

ℹ️ The Logs UI already uses log.file.path for its "view in context" feature.

@kvch
Copy link
Contributor Author

kvch commented Sep 6, 2021

It is a breaking change compared to the previous version. However, everyone expects filestream input to be ECS compliant, so I consider the old behaviour an obstacle for adaptation. It makes moving from log input to filestream input harder if we do not merge this in 7.x.

EDIT: It was reported here on Discuss: https://discuss.elastic.co/t/filebeat-input-types-log-and-filestream-metadata-for-file-path-name-differ/281713
I think the user question is valid, we should follow ECS.

@ruflin
Copy link
Member

ruflin commented Sep 6, 2021

++ on following ECS. We should likely file it then as bug and breaking change. Any user that has build dashboards or tooling of the existing fields will have issues afterwards.

@mergify
Copy link
Contributor

mergify bot commented Sep 7, 2021

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 fix-filebeat-filestream-log-path-ecs upstream/fix-filebeat-filestream-log-path-ecs
git merge upstream/master
git push upstream fix-filebeat-filestream-log-path-ecs

@kvch kvch force-pushed the fix-filebeat-filestream-log-path-ecs branch from fcb2c05 to 0beaafb Compare September 7, 2021 14:52
@kvch
Copy link
Contributor Author

kvch commented Sep 7, 2021

I have opened an issue as well and added one more entry to the changelog.

@mergify
Copy link
Contributor

mergify bot commented Sep 8, 2021

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 fix-filebeat-filestream-log-path-ecs upstream/fix-filebeat-filestream-log-path-ecs
git merge upstream/master
git push upstream fix-filebeat-filestream-log-path-ecs

@kvch kvch force-pushed the fix-filebeat-filestream-log-path-ecs branch from 0beaafb to f1c2aeb Compare September 10, 2021 11:28
@kvch kvch merged commit 66eb101 into elastic:master Sep 10, 2021
mergify bot pushed a commit that referenced this pull request Sep 10, 2021
mergify bot pushed a commit that referenced this pull request Sep 10, 2021
kvch added a commit that referenced this pull request Sep 13, 2021
…cant (#27761) (#27864)

(cherry picked from commit 66eb101)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
kvch added a commit to kvch/beats that referenced this pull request Sep 13, 2021
kvch added a commit that referenced this pull request Sep 13, 2021
…cant (#27761) (#27863)

(cherry picked from commit 66eb101)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
Icedroid pushed a commit to Icedroid/beats that referenced this pull request Nov 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v7.15.0 Automated backport with mergify backport-v7.16.0 Automated backport with mergify breaking change Team:Elastic-Agent Label for the Agent team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Filestream events are not ECS comliant
4 participants