---
title: logstash docs for <%= section %>s/<%= name %>
layout: content_right
---
<%= name %>
<%= description %>
<% if !@flags.empty? -%>
<% end -%>
Synopsis
This is what it might look like in your config file:
<% if section == "codec" -%>
# with an input plugin:
# you can also use this codec with an output.
input {
file {
codec => <%= synopsis.split("\n").map { |l| " #{l}" }.join("\n") %>
}
}
<% else -%>
<%= section %> {
<%= synopsis %>
}
<% end -%>
Details
<% sorted_attributes.each do |name, config| -%>
<%
if name.is_a?(Regexp)
name = "/" + name.to_s.gsub(/^\(\?-mix:/, "").gsub(/\)$/, "") + "/"
is_regexp = true
else
is_regexp = false
end
-%>
<% if config[:deprecated] -%>
- DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
<% end -%>
<% if is_regexp -%>
- The configuration attribute name here is anything that matches the above regular expression.
<% end -%>
<% if config[:validate].is_a?(Symbol) -%>
- Value type is <%= config[:validate] %>
<% elsif config[:validate].nil? -%>
- Value type is string
<% elsif config[:validate].is_a?(Array) -%>
- Value can be any of: <%= config[:validate].map(&:inspect).join(", ") %>
<% end -%>
<% if config.include?(:default) -%>
- Default value is <%= config[:default].inspect %>
<% else -%>
- There is no default value for this setting.
<% end -%>
<%= config[:description] %>
<% end -%>
This is documentation from <%= file %>