fluent-plugin-viaq_data_model 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffc8861a24c80f6044ffe80d9e38c5f675a46554
+  data.tar.gz: 26a1dfb59dfacaac6975c8a76ef03aff6896380e
+SHA512:
+  metadata.gz: 5b7314c78d6b2443aff7d31f5008e95dd2dad8192e248cd1a34d09f31c7828aef16d94fd4e7a4effd283b627ef2a6f641ee014cf6fa9e1fe5acfc0937246fd99
+  data.tar.gz: b118bb6a73721dbb05e82492222b03530722ad6539bd10026bdc66a051fc5f9a2a8fa7772838b2ec2c81450f7edec100a1461096a5c77f472ef26b0e6e980c3a

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+vendor
+*~

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.

data/README.md

@@ -0,0 +1,2 @@
+# fluent-plugin-viaq_data_model
+helps format records into viaq data model

data/Rakefile

@@ -0,0 +1,37 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+#require 'bump/tasks'
+
+task :test => [:base_test]
+
+task :default => [:test, :build]
+
+desc 'Run test_unit based test'
+Rake::TestTask.new(:base_test) do |t|
+  # To run test for only one file (or file path pattern)
+  #  $ bundle exec rake base_test TEST=test/test_specified_path.rb
+  #  $ bundle exec rake base_test TEST=test/test_*.rb
+  t.libs << 'test'
+  t.test_files = Dir['test/test_*.rb'].sort
+  #t.verbose = true
+  t.warning = false
+end
+
+desc 'Add copyright headers'
+task :headers do
+  require 'rubygems'
+  require 'copyright_header'
+
+  args = {
+    :license => 'ASL2',
+    :copyright_software => 'Fluentd ViaQ Data Model Filter Plugin',
+    :copyright_software_description => 'Ensure Fluentd events use the ViaQ Data Model',
+    :copyright_holders => ['Red Hat, Inc.'],
+    :copyright_years => ['2017'],
+    :add_path => 'lib:test',
+    :output_dir => '.'
+  }
+
+  command_line = CopyrightHeader::CommandLine.new( args )
+  command_line.execute
+end

data/Vagrantfile

@@ -0,0 +1,71 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://atlas.hashicorp.com/search.
+  config.vm.box = "openshift/origin-all-in-one"
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  # config.vm.box_check_update = false
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  # config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+  #   vb.memory = "1024"
+  # end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
+  # such as FTP and Heroku are also available. See the documentation at
+  # https://docs.vagrantup.com/v2/push/atlas.html for more information.
+  # config.push.define "atlas" do |push|
+  #   push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
+  # end
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  # config.vm.provision "shell", inline: <<-SHELL
+  #   sudo apt-get update
+  #   sudo apt-get install -y apache2
+  # SHELL
+end

data/filter-viaq_data_model.conf

@@ -0,0 +1,11 @@
+<filter **>
+  @type viaq_data_model
+  default_keep_fields CEE,docker,file,geoip,hostname,kubernetes,level,message,offset,pid,pipeline_metadata,rsyslog,service,systemd,tags,time
+  extra_keep_fields "#{ENV['CDM_EXTRA_KEEP_FIELDS'] || ''}"
+  keep_empty_fields "#{ENV['CDM_KEEP_EMPTY_FIELDS'] || 'message'}"
+  use_undefined "#{ENV['CDM_USE_UNDEFINED'] || false}"
+  undefined_name "#{ENV['CDM_UNDEFINED_NAME'] || 'undefined'}"
+  rename_time "#{ENV['CDM_RENAME_TIME'] || true}"
+  src_time_name "#{ENV['CDM_SRC_TIME_NAME'] || 'time'}"
+  dest_time_name "#{ENV['CDM_DEST_TIME_NAME'] || '@timestamp'}"
+</filter>

