From 59c8e7646ca3789fa1cb96aab9cb2f17656499ee Mon Sep 17 00:00:00 2001 From: Kenji Okimoto Date: Fri, 27 Nov 2015 15:38:59 +0900 Subject: [PATCH 1/3] Add description for buf_memory See http://docs.fluentd.org/v0.12/categories/buf_memory --- lib/fluent/plugin/buf_memory.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/fluent/plugin/buf_memory.rb b/lib/fluent/plugin/buf_memory.rb index f725d503d5..81d69256d8 100644 --- a/lib/fluent/plugin/buf_memory.rb +++ b/lib/fluent/plugin/buf_memory.rb @@ -70,6 +70,7 @@ def initialize super end + desc 'If true, queued chunks are flushed at shutdown process. Otherwise queued chunks are discarded' config_param :flush_at_shutdown, :bool, :default => true # Overwrite default BasicBuffer#buffer_queue_limit # to limit total memory usage upto 512MB. From cd68dce0b6128b4a90f189b2196957831b09c0fc Mon Sep 17 00:00:00 2001 From: Kenji Okimoto Date: Fri, 27 Nov 2015 15:39:32 +0900 Subject: [PATCH 2/3] Add descriptions for buf_file See http://docs.fluentd.org/v0.12/categories/buf_file --- lib/fluent/plugin/buf_file.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/fluent/plugin/buf_file.rb b/lib/fluent/plugin/buf_file.rb index bce9bc41e9..21a015c16d 100644 --- a/lib/fluent/plugin/buf_file.rb +++ b/lib/fluent/plugin/buf_file.rb @@ -95,7 +95,9 @@ def initialize @uri_parser = URI::Parser.new end + desc 'The path where buffer chunks are stored.' config_param :buffer_path, :string + desc 'If true, queued chunks are flushed at shutdown process.' config_param :flush_at_shutdown, :bool, :default => false # 'symlink_path' is currently only for out_file. From 04dd3cc95ff152405ff72c5dd7258b3ff961d8d8 Mon Sep 17 00:00:00 2001 From: Kenji Okimoto Date: Fri, 27 Nov 2015 15:39:55 +0900 Subject: [PATCH 3/3] Add descriptions for Fluent::BasicBuffer This is super class for Fluent::FileBuffer and Fluent::MemoryBuffer. See followings: * http://docs.fluentd.org/v0.12/categories/buf_memory * http://docs.fluentd.org/v0.12/categories/buf_file --- lib/fluent/buffer.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/fluent/buffer.rb b/lib/fluent/buffer.rb index 4b06de4bf3..30dda85c54 100644 --- a/lib/fluent/buffer.rb +++ b/lib/fluent/buffer.rb @@ -139,7 +139,9 @@ def enable_parallel(b=true) # This configuration assumes plugins to send records to a remote server. # Local file based plugins which should provide more reliability and efficiency # should override buffer_chunk_limit with a larger size. + desc 'The size of each buffer chunk.' config_param :buffer_chunk_limit, :size, :default => 8*1024*1024 + desc 'The length limit of the chunk queue.' config_param :buffer_queue_limit, :integer, :default => 256 alias chunk_limit buffer_chunk_limit