Contents

#
# Copyright 2018- Zhimin (Gimi) Liang (https://github.com/Gimi)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require "fluent/plugin/formatter"

module Fluent
  module Plugin
    class JqFormatter < Fluent::Plugin::Formatter
      EMPTY_STRING = ''.freeze

      Fluent::Plugin.register_formatter("jq", self)

      desc 'The jq program used to format income events. The result of the program should only return one item of any kind (a string, an array, an object, etc.). If it returns multiple items, only the first will be used.'
      config_param :jq_program

      desc 'Defines the behavior on error happens when formatting an event. "skip" will skip the event; "ignore" will ignore the error and return the JSON representation of the original event; "raise_error" will raise a RuntimeError.'
      config_param :on_error, :enum, list: [:skip, :ignore, :raise_error], default: :ignore

      def initialize
	super
	require "jq"
      end

      def configure(conf)
	super
	JQ::Core.new @jq_program
      rescue JQ::Error
	raise Fluent::ConfigError, "Could not parse jq_program, error: #{$!.message}"
      end

      def format(tag, time, record)
	item = JQ(record.to_json).search(@jq_program).first
	return item if item.instance_of?(String)
	item.to_json
      rescue JQ::Error
	msg = "Failed to format #{record.to_json} with #{@jq_program}, error: #{$!.message}"
	log.error msg
	case @on_error
	when :skip
	  return EMPTY_STRING
	when :ignore
	  return record.to_json
	when :raise_error
	  raise msg
	end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
fluent-plugin-jq-0.1.0	lib/fluent/plugin/formatter_jq.rb