Skip to content

clean up field-reference-parser #12466

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.

Sign up for GitHub

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

Merged
kaisecheng merged 2 commits into from
Nov 24, 2020
Merged

clean up field-reference-parser #12466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cec659
clean up field-reference-parser
kaisecheng Nov 24, 2020
60a4f92
update doc
kaisecheng Nov 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/static/breaking-changes.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ NOTE: Migrating directly between non-consecutive major versions (5.x to

See these topics for a description of breaking changes:

* <<breaking-8.0>>
* <<breaking-7.0>>
* <<breaking-pq>>
* <<breaking-6.0>>
Expand All @@ -24,6 +25,21 @@ See also <<releasenotes>>.
//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide

[[breaking-8.0]]
Copy link
Copy Markdown
Contributor Author

@kaisecheng kaisecheng Nov 24, 2020

Choose a reason for hiding this comment

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

@karenzone I should cc you before merging it 😨
Could you review the doc? This PR is a breaking change of removing --field-reference-parser

=== Breaking changes in 8.0
Here are the breaking changes for 8.0.

[float]
==== Changes in Logstash Core

[float]
[[field-reference-parser]]
===== Field Reference parser removed
The Field Reference parser by default was STRICT in version 7. This configuration is removed permanently.
Logstash keeps the behaviour as if the default setting, which interprets references to fields in your pipelines and plugins,
and rejects inputs that are either ambiguous or illegal.

Copy link
Copy Markdown
Contributor

@karenzone karenzone Nov 25, 2020

Choose a reason for hiding this comment

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

What about:
"The Field Reference parser interprets references to fields in your pipelines and
plugins. It was configurable in 7.x, with the default set to strict to reject
inputs that are ambiguous or illegal. Configurability is removed in 8.0. Now
{ls] rejects ambiguous and illegal inputs as standard behavior."


[[breaking-7.0]]
=== Breaking changes in 7.0

Expand Down
6 changes: 0 additions & 6 deletions logstash-core/lib/logstash/agent.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,6 @@ def initialize(settings = LogStash::SETTINGS, source_loader = nil)
# Generate / load the persistent uuid
id

# Set the global FieldReference parsing mode
if @settings.set?('config.field_reference.parser')
# TODO: i18n
logger.warn("deprecated setting `config.field_reference.parser` set; field reference parsing is strict by default")
end

if @settings.set?('pipeline.ecs_compatibility')
ecs_compatibility_value = settings.get('pipeline.ecs_compatibility')
if ecs_compatibility_value != 'disabled'
Expand Down
1 change: 0 additions & 1 deletion logstash-core/lib/logstash/environment.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ module Environment
Setting::Boolean.new("config.reload.automatic", false),
Setting::TimeValue.new("config.reload.interval", "3s"), # in seconds
Setting::Boolean.new("config.support_escapes", false),
Setting::String.new("config.field_reference.parser", "STRICT", true, %w(STRICT)),
Setting::Boolean.new("metric.collect", true),
Setting::String.new("pipeline.id", "main"),
Setting::Boolean.new("pipeline.system", false),
Expand Down
5 changes: 0 additions & 5 deletions logstash-core/lib/logstash/runner.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,6 @@ class LogStash::Runner < Clamp::StrictCommand
:default => LogStash::SETTINGS.get_default("config.string"),
:attribute_name => "config.string"

option ["--field-reference-parser"], "MODE",
I18n.t("logstash.runner.flag.field-reference-parser"),
:attribute_name => "config.field_reference.parser",
:default => LogStash::SETTINGS.get_default("config.field_reference.parser")

# Module settings
option ["--modules"], "MODULES",
I18n.t("logstash.runner.flag.modules"),
Expand Down
18 changes: 0 additions & 18 deletions logstash-core/locales/en.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,24 +228,6 @@ en:
"%{default_output}"
If you wish to use both defaults, please use
the empty string for the '-e' flag.
field-reference-parser: |+
(DEPRECATED) This option is no longer
configurable.

Use the given MODE when parsing field
references.

The field reference parser is used to expand
field references in your pipeline configs,
and has become more strict to better handle
ambiguous- and illegal-syntax inputs.

The only available MODE is:
- `STRICT`: parse in a strict manner; when
given ambiguous- or illegal-syntax input,
raises a runtime exception that should
be handled by the calling plugin.

modules: |+
Load Logstash modules.
Modules can be defined using multiple instances
Expand Down