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

in_exec: add option 'encoding' to handle non-ASCII characters #4533

Merged
merged 2 commits into from
Jul 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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: 14 additions & 2 deletions lib/fluent/plugin/in_exec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ class ExecInput < Fluent::Plugin::Input
config_param :run_interval, :time, default: nil
desc 'The default block size to read if parser requires partial read.'
config_param :read_block_size, :size, default: 10240 # 10k
desc 'The encoding to receive the result of the command, especially for none-ascii characters.'
daipom marked this conversation as resolved.
Show resolved Hide resolved
config_param :encoding, :string, default: nil

attr_reader :parser

Expand All @@ -63,20 +65,30 @@ def configure(conf)
if !@tag && (!@extract_config || !@extract_config.tag_key)
raise Fluent::ConfigError, "'tag' or 'tag_key' option is required on exec input"
end
validate_encoding(@encoding) if @encoding
@parser = parser_create
end

def validate_encoding(encoding)
Encoding.find(encoding)
rescue ArgumentError => e
raise Fluent::ConfigError, e.message
end

def multi_workers_ready?
true
end

def start
super

options = { mode: [@connect_mode] }
options[:external_encoding] = @encoding if @encoding

if @run_interval
child_process_execute(:exec_input, @command, interval: @run_interval, mode: [@connect_mode], &method(:run))
child_process_execute(:exec_input, @command, interval: @run_interval, **options, &method(:run))
else
child_process_execute(:exec_input, @command, immediate: true, mode: [@connect_mode], &method(:run))
child_process_execute(:exec_input, @command, immediate: true, **options, &method(:run))
end
end

Expand Down
37 changes: 37 additions & 0 deletions test/plugin/test_in_exec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,43 @@ def create_driver(conf)
end
end

sub_test_case 'encoding' do
data(immediate: "")
data(run_interval: "run_interval 1")
test 'can handle none-ascii characters' do |additional_setting|
daipom marked this conversation as resolved.
Show resolved Hide resolved
content = 'ひらがな漢字'

d = create_driver %[
command ruby -e "puts '#{content}'"
tag test
encoding utf-8
<parse>
@type none
</parse>
#{additional_setting}
]

d.run(expect_records: 1, timeout: 10)

assert_equal 1, d.events.length
tag, time, record = d.events.first
assert_equal({"message" => content}, record)
end

test 'raise ConfigError for invalid encoding' do
assert_raise Fluent::ConfigError do
d = create_driver %[
command ruby -e "puts foo"
tag test
encoding invalid-encode
<parse>
@type none
</parse>
]
end
end
end

data(
'default' => [TSV_CONFIG, "tag1", event_time("2011-01-02 13:14:15"), {"k1"=>"ok"}],
'json' => [JSON_CONFIG, "tag1", event_time("2011-01-02 13:14:15"), {"k1"=>"ok"}],
Expand Down