fluent-plugin-viaq_data_model 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ffc8861a24c80f6044ffe80d9e38c5f675a46554
4
+ data.tar.gz: 26a1dfb59dfacaac6975c8a76ef03aff6896380e
5
+ SHA512:
6
+ metadata.gz: 5b7314c78d6b2443aff7d31f5008e95dd2dad8192e248cd1a34d09f31c7828aef16d94fd4e7a4effd283b627ef2a6f641ee014cf6fa9e1fe5acfc0937246fd99
7
+ data.tar.gz: b118bb6a73721dbb05e82492222b03530722ad6539bd10026bdc66a051fc5f9a2a8fa7772838b2ec2c81450f7edec100a1461096a5c77f472ef26b0e6e980c3a
data/.gitignore ADDED
@@ -0,0 +1,52 @@
1
+ *.gem
2
+ *.rbc
3
+ /.config
4
+ /coverage/
5
+ /InstalledFiles
6
+ /pkg/
7
+ /spec/reports/
8
+ /spec/examples.txt
9
+ /test/tmp/
10
+ /test/version_tmp/
11
+ /tmp/
12
+
13
+ # Used by dotenv library to load environment variables.
14
+ # .env
15
+
16
+ ## Specific to RubyMotion:
17
+ .dat*
18
+ .repl_history
19
+ build/
20
+ *.bridgesupport
21
+ build-iPhoneOS/
22
+ build-iPhoneSimulator/
23
+
24
+ ## Specific to RubyMotion (use of CocoaPods):
25
+ #
26
+ # We recommend against adding the Pods directory to your .gitignore. However
27
+ # you should judge for yourself, the pros and cons are mentioned at:
28
+ # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
29
+ #
30
+ # vendor/Pods/
31
+
32
+ ## Documentation cache and generated files:
33
+ /.yardoc/
34
+ /_yardoc/
35
+ /doc/
36
+ /rdoc/
37
+
38
+ ## Environment normalization:
39
+ /.bundle/
40
+ /vendor/bundle
41
+ /lib/bundler/man/
42
+
43
+ # for a library or gem, you might want to ignore these files since the code is
44
+ # intended to run in multiple environments; otherwise, check them in:
45
+ # Gemfile.lock
46
+ # .ruby-version
47
+ # .ruby-gemset
48
+
49
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
50
+ .rvmrc
51
+ vendor
52
+ *~
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,2 @@
1
+ # fluent-plugin-viaq_data_model
2
+ helps format records into viaq data model
data/Rakefile ADDED
@@ -0,0 +1,37 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rake/testtask'
3
+ #require 'bump/tasks'
4
+
5
+ task :test => [:base_test]
6
+
7
+ task :default => [:test, :build]
8
+
9
+ desc 'Run test_unit based test'
10
+ Rake::TestTask.new(:base_test) do |t|
11
+ # To run test for only one file (or file path pattern)
12
+ # $ bundle exec rake base_test TEST=test/test_specified_path.rb
13
+ # $ bundle exec rake base_test TEST=test/test_*.rb
14
+ t.libs << 'test'
15
+ t.test_files = Dir['test/test_*.rb'].sort
16
+ #t.verbose = true
17
+ t.warning = false
18
+ end
19
+
20
+ desc 'Add copyright headers'
21
+ task :headers do
22
+ require 'rubygems'
23
+ require 'copyright_header'
24
+
25
+ args = {
26
+ :license => 'ASL2',
27
+ :copyright_software => 'Fluentd ViaQ Data Model Filter Plugin',
28
+ :copyright_software_description => 'Ensure Fluentd events use the ViaQ Data Model',
29
+ :copyright_holders => ['Red Hat, Inc.'],
30
+ :copyright_years => ['2017'],
31
+ :add_path => 'lib:test',
32
+ :output_dir => '.'
33
+ }
34
+
35
+ command_line = CopyrightHeader::CommandLine.new( args )
36
+ command_line.execute
37
+ end
data/Vagrantfile ADDED
@@ -0,0 +1,71 @@
1
+ # -*- mode: ruby -*-
2
+ # vi: set ft=ruby :
3
+
4
+ # All Vagrant configuration is done below. The "2" in Vagrant.configure
5
+ # configures the configuration version (we support older styles for
6
+ # backwards compatibility). Please don't change it unless you know what
7
+ # you're doing.
8
+ Vagrant.configure(2) do |config|
9
+ # The most common configuration options are documented and commented below.
10
+ # For a complete reference, please see the online documentation at
11
+ # https://docs.vagrantup.com.
12
+
13
+ # Every Vagrant development environment requires a box. You can search for
14
+ # boxes at https://atlas.hashicorp.com/search.
15
+ config.vm.box = "openshift/origin-all-in-one"
16
+
17
+ # Disable automatic box update checking. If you disable this, then
18
+ # boxes will only be checked for updates when the user runs
19
+ # `vagrant box outdated`. This is not recommended.
20
+ # config.vm.box_check_update = false
21
+
22
+ # Create a forwarded port mapping which allows access to a specific port
23
+ # within the machine from a port on the host machine. In the example below,
24
+ # accessing "localhost:8080" will access port 80 on the guest machine.
25
+ # config.vm.network "forwarded_port", guest: 80, host: 8080
26
+
27
+ # Create a private network, which allows host-only access to the machine
28
+ # using a specific IP.
29
+ # config.vm.network "private_network", ip: "192.168.33.10"
30
+
31
+ # Create a public network, which generally matched to bridged network.
32
+ # Bridged networks make the machine appear as another physical device on
33
+ # your network.
34
+ # config.vm.network "public_network"
35
+
36
+ # Share an additional folder to the guest VM. The first argument is
37
+ # the path on the host to the actual folder. The second argument is
38
+ # the path on the guest to mount the folder. And the optional third
39
+ # argument is a set of non-required options.
40
+ # config.vm.synced_folder "../data", "/vagrant_data"
41
+
42
+ # Provider-specific configuration so you can fine-tune various
43
+ # backing providers for Vagrant. These expose provider-specific options.
44
+ # Example for VirtualBox:
45
+ #
46
+ # config.vm.provider "virtualbox" do |vb|
47
+ # # Display the VirtualBox GUI when booting the machine
48
+ # vb.gui = true
49
+ #
50
+ # # Customize the amount of memory on the VM:
51
+ # vb.memory = "1024"
52
+ # end
53
+ #
54
+ # View the documentation for the provider you are using for more
55
+ # information on available options.
56
+
57
+ # Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
58
+ # such as FTP and Heroku are also available. See the documentation at
59
+ # https://docs.vagrantup.com/v2/push/atlas.html for more information.
60
+ # config.push.define "atlas" do |push|
61
+ # push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
62
+ # end
63
+
64
+ # Enable provisioning with a shell script. Additional provisioners such as
65
+ # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
66
+ # documentation for more information about their specific syntax and use.
67
+ # config.vm.provision "shell", inline: <<-SHELL
68
+ # sudo apt-get update
69
+ # sudo apt-get install -y apache2
70
+ # SHELL
71
+ end
@@ -0,0 +1,11 @@
1
+ <filter **>
2
+ @type viaq_data_model
3
+ default_keep_fields CEE,docker,file,geoip,hostname,kubernetes,level,message,offset,pid,pipeline_metadata,rsyslog,service,systemd,tags,time
4
+ extra_keep_fields "#{ENV['CDM_EXTRA_KEEP_FIELDS'] || ''}"
5
+ keep_empty_fields "#{ENV['CDM_KEEP_EMPTY_FIELDS'] || 'message'}"
6
+ use_undefined "#{ENV['CDM_USE_UNDEFINED'] || false}"
7
+ undefined_name "#{ENV['CDM_UNDEFINED_NAME'] || 'undefined'}"
8
+ rename_time "#{ENV['CDM_RENAME_TIME'] || true}"
9
+ src_time_name "#{ENV['CDM_SRC_TIME_NAME'] || 'time'}"
10
+ dest_time_name "#{ENV['CDM_DEST_TIME_NAME'] || '@timestamp'}"
11
+ </filter>
@@ -0,0 +1,31 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+
5
+ Gem::Specification.new do |gem|
6
+ gem.name = "fluent-plugin-viaq_data_model"
7
+ gem.version = "0.0.1"
8
+ gem.authors = ["Rich Megginson"]
9
+ gem.email = ["rmeggins@redhat.com"]
10
+ gem.description = %q{Filter plugin to ensure data is in the ViaQ common data model}
11
+ gem.summary = %q{Filter plugin to ensure data is in the ViaQ common data model}
12
+ gem.homepage = "https://github.com/ViaQ/fluent-plugin-viaq_data_mode"
13
+ gem.license = "Apache-2.0"
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
17
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
18
+ gem.require_paths = ["lib"]
19
+ gem.has_rdoc = false
20
+
21
+ gem.required_ruby_version = '>= 2.0.0'
22
+
23
+ gem.add_runtime_dependency "fluentd", ">= 0.12.0"
24
+
25
+ gem.add_development_dependency "bundler", "~> 1.3"
26
+ gem.add_development_dependency "rake"
27
+ gem.add_development_dependency "minitest", "~> 4.0"
28
+ gem.add_development_dependency "test-unit", "~> 3.0.2"
29
+ gem.add_development_dependency "test-unit-rr", "~> 1.0.3"
30
+ gem.add_development_dependency "copyright-header"
31
+ end
@@ -0,0 +1,116 @@
1
+ require 'fluent/filter'
2
+ require 'fluent/log'
3
+
4
+ module Fluent
5
+ class ViaqDataModelFilter < Filter
6
+ Fluent::Plugin.register_filter('viaq_data_model', self)
7
+
8
+ desc 'Default list of comma-delimited fields to keep in each record'
9
+ config_param :default_keep_fields, default: [] do |val|
10
+ val.split(',')
11
+ end
12
+
13
+ desc 'Optional extra list of comma-delimited fields to keep in each record'
14
+ config_param :extra_keep_fields, default: [] do |val|
15
+ val.split(',')
16
+ end
17
+
18
+ # The kibana pod emits log records with an empty message field
19
+ # we want to preserve these empty messages
20
+ desc 'List of fields to keep as empty fields - also added to extra_keep_fields'
21
+ config_param :keep_empty_fields, default: ['message'] do |val|
22
+ val.split(',')
23
+ end
24
+
25
+ desc 'Use "undefined" field to store fields not in above lists'
26
+ config_param :use_undefined, :bool, default: false
27
+
28
+ desc 'Name of undefined field to store fields not in above lists if use_undefined is true'
29
+ config_param :undefined_name, :string, default: 'undefined'
30
+
31
+ # we can't directly add a field called @timestamp in a record_transform
32
+ # filter because the '@' is special to fluentd
33
+ desc 'Rename timestamp field to Elasticsearch compatible name'
34
+ config_param :rename_time, :bool, default: true
35
+
36
+ desc 'Name of source timestamp field'
37
+ config_param :src_time_name, :string, default: 'time'
38
+
39
+ desc 'Name of destination timestamp field'
40
+ config_param :dest_time_name, :string, default: '@timestamp'
41
+
42
+
43
+ def configure(conf)
44
+ super
45
+ @keep_fields = {}
46
+ @default_keep_fields.each{|xx| @keep_fields[xx] = true}
47
+ @extra_keep_fields.each{|xx| @keep_fields[xx] = true}
48
+ @keep_empty_fields_hash = {}
49
+ @keep_empty_fields.each do |xx|
50
+ @keep_empty_fields_hash[xx] = true
51
+ @keep_fields[xx] = true
52
+ end
53
+ if @use_undefined && @keep_fields.key?(@undefined_name)
54
+ raise Fluent::ConfigError, "Do not put [#{@undefined_name}] in default_keep_fields or extra_keep_fields"
55
+ end
56
+ if @rename_time && @use_undefined && !@keep_fields.key?(@src_time_name)
57
+ raise Fluent::ConfigError, "Field [#{@src_time_name}] must be listed in default_keep_fields or extra_keep_fields"
58
+ end
59
+ end
60
+
61
+ def start
62
+ super
63
+ end
64
+
65
+ def shutdown
66
+ super
67
+ end
68
+
69
+ # if thing doesn't respond to empty? then assume it isn't empty e.g.
70
+ # 0.respond_to?(:empty?) == false - the FixNum 0 is not empty
71
+ def isempty(thing)
72
+ thing.respond_to?(:empty?) && thing.empty?
73
+ end
74
+
75
+ # recursively delete empty fields and empty lists/hashes from thing
76
+ def delempty(thing)
77
+ if thing.respond_to?(:delete_if)
78
+ thing.delete_if{|k,v| v.nil? || isempty(delempty(v)) || isempty(v)}
79
+ end
80
+ thing
81
+ end
82
+
83
+ def filter(tag, time, record)
84
+ if ENV['CDM_DEBUG']
85
+ unless tag == ENV['CDM_DEBUG_IGNORE_TAG']
86
+ log.error("input #{time} #{tag} #{record}")
87
+ end
88
+ end
89
+ if @use_undefined
90
+ # undefined contains all of the fields not in keep_fields
91
+ undefined = record.reject{|k,v| @keep_fields.key?(k)}
92
+ # only set the undefined field if there are undefined fields
93
+ unless undefined.empty?
94
+ record[@undefined_name] = undefined
95
+ # remove the undefined fields from the record top level
96
+ record.delete_if{|k,v| undefined.key?(k)}
97
+ end
98
+ end
99
+ # remove the field from record if it is not in the list of fields to keep and
100
+ # it is empty
101
+ record.delete_if{|k,v| !@keep_empty_fields_hash.key?(k) && (v.nil? || isempty(delempty(v)) || isempty(v))}
102
+ # probably shouldn't remove everything . . .
103
+ log.warn("Empty record! tag [#{tag}] time [#{time}]") if record.empty?
104
+ # rename the time field
105
+ if @rename_time && record.key?(@src_time_name)
106
+ record[@dest_time_name] = record.delete(@src_time_name)
107
+ end
108
+ if ENV['CDM_DEBUG']
109
+ unless tag == ENV['CDM_DEBUG_IGNORE_TAG']
110
+ log.error("output #{time} #{tag} #{record}")
111
+ end
112
+ end
113
+ record
114
+ end
115
+ end
116
+ end
@@ -0,0 +1,177 @@
1
+ #
2
+ # Fluentd Viaq Data Model Filter Plugin - Ensure records coming from Fluentd
3
+ # use the correct Viaq data model formatting and fields.
4
+ #
5
+ # Copyright 2016 Red Hat, Inc.
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ #require_relative '../helper'
20
+ require 'rr'
21
+ require 'test/unit'
22
+ require 'test/unit/rr'
23
+ require 'fileutils'
24
+ require 'fluent/log'
25
+ require 'fluent/test'
26
+ require 'fluent/plugin/base'
27
+ require 'fluent/plugin_helper'
28
+
29
+ require 'fluent/plugin/filter_viaq_data_model'
30
+
31
+ class ViaqDataModelFilterTest < Test::Unit::TestCase
32
+ include Fluent
33
+
34
+ setup do
35
+ Fluent::Test.setup
36
+ @time = Fluent::Engine.now
37
+ log = Fluent::Engine.log
38
+ end
39
+
40
+ def create_driver(conf = '')
41
+ Test::FilterTestDriver.new(ViaqDataModelFilter, 'this.is.a.tag').configure(conf, true)
42
+ end
43
+
44
+ sub_test_case 'configure' do
45
+ test 'check default' do
46
+ d = create_driver
47
+ assert_equal([], d.instance.default_keep_fields)
48
+ assert_equal([], d.instance.extra_keep_fields)
49
+ assert_equal(['message'], d.instance.keep_empty_fields)
50
+ assert_equal(false, d.instance.use_undefined)
51
+ assert_equal('undefined', d.instance.undefined_name)
52
+ assert_equal(true, d.instance.rename_time)
53
+ assert_equal('time', d.instance.src_time_name)
54
+ assert_equal('@timestamp', d.instance.dest_time_name)
55
+ end
56
+ test 'check various settings' do
57
+ d = create_driver('
58
+ default_keep_fields a,b,c
59
+ extra_keep_fields d,e,f
60
+ keep_empty_fields g,h,i
61
+ use_undefined true
62
+ undefined_name j
63
+ rename_time false
64
+ src_time_name k
65
+ dest_time_name l
66
+ ')
67
+ assert_equal(['a','b','c'], d.instance.default_keep_fields)
68
+ assert_equal(['d','e','f'], d.instance.extra_keep_fields)
69
+ assert_equal(['g','h','i'], d.instance.keep_empty_fields)
70
+ assert_equal(true, d.instance.use_undefined)
71
+ assert_equal('j', d.instance.undefined_name)
72
+ assert_equal(false, d.instance.rename_time)
73
+ assert_equal('k', d.instance.src_time_name)
74
+ assert_equal('l', d.instance.dest_time_name)
75
+ end
76
+ test 'error if undefined_name in default_keep_fields' do
77
+ assert_raise(Fluent::ConfigError) {
78
+ d = create_driver('
79
+ default_keep_fields a
80
+ use_undefined true
81
+ undefined_name a
82
+ ')
83
+ }
84
+ end
85
+ test 'error if undefined_name in extra_keep_fields' do
86
+ assert_raise(Fluent::ConfigError) {
87
+ d = create_driver('
88
+ extra_keep_fields a
89
+ use_undefined true
90
+ undefined_name a
91
+ ')
92
+ }
93
+ end
94
+ test 'error if src_time_field not in default_keep_fields' do
95
+ assert_raise(Fluent::ConfigError) {
96
+ d = create_driver('
97
+ default_keep_fields a
98
+ use_undefined true
99
+ rename_time true
100
+ src_time_name b
101
+ ')
102
+ }
103
+ end
104
+ test 'error if src_time_field not in extra_keep_fields' do
105
+ assert_raise(Fluent::ConfigError) {
106
+ d = create_driver('
107
+ extra_keep_fields a
108
+ use_undefined true
109
+ rename_time true
110
+ src_time_name b
111
+ ')
112
+ }
113
+ end
114
+ end
115
+
116
+ sub_test_case 'filtering' do
117
+ def emit_with_tag(tag, msg={}, conf='')
118
+ d = create_driver(conf)
119
+ d.run {
120
+ d.emit_with_tag(tag, msg, @time)
121
+ }.filtered.instance_variable_get(:@record_array)[0]
122
+ end
123
+ test 'see if undefined fields are kept at top level' do
124
+ rec = emit_with_tag('tag', {'a'=>'b'})
125
+ assert_equal('b', rec['a'])
126
+ end
127
+ test 'see if undefined fields are put in undefined field except for kept fields' do
128
+ rec = emit_with_tag('tag', {'a'=>'b','c'=>'d','e'=>'f'}, '
129
+ use_undefined true
130
+ default_keep_fields c
131
+ extra_keep_fields e
132
+ rename_time false
133
+ ')
134
+ assert_equal('b', rec['undefined']['a'])
135
+ assert_equal('d', rec['c'])
136
+ assert_equal('f', rec['e'])
137
+ end
138
+ test 'see if undefined fields are put in custom field except for kept fields' do
139
+ rec = emit_with_tag('tag', {'a'=>'b','c'=>'d','e'=>'f'}, '
140
+ use_undefined true
141
+ undefined_name custom
142
+ default_keep_fields c
143
+ extra_keep_fields e
144
+ rename_time false
145
+ ')
146
+ assert_equal('b', rec['custom']['a'])
147
+ assert_equal('d', rec['c'])
148
+ assert_equal('f', rec['e'])
149
+ end
150
+ test 'see if specified empty fields are kept at top level' do
151
+ rec = emit_with_tag('tag', {'a'=>'b','c'=>'','d'=>{}}, '
152
+ keep_empty_fields c,d
153
+ ')
154
+ assert_equal('b', rec['a'])
155
+ assert_equal('', rec['c'])
156
+ assert_equal({}, rec['d'])
157
+ end
158
+ test 'see if time field is renamed' do
159
+ rec = emit_with_tag('tag', {'a'=>'b'}, '
160
+ rename_time true
161
+ src_time_name a
162
+ dest_time_name c
163
+ ')
164
+ assert_equal('b', rec['c'])
165
+ assert_nil(rec['a'])
166
+ end
167
+ test 'see if deeply nested empty fields are removed or preserved' do
168
+ msg = {'a'=>{'b'=>{'c'=>{'d'=>{'e'=>'','f'=>{},'g'=>''}}}},'h'=>{'i'=>{'j'=>'','k'=>'l','m'=>99,'n'=>true}}}
169
+ rec = emit_with_tag('tag', msg)
170
+ assert_nil(rec['a'])
171
+ assert_equal('l', rec['h']['i']['k'])
172
+ assert_equal(99, rec['h']['i']['m'])
173
+ assert_true(rec['h']['i']['n'])
174
+ end
175
+
176
+ end
177
+ end
metadata ADDED
@@ -0,0 +1,152 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fluent-plugin-viaq_data_model
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Rich Megginson
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2017-02-13 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: fluentd
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 0.12.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 0.12.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.3'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: minitest
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '4.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '4.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: test-unit
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 3.0.2
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 3.0.2
83
+ - !ruby/object:Gem::Dependency
84
+ name: test-unit-rr
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 1.0.3
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 1.0.3
97
+ - !ruby/object:Gem::Dependency
98
+ name: copyright-header
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description: Filter plugin to ensure data is in the ViaQ common data model
112
+ email:
113
+ - rmeggins@redhat.com
114
+ executables: []
115
+ extensions: []
116
+ extra_rdoc_files: []
117
+ files:
118
+ - ".gitignore"
119
+ - LICENSE
120
+ - README.md
121
+ - Rakefile
122
+ - Vagrantfile
123
+ - filter-viaq_data_model.conf
124
+ - fluent-plugin-viaq_data_model.gemspec
125
+ - lib/fluent/plugin/filter_viaq_data_model.rb
126
+ - test/test_filter_viaq_data_model.rb
127
+ homepage: https://github.com/ViaQ/fluent-plugin-viaq_data_mode
128
+ licenses:
129
+ - Apache-2.0
130
+ metadata: {}
131
+ post_install_message:
132
+ rdoc_options: []
133
+ require_paths:
134
+ - lib
135
+ required_ruby_version: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: 2.0.0
140
+ required_rubygems_version: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - ">="
143
+ - !ruby/object:Gem::Version
144
+ version: '0'
145
+ requirements: []
146
+ rubyforge_project:
147
+ rubygems_version: 2.5.2
148
+ signing_key:
149
+ specification_version: 4
150
+ summary: Filter plugin to ensure data is in the ViaQ common data model
151
+ test_files:
152
+ - test/test_filter_viaq_data_model.rb