From 81f3922fefd62c21e997683e1d746078fb7963f1 Mon Sep 17 00:00:00 2001 From: Hiroshi Hatake Date: Tue, 10 Nov 2015 18:41:58 +0900 Subject: [PATCH 1/3] Add descriptions to out_file plugin parameters --- lib/fluent/plugin/out_file.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/fluent/plugin/out_file.rb b/lib/fluent/plugin/out_file.rb index 2d08336704..83d4539937 100644 --- a/lib/fluent/plugin/out_file.rb +++ b/lib/fluent/plugin/out_file.rb @@ -23,9 +23,13 @@ class FileOutput < TimeSlicedOutput 'gzip' => :gz, } + desc "Specify filepath to output." config_param :path, :string + desc "Choose output format. You can choose it from registered formatter plugins." config_param :format, :string, :default => 'out_file' + desc "Disable path increment." config_param :append, :bool, :default => false + desc "Compress chunks with specified compression algorithm." config_param :compress, :default => nil do |val| c = SUPPORTED_COMPRESS[val] unless c @@ -33,6 +37,7 @@ class FileOutput < TimeSlicedOutput end c end + desc "A parameter is used for pointing to latest written file." config_param :symlink_path, :string, :default => nil def initialize From 5886edd38ebf0f42c708e11ad157f0488b8a8d8e Mon Sep 17 00:00:00 2001 From: Hiroshi Hatake Date: Tue, 10 Nov 2015 19:17:39 +0900 Subject: [PATCH 2/3] Fix descriptions with suggested ones --- lib/fluent/plugin/out_file.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/fluent/plugin/out_file.rb b/lib/fluent/plugin/out_file.rb index 83d4539937..72fbdc80cb 100644 --- a/lib/fluent/plugin/out_file.rb +++ b/lib/fluent/plugin/out_file.rb @@ -29,7 +29,7 @@ class FileOutput < TimeSlicedOutput config_param :format, :string, :default => 'out_file' desc "Disable path increment." config_param :append, :bool, :default => false - desc "Compress chunks with specified compression algorithm." + desc "Compress flushed file." config_param :compress, :default => nil do |val| c = SUPPORTED_COMPRESS[val] unless c @@ -37,7 +37,7 @@ class FileOutput < TimeSlicedOutput end c end - desc "A parameter is used for pointing to latest written file." + desc "Create symlink to temporary buffered file when buffer_type is file." config_param :symlink_path, :string, :default => nil def initialize From d982166470498b205bca71c543e2c52410467dce Mon Sep 17 00:00:00 2001 From: Hiroshi Hatake Date: Tue, 10 Nov 2015 19:20:38 +0900 Subject: [PATCH 3/3] Use fluentd.org's out_file parameters descriptions --- lib/fluent/plugin/out_file.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/fluent/plugin/out_file.rb b/lib/fluent/plugin/out_file.rb index 72fbdc80cb..ea2c0f02e4 100644 --- a/lib/fluent/plugin/out_file.rb +++ b/lib/fluent/plugin/out_file.rb @@ -23,11 +23,11 @@ class FileOutput < TimeSlicedOutput 'gzip' => :gz, } - desc "Specify filepath to output." + desc "The Path of the file." config_param :path, :string - desc "Choose output format. You can choose it from registered formatter plugins." + desc "The format of the file content. The default is out_file." config_param :format, :string, :default => 'out_file' - desc "Disable path increment." + desc "The flushed chunk is appended to existence file or not." config_param :append, :bool, :default => false desc "Compress flushed file." config_param :compress, :default => nil do |val|