logstash-filter-csv 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61380dfaee5f7c768ba33dbeb372644941053ccf3694c441b5f6bc5b7758af46
-  data.tar.gz: c9a4bfd2b2a2c0f4d4ccac90ba8d01722a5ed7833294e8cb749f1b4c2685d2ba
+  metadata.gz: bf9f8d4119cd1f50a3456eecc603223146a3a8af699161e69620830e94a89bd2
+  data.tar.gz: 955a26060fa7c92bdbc4f00b632e8c33ef2ade7ed54d03084503666d5f89a583
 SHA512:
-  metadata.gz: 472e1b1028701925b45aaa1990349cd6f277326e1151ba8eaacc7d48125d67528f8873c08bab7698237cdb1e35eaf39506de51623758327f91a29af36f4059f1
-  data.tar.gz: 0cc77c798c6fa3319f63aa4c9d56314686fa5bab7f6cbb0d6f221532e2007aacc1545235bfbe37fb3822125b62201bd78ef7fd3e6d48732e18f7d1990674db7b
+  metadata.gz: 8439e88c6dac47b52866730cb04c015cb1e88f439316063da35fb9264383ac7e177d45801aa0da64756b79bbfeee5d6ee0bbd31bc04b2e33475f839288b4da36
+  data.tar.gz: ce650dfb546568cd8983d4949662739fbe794b097ea391b4a20b0d46d2d793ad2090e9b212248def1d32721baf26f364c2a5d4e69275a0eef4e1f959b386dd05

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.1
+  - Refactor: unified ECS target + validate field reference [#86](https://github.com/logstash-plugins/logstash-filter-csv/pull/86)
+
 ## 3.1.0
   - Add ECS support [#85](https://github.com/logstash-plugins/logstash-filter-csv/pull/85)
 

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.1.1

data/lib/logstash/filters/csv.rb

@@ -1,7 +1,9 @@
 # encoding: utf-8
 require "logstash/filters/base"
 require "logstash/namespace"
-require "logstash/plugin_mixins/ecs_compatibility_support"
+require 'logstash/plugin_mixins/ecs_compatibility_support'
+require 'logstash/plugin_mixins/ecs_compatibility_support/target_check'
+require 'logstash/plugin_mixins/validator_support/field_reference_validation_adapter'
 
 require "csv"
 
@@ -10,6 +12,9 @@ require "csv"
 # This filter can also parse data with any separator, not just commas.
 class LogStash::Filters::CSV < LogStash::Filters::Base
   include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
+  include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
+
+  extend LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
 
   config_name "csv"
 
@@ -38,7 +43,7 @@ class LogStash::Filters::CSV < LogStash::Filters::Base
 
   # Define target field for placing the data.
   # Defaults to writing to the root of the event.
-  config :target, :validate => :string
+  config :target, :validate => :field_reference
 
   # Define whether column names should autogenerated or not.
   # Defaults to true. If set to false, columns not having a header specified will not be parsed.
@@ -105,15 +110,6 @@ class LogStash::Filters::CSV < LogStash::Filters::Base
   CONVERTERS.default = lambda {|v| v}
   CONVERTERS.freeze
 
-  def initialize(params)
-    super
-    if ecs_compatibility != :disabled && @target.nil?
-      logger.info('ECS compatibility is enabled but no ``target`` option was specified, it is recommended'\
-                  ' to set the option to avoid potential schema conflicts (if your data is ECS compliant or'\
-                  ' non-conflicting feel free to ignore this message)')
-    end
-  end
-
   def register
     # validate conversion types to be the valid ones.
     bad_types = @convert.values.select do |type|
@@ -125,7 +121,7 @@ class LogStash::Filters::CSV < LogStash::Filters::Base
     # @convert_symbols contains the symbolized types to avoid symbol conversion in the transform method
     @convert_symbols = @convert.inject({}){|result, (k, v)| result[k] = v.to_sym; result}
 
-    # make sure @target is in the format [field name] if defined, i.e. surrounded by brakets
+    # make sure @target is in the format [field name] if defined, i.e. surrounded by brackets
     @target = "[#{@target}]" if @target && !@target.start_with?("[")
     
     # if the zero byte character is entered in the config, set the value
@@ -137,7 +133,7 @@ class LogStash::Filters::CSV < LogStash::Filters::Base
   end
 
   def filter(event)
-    @logger.debug? && @logger.debug("Running csv filter", :event => event)
+    @logger.debug? && @logger.debug("Running csv filter", :event => event.to_hash)
 
     if (source = event.get(@source))
       begin
@@ -178,7 +174,7 @@ class LogStash::Filters::CSV < LogStash::Filters::Base
       end
     end
 
-    @logger.debug? && @logger.debug("Event after csv filter", :event => event)
+    @logger.debug? && @logger.debug("Event after csv filter", :event => event.to_hash)
   end
 
   private

data/logstash-filter-csv.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
+  s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'
+
   s.add_development_dependency 'logstash-devutils'
-  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~>1.2'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-csv
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -33,31 +33,45 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-devutils
+        version: '1.3'
+  name: logstash-mixin-ecs_compatibility_support
   prerelease: false
-  type: :development
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-  name: logstash-mixin-ecs_compatibility_support
+        version: '1.0'
+  name: logstash-mixin-validator_support
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem is a Logstash plugin required to be installed on top of the
   Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
   gem is not a stand-alone program