data/fluent-plugin-viaq_data_model.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-viaq_data_model"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Rich Megginson"]
+  gem.email         = ["rmeggins@redhat.com"]
+  gem.description   = %q{Filter plugin to ensure data is in the ViaQ common data model}
+  gem.summary       = %q{Filter plugin to ensure data is in the ViaQ common data model}
+  gem.homepage      = "https://github.com/ViaQ/fluent-plugin-viaq_data_mode"
+  gem.license       = "Apache-2.0"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.has_rdoc      = false
+
+  gem.required_ruby_version = '>= 2.0.0'
+
+  gem.add_runtime_dependency "fluentd", ">= 0.12.0"
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest", "~> 4.0"
+  gem.add_development_dependency "test-unit", "~> 3.0.2"
+  gem.add_development_dependency "test-unit-rr", "~> 1.0.3"
+  gem.add_development_dependency "copyright-header"
+end

data/lib/fluent/plugin/filter_viaq_data_model.rb

@@ -0,0 +1,116 @@
+require 'fluent/filter'
+require 'fluent/log'
+
+module Fluent
+  class ViaqDataModelFilter < Filter
+    Fluent::Plugin.register_filter('viaq_data_model', self)
+
+    desc 'Default list of comma-delimited fields to keep in each record'
+    config_param :default_keep_fields, default: [] do |val|
+      val.split(',')
+    end
+
+    desc 'Optional extra list of comma-delimited fields to keep in each record'
+    config_param :extra_keep_fields, default: [] do |val|
+      val.split(',')
+    end
+
+    # The kibana pod emits log records with an empty message field
+    # we want to preserve these empty messages
+    desc 'List of fields to keep as empty fields - also added to extra_keep_fields'
+    config_param :keep_empty_fields, default: ['message'] do |val|
+      val.split(',')
+    end
+
+    desc 'Use "undefined" field to store fields not in above lists'
+    config_param :use_undefined, :bool, default: false
+
+    desc 'Name of undefined field to store fields not in above lists if use_undefined is true'
+    config_param :undefined_name, :string, default: 'undefined'
+
+    # we can't directly add a field called @timestamp in a record_transform
+    # filter because the '@' is special to fluentd
+    desc 'Rename timestamp field to Elasticsearch compatible name'
+    config_param :rename_time, :bool, default: true
+
+    desc 'Name of source timestamp field'
+    config_param :src_time_name, :string, default: 'time'
+
+    desc 'Name of destination timestamp field'
+    config_param :dest_time_name, :string, default: '@timestamp'
+
+
+    def configure(conf)
+      super
+      @keep_fields = {}
+      @default_keep_fields.each{|xx| @keep_fields[xx] = true}
+      @extra_keep_fields.each{|xx| @keep_fields[xx] = true}
+      @keep_empty_fields_hash = {}
+      @keep_empty_fields.each do |xx|
+        @keep_empty_fields_hash[xx] = true
+        @keep_fields[xx] = true
+      end
+      if @use_undefined && @keep_fields.key?(@undefined_name)
+        raise Fluent::ConfigError, "Do not put [#{@undefined_name}] in default_keep_fields or extra_keep_fields"
+      end
+      if @rename_time && @use_undefined && !@keep_fields.key?(@src_time_name)
+        raise Fluent::ConfigError, "Field [#{@src_time_name}] must be listed in default_keep_fields or extra_keep_fields"
+      end
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    # if thing doesn't respond to empty? then assume it isn't empty e.g.
+    # 0.respond_to?(:empty?) == false - the FixNum 0 is not empty
+    def isempty(thing)
+      thing.respond_to?(:empty?) && thing.empty?
+    end
+
+    # recursively delete empty fields and empty lists/hashes from thing
+    def delempty(thing)
+      if thing.respond_to?(:delete_if)
+        thing.delete_if{|k,v| v.nil? || isempty(delempty(v)) || isempty(v)}
+      end
+      thing
+    end
+
+    def filter(tag, time, record)
+      if ENV['CDM_DEBUG']
+        unless tag == ENV['CDM_DEBUG_IGNORE_TAG']
+          log.error("input #{time} #{tag} #{record}")
+        end
+      end
+      if @use_undefined
+        # undefined contains all of the fields not in keep_fields
+        undefined = record.reject{|k,v| @keep_fields.key?(k)}
+        # only set the undefined field if there are undefined fields
+        unless undefined.empty?
+          record[@undefined_name] = undefined
+          # remove the undefined fields from the record top level
+          record.delete_if{|k,v| undefined.key?(k)}
+        end
+      end
+      # remove the field from record if it is not in the list of fields to keep and
+      # it is empty
+      record.delete_if{|k,v| !@keep_empty_fields_hash.key?(k) && (v.nil? || isempty(delempty(v)) || isempty(v))}
+      # probably shouldn't remove everything . . .
+      log.warn("Empty record! tag [#{tag}] time [#{time}]") if record.empty?
+      # rename the time field
+      if @rename_time && record.key?(@src_time_name)
+        record[@dest_time_name] = record.delete(@src_time_name)
+      end
+      if ENV['CDM_DEBUG']
+        unless tag == ENV['CDM_DEBUG_IGNORE_TAG']
+          log.error("output #{time} #{tag} #{record}")
+        end
+      end
+      record
+    end
+  end
+end

