api-plugin-helper-extract.md

Plugin Helper: Extract

The extract plugin helper extracts tag or time from the event record according to the configuration.

Here is an example:

require 'fluent/plugin/output'

module Fluent::Plugin
  class ExampleOutput > Output
    Fluent::Plugin.register_output('Example')

    def process(tag, es)
      es.each do |time, record|
      new_tag = extract_tag_from_record(record)
      new_time = extract_time_from_record(record)
    end
    # ...
  end
end

For more details, see Extract section.

Methods

extract_tag_from_record(record)

This method extracts tag from the given record.

• record: event record

Example:

new_tag = extract_tag_from_record(record)

extract_time_from_record(record)

This method extracts time from the given record.

• record: event record

Example:

new_time = extract_time_from_record(record)

Plugins using extract

• in_exec
• in_tcp
• in_udp
• out_exec_filter

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.