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.

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

Add descriptions to out_file plugin parameters #701

Merged
merged 3 commits into from
Nov 13, 2015
Merged

Add descriptions to out_file plugin parameters #701

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81f3922
Add descriptions to out_file plugin parameters
cosmo0920 Nov 10, 2015
5886edd
Fix descriptions with suggested ones
cosmo0920 Nov 10, 2015
d982166
Use fluentd.org's out_file parameters descriptions
cosmo0920 Nov 10, 2015
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
5 changes: 5 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 @@ -23,16 +23,21 @@ class FileOutput < TimeSlicedOutput
'gzip' => :gz,
}

desc "The Path of the file."
config_param :path, :string
desc "The format of the file content. The default is out_file."
config_param :format, :string, :default => 'out_file'
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|
c = SUPPORTED_COMPRESS[val]
unless c
raise ConfigError, "Unsupported compression algorithm '#{val}'"
end
c
end
desc "Create symlink to temporary buffered file when buffer_type is file."
config_param :symlink_path, :string, :default => nil
Copy link
Member

Choose a reason for hiding this comment

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

Should be like

Create symlink to temporary buffered file when buffer_type is file.


def initialize
Expand Down