Skip to content

Backport(v1.19): buffer: warn if default timekey (1d) will be used (#5276) #5291

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

Open
github-actions wants to merge 1 commit into
base: v1.19
Choose a base branch
from
Open

Backport(v1.19): buffer: warn if default timekey (1d) will be used (#5276) #5291

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
10 changes: 10 additions & 0 deletions lib/fluent/plugin/out_file.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,17 @@ def configure(conf)
configured_time_slice_format = conf['time_slice_format']

if conf.elements(name: 'buffer').empty?
# no <buffer> section, default time chunk key and timekey (1d) will be used.
log.warn "default timekey interval (1d) will be used because of missing <buffer> section. To change the output frequency, please modify the timekey value"

conf.add_element('buffer', 'time')
else
unless conf.elements(name: 'buffer').first.has_key?('timekey')
if conf.elements(name: 'buffer').first.arg != "[]"
# with <buffer> section (except <buffer []>), and no timekey
log.warn "default timekey interval (1d) will be used. To change the output frequency, please modify the timekey value"
end
end
end
buffer_conf = conf.elements(name: 'buffer').first
# Fluent::PluginId#configure is not called yet, so we can't use #plugin_root_dir here.
Expand Down
48 changes: 48 additions & 0 deletions test/command/test_fluentd.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1712,4 +1712,52 @@ def create_config_include_dir_configuration(config_path, config_dir, yaml_format
expected_warning_message)
end
end

sub_test_case "test suspicious timekey interval (1d) in out_file configuration" do
data('without buffer' => {buffer: nil, buffer_arg: nil, message: :missing_buffer},
'buffer' => {buffer: true, buffer_arg: '', message: :warning},
'buffer time' => {buffer: true, buffer_arg: 'time', message: :warning},
'buffer []' => {buffer: true, buffer_arg: '[]', message: nil})
test 'warn the default value of timekey (1d) is used as-is' do |data|
prefix = "default timekey interval (1d) will be used"
advice = "To change the output frequency, please modify the timekey value"
missing_warning = "#{prefix} because of missing <buffer> section. #{advice}"
warning = "#{prefix}. #{advice}"

conf_path = if data[:buffer]
create_conf_file("warning.conf", <<~EOF)
<system>
config_include_dir ""
</system>
<match>
@type file
tag test
path #{@tmp_dir}/test.log
<buffer #{data[:buffer_arg]}>
@type file
</buffer>
</match>
EOF
else
create_conf_file("warning.conf", <<~EOF)
<system>
config_include_dir ""
</system>
<match>
@type file
tag test
path #{@tmp_dir}/test.log
</match>
EOF
end
case data[:message]
when :missing_buffer
assert_log_matches(create_cmdline(conf_path, '--dry-run'), missing_warning, patterns_not_match: [warning])
when :warning
assert_log_matches(create_cmdline(conf_path, '--dry-run'), "warning", patterns_not_match: [missing_warning])
else
assert_log_matches(create_cmdline(conf_path, '--dry-run'), patterns_not_match: [warning, missing_warning])
end
end
end
end