Skip to content

parser_json: Add stream_buffer_size config param #2381

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
repeatedly merged 1 commit into from
Apr 25, 2019
Merged

parser_json: Add stream_buffer_size config param #2381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions lib/fluent/plugin/out_exec_filter.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ class ExecFilterOutput < Output
COMPAT_PARSE_PARAMS = {
'out_format' => '@type',
'out_keys' => 'keys',
'out_stream_buffer_size' => 'stream_buffer_size',
Copy link
Contributor Author

@benwh benwh Apr 14, 2019

Choose a reason for hiding this comment

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

The only reason that this was added was to shave another 30s off the tests

}
COMPAT_EXTRACT_PARAMS = {
'out_tag_key' => 'tag_key',
Expand Down
8 changes: 7 additions & 1 deletion lib/fluent/plugin/parser_json.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ class JSONParser < Parser
desc 'Set JSON parser'
config_param :json_parser, :enum, list: [:oj, :yajl, :json], default: :oj

# The Yajl library defines a default buffer size of 8KiB when parsing
# from IO streams, so maintain this for backwards-compatibility.
# https://www.rubydoc.info/github/brianmario/yajl-ruby/Yajl%2FParser:parse
desc 'Set the buffer size that Yajl will use when parsing streaming input'
config_param :stream_buffer_size, :integer, default: 8192

config_set_default :time_type, :float

def configure(conf)
Expand Down Expand Up @@ -81,7 +87,7 @@ def parse_io(io, &block)
y.on_parse_complete = ->(record){
block.call(parse_time(record), record)
}
y.parse(io)
y.parse(io, @stream_buffer_size)
end
end
end
Expand Down
6 changes: 6 additions & 0 deletions test/plugin/test_out_exec_filter.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ def create_driver(conf)
</format>
<parse>
@type json
stream_buffer_size 1
</parse>
<extract>
tag_key tag
Expand All @@ -338,6 +339,7 @@ def create_driver(conf)
command cat
in_keys message
out_format json
out_stream_buffer_size 1
time_key time
tag_key tag
]
Expand Down Expand Up @@ -372,6 +374,7 @@ def create_driver(conf)
</format>
<parse>
@type json
stream_buffer_size 1
</parse>
<extract>
tag_key tag
Expand All @@ -382,6 +385,7 @@ def create_driver(conf)
command cat
in_keys message
out_format json
out_stream_buffer_size 1
time_key time
tag_key tag
]
Expand Down Expand Up @@ -414,6 +418,7 @@ def create_driver(conf)
</format>
<parse>
@type json
stream_buffer_size 1
</parse>
<extract>
tag_key tag
Expand All @@ -426,6 +431,7 @@ def create_driver(conf)
command cat
in_keys message
out_format json
out_stream_buffer_size 1
time_key time
time_format %d/%b/%Y %H:%M:%S.%N %z
tag_key tag
Expand Down
24 changes: 24 additions & 0 deletions test/plugin/test_parser_json.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,28 @@ def test_parse_with_keep_time_key_without_time_format(data)
assert_equal text, record['time']
end
end

def test_yajl_parse_io_with_buffer_smaller_than_input
parser = Fluent::Test::Driver::Parser.new(Fluent::Plugin::JSONParser)
parser.configure(
'keep_time_key' => 'true',
'json_parser' => 'yajl',
'stream_buffer_size' => 1,
)
text = "100"

waiting(5) do
Copy link
Member

@ganmacs ganmacs Apr 22, 2019

Choose a reason for hiding this comment

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

Does it need? this test suit seems not to block since L134.

Copy link
Contributor Author

@benwh benwh Apr 22, 2019

Choose a reason for hiding this comment

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

Yes it's not actually required for the test to work, I put it there to protect against any regression in the code being tested (or the test scaffolding) that might cause the test to fail, because if it does then it will block forever which would be quite annoying when it runs in CI, if nothing else.

rd, wr = IO.pipe
wr.write "{\"time\":\"#{text}\"}"

parser.instance.parse_io(rd) do |time, record|
assert_equal text.to_i, time.sec
assert_equal text, record['time']

# Once a record has been received the 'write' end of the pipe must be
# closed, otherwise the test will block waiting for more input.
wr.close
end
end
end
end