Plugin Helper: Compat Parameters
compat_parameters helper convert parameters from v0.12 to v1.0 style.
Here is an example:
require 'fluent/plugin/output'​module Fluent::Pluginclass ExampleOutput < OutputFluent::Plugin.register_output('example', self)​# 1. Load `compat_parameters` helperhelpers :compat_parameters​# Omit `start`, `shutdown` and other plugin APIs​def configure(conf)compat_parameters_convert(conf, :buffer, :inject, default_chunk_key: 'time')super​# ...endendend
conf:Fluent::Configurationinstancetypes: Following types are supported::buffer:inject:extract:parser:formatter
kwargs:default_chunk_key: Sets the default chunk key. For more details,
IMPORTANT: You cannot mix v1.0 and v0.12 styles in one plugin directive. If you mix v1.0 and v0.12 styles, v1.0 style is used and v0.12 style is ignored.
Here is an example:
<match pattern>@type foo# This flush_interval is ignored because <buffer> exist. No conversion.flush_interval 30s# This <buffer> parameters are used<buffer>@type filepath /path/to/bufferretry_max_times 10queue_limit_length 256</buffer></match>
old (v0.12) | new (v1) | note |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| also set |
|
| ​ |
|
| ​ |
|
| exclusive with |
|
| exclusive with |
This flat configuration:
buffer_type filebuffer_path /path/to/bufferretry_limit 10flush_interval 30sbuffer_queue_limit 256
converts to:
<buffer>@type filepath /path/to/bufferretry_max_times 10flush_interval 30squeue_limit_length 256</buffer>
For more details, see Buffer Section Configuration.
old (v0.12) | new (v1) | note |
|
| if |
|
| ​ |
|
| ​ |
|
| ​ |
|
| if |
|
| ​ |
|
| exclusive with |
|
| exclusive with |
This flat configuration:
include_time_keytime_key event_timeutc
converts to:
<inject>time_key event_timelocaltime false</inject>
For more details, see Inject Plugin Helper API.
old (v0.12) | new (v1) | note |
|
| ​ |
|
| ​ |
|
| ​ |
|
| ​ |
|
| exclusive with |
|
| exclusive with |
This flat configuration:
include_time_keytime_key event_timeutc
converts to:
<extract>time_key event_timelocaltime false</extract>
For more details, see Extract Plugin Helper API​
old (v0.12) | new (v1) | note | plugin |
|
| ​ | ​ |
|
| converted to JSON format | ​ |
|
| ​ | ​ |
|
| ​ | ​ |
|
| ​ |
|
|
| ​ | ​ |
|
| ​ | ​ |
|
| exclusive with | ​ |
|
| exclusive with | ​ |
|
| ​ | ​ |
|
| ​ | ​ |
|
| ​ | ​ |
|
| ​ | ​ |
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
This flat configuration:
format /^(?<log_time>[^ ]*) (?<message>)+*/time_key log_timetime_format %Y%m%d%H%M%Skeep_time_key
converts into:
<parse>@type regexppattern /^(?<log_time>[^ ]*) (?<message>)+*/time_key log_timetime_format %Y%m%d%H%M%Skeep_time_key</parse>
For more details, see Parser Plugin Overview and Writing Parser Plugins.
old (v0.12) | new (v1) | note | plugin |
|
| ​ | ​ |
|
| ​ | ​ |
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| exclusive with |
|
|
| exclusive with |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
|
| ​ |
|
This flat configuration:
format json
converts to:
<format>@type json</format>
For more details, see Formatter Plugin Overview and Writing Formatter Plugins.
​
filter_parser​​
in_exec​​
in_http​​
in_syslog​​
in_tail​​
in_tcp​​
in_udp​​
out_exec​​
out_exec_filter​​
out_file​​
out_forward​​
out_stdout​
If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is an open-source project under Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.
