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

[Filebeat] Remove alias fields from Suricata and Traefik module mappings #26627

Merged

Conversation

andrewkroh
Copy link
Member

@andrewkroh andrewkroh commented Jun 30, 2021

What does this PR do?

Alias fields are displayed in Kibana whenever their target exists in a document. This yields
confusing results when, for example, you are looking at Zeek module events but see many
suricata.eve.* fields just because Zeek populates many ECS fields.

This is a breaking change for users that depend on the Suricata or Traefik alias fields. Because these
aliases cause issues for all users I think it's best to remove them.

The following alias fields are removed:

suricata.eve.fileinfo.filename
suricata.eve.fileinfo.size
suricata.eve.dest_port
suricata.eve.src_port
suricata.eve.proto
suricata.eve.src_ip
suricata.eve.dest_ip
suricata.eve.http.status
suricata.eve.http.http_user_agent
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.length
suricata.eve.http.http_method
suricata.eve.alert.severity
suricata.eve.alert.action
suricata.eve.flow.bytes_toclient
suricata.eve.flow.start
suricata.eve.flow.pkts_toclient
suricata.eve.flow.bytes_toserver
suricata.eve.flow.pkts_toserver
suricata.eve.app_proto
traefik.access.user_agent.device

Relates: #10535

Why is it important?

Removing the aliases will result in more concise results in Kibana when looking a documents. And the documents will only have fields related to one particular module.

Checklist

  • My code follows the style guidelines of this project
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Related issues

Screenshots

Screen Shot 2021-06-30 at 3 00 03 PM

@elasticmachine
Copy link
Collaborator

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

@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 Jun 30, 2021
@andrewkroh andrewkroh force-pushed the bugfix/fb/remove-suricata-alias-fields branch from fa35bad to a13c07c Compare June 30, 2021 19:03
@andrewkroh andrewkroh changed the title [Filebeat] Remove alias fields from Suricata module mapping [Filebeat] Remove alias fields from Suricata and Traefik module mappings Jun 30, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jun 30, 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-07-12T20:11:26.307+0000

  • Duration: 94 min 20 sec

  • Commit: d7ed5d1

Test stats 🧪

Test Results
Failed 0
Passed 14804
Skipped 2312
Total 17116

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 14804
Skipped 2312
Total 17116

@andrewkroh
Copy link
Member Author

run elasticsearch-ci/docs

@andrewkroh andrewkroh added the backport-v7.15.0 Automated backport with mergify label Jul 8, 2021
@mergify
Copy link
Contributor

mergify bot commented Jul 9, 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 bugfix/fb/remove-suricata-alias-fields upstream/bugfix/fb/remove-suricata-alias-fields
git merge upstream/master
git push upstream bugfix/fb/remove-suricata-alias-fields

Alias fields are displayed in Kibana whenever their target exists in a document. This yields
confusing results when, for example, you are looking at Zeek module events but see many
`suricata.eve.*` fields just because Zeek populates many ECS fields.

This is a breaking change for users that depend on the Suricata alias fields. Because these
alias cause issues for all users I think it best to remove them.

The following alias fields are removed:

suricata.eve.fileinfo.filename
suricata.eve.fileinfo.size
suricata.eve.dest_port
suricata.eve.src_port
suricata.eve.proto
suricata.eve.src_ip
suricata.eve.dest_ip
suricata.eve.http.status
suricata.eve.http.http_user_agent
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.length
suricata.eve.http.http_method
suricata.eve.alert.severity
suricata.eve.alert.action
suricata.eve.flow.bytes_toclient
suricata.eve.flow.start
suricata.eve.flow.pkts_toclient
suricata.eve.flow.bytes_toserver
suricata.eve.flow.pkts_toserver
suricata.eve.app_proto
traefik.access.user_agent.device

