Skip to content

[Website]: Misleading Usage of common options within Logstash drop filter documentation #1753

Open
@asmith-elastic

Description

@asmith-elastic

Type of issue

Inaccurate

What documentation page is affected

https://www.elastic.co/docs/reference/logstash/plugins/plugins-filters-drop

What happened?

The drop filter plugin documentation includes a section listing common options, such as add_field or drop_field, which do not have the expected effect because the entire event is dropped. Specifically, the inclusion of the drop_field option can mislead users into thinking that only a specific field will be dropped, rather than the entire event. Since the drop filter removes everything that reaches it, any drop_field specified will not isolate the removal to just that field.

Additional info

Instead of using drop_field within the drop filter, it should instead be used within the mutate filter.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:IngestIssues owned by the Ingest Docs Teamsource:webIssues originating from the elastic.co docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions