Plugin Helper: Parser

parser helper manages parser plugin life cycle.
Here is the code example with parser helper:
require 'fluent/plugin/input'
​
module Fluent::Plugin
  class ExampleInput < Input
    Fluent::Plugin.register_input('example', self)
​
    # 1. load parser helper
    helpers :parser
​
    # omit shutdown and other plugin API
​
    def configure(conf)
      super
​
      # 2. Create parser plugin instance
      @parser = parser_create
    end
​
    def start
      super
​
      # use parser helper in combination with other plugin helpers usually
      timer_execute(:example_timer, 10) do
        read_raw_data do |text|
          # 3. call @parser.parse(text) to parse raw data
          @parser.parse(text) do |time, record|
            router.emit(tag, time, record)
          end
        end
      end
    end
  end
end
For more details about parser plugin, see following articles:
​Parser Plugin Overview​
​Writing Parser Plugins​
​Parser plugin​
Methods
parser_create(usage: "", type: nil, conf: nil, default_type: nil)
This method creates parser plugin instance with given parameters.
usage: unique name. This is required when multiple parsers are
used in the plugin
type: parser type
conf: parser plugin configuration
default_type: default parser type
Code examples:
# Create parser plugin instance using <parse> section in fluent.conf during configure phase
@parser = parser_create
@parser.parse(text) do |time, record|
  ...
end
​
# Create JSON parser
@json_parser = parser_create(usage: 'parser_in_example_json', type: 'json')
@json_parser.parse(json) do |time, record|
  ...
end
​
# Create MessagePack paser
@msgpack_parser = parser_create(usage: 'parser_in_example_msgpack', type: 'msgpack')
@msgpack_parser.parse(msgpack_binary) do |time, record|
   ...
end
parser used plugins
​Parser filter​
​Exec input​
​HTTP input​
​Syslog input​
​Tail input​
​TCP input​
​UDP input​
​Exec filter output​
If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is a open source project under Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.
Plugin Helper: Inject
Plugin Helper: Record Accessor
Last updated 1 month ago