logstash-mixin-ecs_compatibility_support 1.2.0-java → 1.3.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ff73bf503783cc17b6fbc2ebebcf23398d52ffa01cfc2a9d397566833f9706
-  data.tar.gz: 69d950da27ad60c8fdb09a08e72f7a4ffce9ede7e85cad0bfb130854cf40a07b
+  metadata.gz: 8a64fc499677faca675d99eccc08d8d397f6d1330b6073ce31ab1570a0e750d1
+  data.tar.gz: 6a4c3df642e4dc252d545069b4a7b301ecf246c2655b893409f1898643507353
 SHA512:
-  metadata.gz: 5334c125b5e9b24567500ae94546b3acd5260d7f83232eaa173439d68e8d974ca294f4a3f5b0c33d0d760ac4d843ea67bcb920b0713f480848e6d5044a43895b
-  data.tar.gz: 3b5bddca9732f6f03f79d4bf8ebf0dbeedb120dd7b23703f68c7e8410f5896e7124e343a2a843ce0346eeee6463c02bf738d1add11fed102f7c12e4147707e8f
+  metadata.gz: b84794d3a79993ecb23464e8293ee9f44d2430f6901c5f92f5dfcaa46e45fe09b5ee6f353afe8a8b36afa976f1bcc8b4ee69e123d2b665e5cb2b1228c9aea445
+  data.tar.gz: bb9d04088b8dcdd81a1ffefeb9ef1e5eec02e4fd24491684630e5c7e5c9a007121604c5b3435433f6a971b8e42eb2b0e926b1355fc0021e22f53a8de899cd433

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.3.0
+ - Feat: introduce a target check helper [#6](https://github.com/logstash-plugins/logstash-mixin-ecs_compatibility_support/pull/6) 
+
 # 1.2.0
  - Added support for resolution aliases, allowing a plugin that uses `ecs_select` to support multiple ECS versions with a single declaration.
 

data/lib/logstash/plugin_mixins/ecs_compatibility_support/target_check.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require_relative '../ecs_compatibility_support'
+
+module LogStash
+  module PluginMixins
+    module ECSCompatibilitySupport
+      # A target option check that can be included into any `LogStash::Plugin`.
+      #
+      # @see ECSCompatibilitySupport()
+      module TargetCheck
+        ##
+        # @api internal (use: `LogStash::Plugin::include`)
+        # @param base [Class]: a class that inherits `LogStash::Plugin`, typically one
+        #                      descending from one of the four plugin base classes
+        #                      (e.g., `LogStash::Inputs::Base`)
+        # @return [void]
+        def self.included(base)
+          fail(ArgumentError, "`#{base}` must inherit LogStash::Plugin") unless base < LogStash::Plugin
+          fail(ArgumentError, "`#{base}` must include #{ECSCompatibilitySupport}") unless base < ECSCompatibilitySupport
+          base.prepend(RegisterDecorator)
+        end
+
+        TARGET_NOT_SET_MESSAGE = ("ECS compatibility is enabled but `target` option was not specified. " +
+            "This may cause fields to be set at the top-level of the event where they are likely to clash with the Elastic Common Schema. " +
+            "It is recommended to set the `target` option to avoid potential schema conflicts (if your data is ECS compliant " +
+            "or non-conflicting, feel free to ignore this message)").freeze
+
+        private
+
+        ##
+        # Check whether `target` is specified.
+        #
+        # @return [nil] if target is unspecified and ECS compatibility is disabled
+        # @return [true, false]
+        def target_set?
+          return true unless target.nil?
+          return nil if ecs_compatibility == :disabled
+          false # target isn't set
+        end
+
+        module RegisterDecorator
+
+          ##
+          # Logs an info message when ecs_compatibility is enabled but plugin has no `target` configuration specified.
+          # @override
+          def register
+            super.tap do
+              logger.info(TARGET_NOT_SET_MESSAGE) if target_set? == false
+            end
+          end
+
+        end
+        private_constant :RegisterDecorator
+      end
+    end
+  end
+end

data/spec/logstash/plugin_mixins/ecs_compatibility_support/target_check_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+require "logstash-core"
+
+require 'logstash/inputs/base'
+require 'logstash/filters/base'
+require 'logstash/codecs/base'
+require 'logstash/outputs/base'
+
+require "logstash/plugin_mixins/ecs_compatibility_support/target_check"
+
+describe LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck do
+
+  describe "check_target_set_in_ecs_mode" do
+
+    context 'with a plugin' do
+
+      subject(:plugin_class) do
+        Class.new(LogStash::Filters::Base) do
+          include LogStash::PluginMixins::ECSCompatibilitySupport
+          include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
+
+          config :target, :validate => :string
+
+          def register; 42 end
+
+        end
+      end
+
+      it 'skips check when ECS disabled' do
+        plugin = plugin_class.new('ecs_compatibility' => 'disabled')
+        allow( plugin.logger ).to receive(:info)
+        expect( plugin.register ).to eql 42
+        expect( plugin.logger ).to_not have_received(:info).with(a_string_including "`target` option")
+      end
+
+      it 'warns when target is not set in ECS mode' do
+        plugin = plugin_class.new('ecs_compatibility' => 'v1')
+        allow( plugin.logger ).to receive(:info)
+        expect( plugin.register ).to eql 42
+        expect( plugin.logger ).to have_received(:info).with(a_string_including "ECS compatibility is enabled but `target` option was not specified.")
+      end
+
+      it 'does not warn when target is set' do
+        plugin = plugin_class.new('ecs_compatibility' => 'v1', 'target' => 'foo')
+        allow( plugin.logger ).to receive(:info)
+        expect( plugin.register ).to eql 42
+        expect( plugin.logger ).to_not have_received(:info).with(a_string_including "`target` option")
+      end
+
+    end
+
+    it 'fails check when no target config' do
+      plugin_class = Class.new(LogStash::Filters::Base) do
+        include LogStash::PluginMixins::ECSCompatibilitySupport
+        include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
+
+        def register; end
+
+      end
+      plugin = plugin_class.new('ecs_compatibility' => 'v1')
+      expect { plugin.register }.to raise_error NameError, /\btarget\b/
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-mixin-ecs_compatibility_support
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -96,8 +96,10 @@ files:
 - lib/logstash/plugin_mixins/ecs_compatibility_support.rb
 - lib/logstash/plugin_mixins/ecs_compatibility_support/selector.rb
 - lib/logstash/plugin_mixins/ecs_compatibility_support/spec_helper.rb
+- lib/logstash/plugin_mixins/ecs_compatibility_support/target_check.rb
 - spec/logstash/plugin_mixins/ecs_compatibility_support/selector_spec.rb
 - spec/logstash/plugin_mixins/ecs_compatibility_support/spec_helper_spec.rb
+- spec/logstash/plugin_mixins/ecs_compatibility_support/target_check_spec.rb
 - spec/logstash/plugin_mixins/ecs_compatibility_support_spec.rb
 homepage: https://github.com/logstash-plugins/logstash-mixin-ecs_compatibility_support
 licenses:
@@ -127,4 +129,5 @@ summary: Support for the ECS-Compatibility mode introduced in Logstash 7.x, for
 test_files:
 - spec/logstash/plugin_mixins/ecs_compatibility_support/selector_spec.rb
 - spec/logstash/plugin_mixins/ecs_compatibility_support/spec_helper_spec.rb
+- spec/logstash/plugin_mixins/ecs_compatibility_support/target_check_spec.rb
 - spec/logstash/plugin_mixins/ecs_compatibility_support_spec.rb