Merge pull request #76 from yaauie/ecs-v8

ecs: add v8 preview with v1 implementation

Author: yaauie

CHANGELOG.md

@@ -1,5 +1,6 @@
-## Unreleased
-  - Fix: update to Gradle 7 [#75](https://github.com/logstash-plugins/logstash-filter-useragent/pull/75)
+## 3.3.2
+  - Added preview of ECS-v8 support with existing ECS-v1 implementation [#76](https://github.com/logstash-plugins/logstash-filter-useragent/pull/76)
+  - Internal: update to Gradle 7 [#75](https://github.com/logstash-plugins/logstash-filter-useragent/pull/75)
 
 ## 3.3.1
  - Fix: invalid 3.3.0 release which did not package correctly [#71](https://github.com/logstash-plugins/logstash-filter-useragent/pull/71)

docs/index.asciidoc

@@ -125,7 +125,7 @@ filter plugins.
 * Value type is <<string,string>>
 * Supported values are:
 ** `disabled`: does not use ECS-compatible field names (fields might be set at the root of the event)
-** `v1`: uses fields that are compatible with Elastic Common Schema (for example, `[user_agent][version]`)
+** `v1`, `v8`: uses fields that are compatible with Elastic Common Schema (for example, `[user_agent][version]`)
 * Default value depends on which version of Logstash is running:
 ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
 ** Otherwise, the default value is `disabled`.

lib/logstash/filters/useragent.rb

@@ -14,7 +14,7 @@
 # <https://github.com/tobie/ua-parser/>.
 class LogStash::Filters::UserAgent < LogStash::Filters::Base
 
-  include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1)
+  include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
 
   config_name "useragent"
 

logstash-filter-useragent.gemspec

@@ -22,7 +22,7 @@ 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.1'
+  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
   s.add_development_dependency 'logstash-devutils'
 end
 

spec/filters/useragent_spec.rb

@@ -13,7 +13,7 @@
   let(:event) { LogStash::Event.new('message' => message) }
 
   context 'with target', :ecs_compatibility_support do
-    ecs_compatibility_matrix(:disabled, :v1) do |ecs_select|
+    ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
 
       let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
 
@@ -237,7 +237,7 @@
   end
 
   context "manually specified regexes file", :ecs_compatibility_support do
-    ecs_compatibility_matrix(:disabled, :v1) do |ecs_select|
+    ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
 
       let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
 
@@ -275,7 +275,7 @@
   end
 
   context "without target field", :ecs_compatibility_support do
-    ecs_compatibility_matrix(:disabled, :v1) do |ecs_select|
+    ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
 
       let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
 
@@ -310,7 +310,7 @@
   end
 
   context "nested target field", :ecs_compatibility_support do
-    ecs_compatibility_matrix(:disabled, :v1) do
+    ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do
 
       before(:each) do
         allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
@@ -337,7 +337,7 @@
   end
 
   context "without user agent", :ecs_compatibility_support do
-    ecs_compatibility_matrix(:disabled, :v1) do |ecs_select|
+    ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
 
       let(:ecs_compatibility?) { ecs_select.active_mode != :disabled }
 
@@ -383,7 +383,7 @@
   end
 
   context "with prefix", :ecs_compatibility_support do
-    ecs_compatibility_matrix(:disabled, :v1) do |ecs_select|
+    ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
 
       let(:message) { 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Firefox/78.0' }
       let(:options) { super().merge('prefix' => 'pre_') }
@@ -402,7 +402,7 @@
       end if ecs_select.active_mode == :disabled
 
       it 'warns in ECS mode (and ignores prefix)' do
-        expect( subject.logger ).to receive(:warn).with /Field prefix isn't supported in ECS compatibility mode/
+        expect( subject.logger ).to receive(:warn).with %r{Field prefix isn't supported in ECS compatibility mode}
         subject.register
 
         subject.filter(event)
@@ -416,7 +416,7 @@
   end
 
   context "no prefix", :ecs_compatibility_support do
-    ecs_compatibility_matrix(:disabled, :v1) do
+    ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do
 
       let(:message) { 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Firefox/78.0' }
 

version

@@ -1 +1 @@
-3.3.1
+3.3.2