data/test/test_filter_viaq_data_model.rb

@@ -0,0 +1,177 @@
+#
+# Fluentd Viaq Data Model Filter Plugin - Ensure records coming from Fluentd
+# use the correct Viaq data model formatting and fields.
+#
+# Copyright 2016 Red Hat, Inc.
+#
+# 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_relative '../helper'
+require 'rr'
+require 'test/unit'
+require 'test/unit/rr'
+require 'fileutils'
+require 'fluent/log'
+require 'fluent/test'
+require 'fluent/plugin/base'
+require 'fluent/plugin_helper'
+
+require 'fluent/plugin/filter_viaq_data_model'
+
+class ViaqDataModelFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  setup do
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+    log = Fluent::Engine.log
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(ViaqDataModelFilter, 'this.is.a.tag').configure(conf, true)
+  end
+
+  sub_test_case 'configure' do
+    test 'check default' do
+      d = create_driver
+      assert_equal([], d.instance.default_keep_fields)
+      assert_equal([], d.instance.extra_keep_fields)
+      assert_equal(['message'], d.instance.keep_empty_fields)
+      assert_equal(false, d.instance.use_undefined)
+      assert_equal('undefined', d.instance.undefined_name)
+      assert_equal(true, d.instance.rename_time)
+      assert_equal('time', d.instance.src_time_name)
+      assert_equal('@timestamp', d.instance.dest_time_name)
+    end
+    test 'check various settings' do
+      d = create_driver('
+        default_keep_fields a,b,c
+        extra_keep_fields d,e,f
+        keep_empty_fields g,h,i
+        use_undefined true
+        undefined_name j
+        rename_time false
+        src_time_name k
+        dest_time_name l
+      ')
+      assert_equal(['a','b','c'], d.instance.default_keep_fields)
+      assert_equal(['d','e','f'], d.instance.extra_keep_fields)
+      assert_equal(['g','h','i'], d.instance.keep_empty_fields)
+      assert_equal(true, d.instance.use_undefined)
+      assert_equal('j', d.instance.undefined_name)
+      assert_equal(false, d.instance.rename_time)
+      assert_equal('k', d.instance.src_time_name)
+      assert_equal('l', d.instance.dest_time_name)
+    end
+    test 'error if undefined_name in default_keep_fields' do
+      assert_raise(Fluent::ConfigError) {
+        d = create_driver('
+          default_keep_fields a
+          use_undefined true
+          undefined_name a
+        ')
+      }
+    end
+    test 'error if undefined_name in extra_keep_fields' do
+      assert_raise(Fluent::ConfigError) {
+        d = create_driver('
+          extra_keep_fields a
+          use_undefined true
+          undefined_name a
+        ')
+      }
+    end
+    test 'error if src_time_field not in default_keep_fields' do
+      assert_raise(Fluent::ConfigError) {
+        d = create_driver('
+          default_keep_fields a
+          use_undefined true
+          rename_time true
+          src_time_name b
+        ')
+      }
+    end
+    test 'error if src_time_field not in extra_keep_fields' do
+      assert_raise(Fluent::ConfigError) {
+        d = create_driver('
+          extra_keep_fields a
+          use_undefined true
+          rename_time true
+          src_time_name b
+        ')
+      }
+    end
+  end
+
+  sub_test_case 'filtering' do
+    def emit_with_tag(tag, msg={}, conf='')
+      d = create_driver(conf)
+      d.run {
+        d.emit_with_tag(tag, msg, @time)
+      }.filtered.instance_variable_get(:@record_array)[0]
+    end
+    test 'see if undefined fields are kept at top level' do
+      rec = emit_with_tag('tag', {'a'=>'b'})
+      assert_equal('b', rec['a'])
+    end
+    test 'see if undefined fields are put in undefined field except for kept fields' do
+      rec = emit_with_tag('tag', {'a'=>'b','c'=>'d','e'=>'f'}, '
+        use_undefined true
+        default_keep_fields c
+        extra_keep_fields e
+        rename_time false
+      ')
+      assert_equal('b', rec['undefined']['a'])
+      assert_equal('d', rec['c'])
+      assert_equal('f', rec['e'])
+    end
+    test 'see if undefined fields are put in custom field except for kept fields' do
+      rec = emit_with_tag('tag', {'a'=>'b','c'=>'d','e'=>'f'}, '
+        use_undefined true
+        undefined_name custom
+        default_keep_fields c
+        extra_keep_fields e
+        rename_time false
+      ')
+      assert_equal('b', rec['custom']['a'])
+      assert_equal('d', rec['c'])
+      assert_equal('f', rec['e'])
+    end
+    test 'see if specified empty fields are kept at top level' do
+      rec = emit_with_tag('tag', {'a'=>'b','c'=>'','d'=>{}}, '
+        keep_empty_fields c,d
+      ')
+      assert_equal('b', rec['a'])
+      assert_equal('', rec['c'])
+      assert_equal({}, rec['d'])
+    end
+    test 'see if time field is renamed' do
+      rec = emit_with_tag('tag', {'a'=>'b'}, '
+        rename_time true
+        src_time_name a
+        dest_time_name c
+      ')
+      assert_equal('b', rec['c'])
+      assert_nil(rec['a'])
+    end
+    test 'see if deeply nested empty fields are removed or preserved' do
+      msg = {'a'=>{'b'=>{'c'=>{'d'=>{'e'=>'','f'=>{},'g'=>''}}}},'h'=>{'i'=>{'j'=>'','k'=>'l','m'=>99,'n'=>true}}}
+      rec = emit_with_tag('tag', msg)
+      assert_nil(rec['a'])
+      assert_equal('l', rec['h']['i']['k'])
+      assert_equal(99, rec['h']['i']['m'])
+      assert_true(rec['h']['i']['n'])
+    end
+
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-viaq_data_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rich Megginson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: copyright-header
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Filter plugin to ensure data is in the ViaQ common data model
+email:
+- rmeggins@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- Vagrantfile
+- filter-viaq_data_model.conf
+- fluent-plugin-viaq_data_model.gemspec
+- lib/fluent/plugin/filter_viaq_data_model.rb
+- test/test_filter_viaq_data_model.rb
+homepage: https://github.com/ViaQ/fluent-plugin-viaq_data_mode
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Filter plugin to ensure data is in the ViaQ common data model
+test_files:
+- test/test_filter_viaq_data_model.rb