Relates: elastic#10535
@andrewkroh andrewkroh force-pushed the bugfix/fb/remove-suricata-alias-fields branch from 7c6990d to d7ed5d1 Compare July 12, 2021 20:11
@andrewkroh andrewkroh merged commit 877ae2c into elastic:master Jul 15, 2021
mergify bot pushed a commit that referenced this pull request Jul 15, 2021
…ngs (#26627)

* Remove alias fields from Suricata/Traefik module mappings

Alias fields are displayed in Kibana whenever their target exists in a document. This yields
confusing results when, for example, you are looking at Zeek module events but see many
`suricata.eve.*` fields just because Zeek populates many ECS fields.

This is a breaking change for users that depend on the Suricata alias fields. Because these
alias cause issues for all users I think it best to remove them.

The following alias fields are removed:

suricata.eve.fileinfo.filename
suricata.eve.fileinfo.size
suricata.eve.dest_port
suricata.eve.src_port
suricata.eve.proto
suricata.eve.src_ip
suricata.eve.dest_ip
suricata.eve.http.status
suricata.eve.http.http_user_agent
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.length
suricata.eve.http.http_method
suricata.eve.alert.severity
suricata.eve.alert.action
suricata.eve.flow.bytes_toclient
suricata.eve.flow.start
suricata.eve.flow.pkts_toclient
suricata.eve.flow.bytes_toserver
suricata.eve.flow.pkts_toserver
suricata.eve.app_proto
traefik.access.user_agent.device

Relates: #10535

* Fix changelog

(cherry picked from commit 877ae2c)
mdelapenya added a commit to mdelapenya/beats that referenced this pull request Jul 19, 2021
* master: (61 commits)
  Add disk queue unit tests based on the queuetest package
  [Heartbeat] redact authorization headers from logger (elastic#26892)
  Expose custom process metrics  (elastic#26912)
  [gcp/billing] always quote table name identifier (elastic#26870)
  Add Beats central management removal to BCs (elastic#26400)
  Add custom suffix to identifiers in filestream input when needed (elastic#26669)
  Update asa-ftd-pipeline.yml (elastic#26265)
  Use common host parser in vsphere module (elastic#26904)
  [automation] Update go release version 1.16.6 (elastic#26860)
  Skip flaky test: filestream and harvester group (elastic#26728)
  [Filebeat] Remove alias fields from Suricata and Traefik module mappings (elastic#26627)
  docs: apm-server.auth (elastic#26831)
  [Automation] Update elastic stack version to 8.0.0-2f008f4a for testing (elastic#26881)
  Clarify the scope of start/end multiline example (elastic#26786)
  [Heartbeat]: update Node.js version for synthetics (elastic#26867)
  [fix][httpjson] Fix incorrect key for template data (elastic#26848)
  [httpjson] Add value_type parameter to httpjson transforms (elastic#26847)
  [Heartbeat]: capture error from journey/end events (elastic#26781)
  [Winlogbeat] Fixes for wineventlog experimental api (elastic#26826)
  Set agent.id to Fleet Agent ID for each metric/log monitoring input (elastic#26776)
  ...
andrewkroh added a commit that referenced this pull request Jul 27, 2021
…ngs (#26627) (#26896)

* Remove alias fields from Suricata/Traefik module mappings

Alias fields are displayed in Kibana whenever their target exists in a document. This yields
confusing results when, for example, you are looking at Zeek module events but see many
`suricata.eve.*` fields just because Zeek populates many ECS fields.

This is a breaking change for users that depend on the Suricata alias fields. Because these
alias cause issues for all users I think it best to remove them.

The following alias fields are removed:

suricata.eve.fileinfo.filename
suricata.eve.fileinfo.size
suricata.eve.dest_port
suricata.eve.src_port
suricata.eve.proto
suricata.eve.src_ip
suricata.eve.dest_ip
suricata.eve.http.status
suricata.eve.http.http_user_agent
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.http_refer
suricata.eve.http.url
suricata.eve.http.hostname
suricata.eve.http.length
suricata.eve.http.http_method
suricata.eve.alert.severity
suricata.eve.alert.action
suricata.eve.flow.bytes_toclient
suricata.eve.flow.start
suricata.eve.flow.pkts_toclient
suricata.eve.flow.bytes_toserver
suricata.eve.flow.pkts_toserver
suricata.eve.app_proto
traefik.access.user_agent.device

Relates: #10535

* Fix changelog

(cherry picked from commit 877ae2c)

Co-authored-by: Andrew Kroh <[email protected]>
@jamiehynds jamiehynds mentioned this pull request Sep 22, 2021
11 tasks
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 breaking change Filebeat Filebeat release-note:breaking The content should be included as a breaking change review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants