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] [Processors] Add Append Processor #29934

Closed
mr1716 opened this issue Jan 20, 2022 · 11 comments · Fixed by #33364
Closed

[Filebeat] [Processors] Add Append Processor #29934

mr1716 opened this issue Jan 20, 2022 · 11 comments · Fixed by #33364
Labels
enhancement Filebeat Filebeat Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team

Comments

@mr1716
Copy link
Contributor

mr1716 commented Jan 20, 2022

This adds an append processor to be able to append data to ECS values.

The use case for this specific enhancement is that the majority of filebeat modules already contain the append processor at least 1 time in the ECS Modules, and this would allow beat-side processing to occur rather than on the Elastic side.
Team: Filebeat

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jan 20, 2022
@mtojek mtojek added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Jan 24, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jan 24, 2022
@mr1716
Copy link
Contributor Author

mr1716 commented Jan 24, 2022

@mtojek Thanks for adding a label. Would it also be worth adding the enhancement and Filebeat labels in addition to the existing label?

@mr1716 mr1716 changed the title [Processors] Add Append Processor [Filebeat] [Processors] Add Append Processor Jan 24, 2022
@mr1716
Copy link
Contributor Author

mr1716 commented Jan 24, 2022

Just for additional context, this is one of the more popular elastic processors seen in Filebeat Pipelines, so it will be great to get this ported into Filebeat. It is seen in 52 modules, out of 70 modules in Filebeat, which puts it at 74.285% of the modules. This will make the append processor the 4th most used elastic processor for Filebeat modules. There are already applicable native Filebeat processors for #s 1-3, which are set, rename, and remove. @jlind23

@mr1716
Copy link
Contributor Author

mr1716 commented May 9, 2022

Hey, I wanted to ping on this to see if there could be some traction on this going forward

@nimarezainia
Copy link
Contributor

@mr1716 are you experiencing performance issues and want to move this processing out to the beat? Just trying to understand the use case and what you are trying to achieve. thanks.

@mr1716
Copy link
Contributor Author

mr1716 commented Jun 23, 2022

@nimarezainia I would like to move this to the beat to make sure that it can handle the data properly and provide parity for my use case.

@nimarezainia
Copy link
Contributor

@mr1716 could you explain the use case in a bit more detail? I'm curious why doing this at the Elastic side is not handling the data properly?

@mr1716
Copy link
Contributor Author

mr1716 commented Jun 24, 2022

@nimarezainia right now, if I wanted to append data to a field in filebeat, I would have to do this via script. I am trying to reduce the work that the backend does. Therefore, I would like to have more parity and help spread out the workload.

@BenB196
Copy link

BenB196 commented Jun 24, 2022

I've been following this request and I think a good use case for append to is the setting of the *.address at the beats level. Today, unless I'm mistaken you can't easily add both the *.domain and *.ip values to the *.address field (I think it might be possible with a script processor, but that seems very clunky (and isn't officially documented)).

A good reason for why I'd want to do this type of thing at the beat level, rather than Logstash or Elasticsearch Ingest level, is a lot of times it isn't really needed, and all using those methods does is add additional complexity. If I can do 95% of what I need to do at the beats level, why add an additional "thing" to the process to do the last 5%, when it would be better to keep it at the beats level.

A point worth noting, is that the concept of append isn't really new to beats, the DNS process already supports this under its action as the default value.

Another note, is that currently this is only being looked at if you're outputting to Elasticsearch or Logstash, but Beats have a variety of support outputs, so being able to modify the data as needed to these other outputs would also provide value.

@UcanInfosec
Copy link

@nimarezainia ive also been watching this and would love this to get added. Any thoughts on when this could be added? Adding this would be extremely beneficial to our grater adoption of the tool

@mr1716
Copy link
Contributor Author

mr1716 commented Jan 12, 2023

Hey, I dont see the documentation for that here: https://www.elastic.co/guide/en/beats/filebeat/current/filtering-and-enhancing-data.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Filebeat Filebeat Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants