logstash-filter-fingerprint 3.0.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a502b11d145b463a450bd1669f6644bf051562c
-  data.tar.gz: b9e7aa2c105419346a1679800a90b7b7201ec801
+  metadata.gz: 14ea4c93a45f7e5a3792b6c251a05ab75f9727fd
+  data.tar.gz: bd7a89aacc70afd45a166a91a6cdf8e6794d056f
 SHA512:
-  metadata.gz: 00789a1b6aa331ae025351a340e449790622cef8f2f77679408c1c0855c5f0c6127188fb7d6c715828da2d723ed1a2af02dc1e7dfc2737fb34c1fd165c19ac3b
-  data.tar.gz: dd546230448ecb213b3ae5246466614b6f144fd7a1fdd5f93530c295238bc1748a804b859783861556807304737cf6eccd0ebae31a39754429f3dabd62349a2c
+  metadata.gz: a1a3474f9b9a140c49ade799c53a8b061e9e5894fa6d62064586e688b0f606e7261ff017d5be0b9d02da47a7e340d727ef8a87e5a81c69b2ee5d207b857c2796
+  data.tar.gz: 114a5e5a0b61c864cfcbeb8588c083371821109e9e63394f40253b17eb8afd690eff1a3a6920acd6c8f718a598c57d844d4619cc9cd37e050f1f4449e3f206e5

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.1.0
+  - Add new setting `concatenate_all_fields`
+
+## 3.0.4
+  - Documentation improvements
+
 ## 3.0.3
   - improve documentation and register exception messaging
 

data/docs/index.asciidoc

@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="plugins-{type}-{plugin}"]
+[id="plugins-{type}s-{plugin}"]
 
 === Fingerprint filter plugin
 
@@ -45,6 +45,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-base64encode>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-concatenate_sources>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-concatenate_all_fields>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-key>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-method>> |<<string,string>>, one of `["SHA1", "SHA256", "SHA384", "SHA512", "MD5", "MURMUR3", "IPV4_NETWORK", "UUID", "PUNCTUATION"]`|Yes
 | <<plugins-{type}s-{plugin}-source>> |<<array,array>>|No
@@ -78,6 +79,19 @@ doing the fingerprint computation. If `false` and multiple source
 fields are given, the target field will be an array with fingerprints
 of the source fields given.
 
+[id="plugins-{type}s-{plugin}-concatenate_all_fields"]
+===== `concatenate_sources` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+When set to `true` and `method` isn't `UUID` or `PUNCTUATION`, the
+plugin concatenates the names and values of all fields of the event 
+into one string (like the old checksum filter) before doing the 
+fingerprint computation. If `false` and at least one source field is 
+given, the target field will be an array with fingerprints of the 
+source fields given.
+
 [id="plugins-{type}s-{plugin}-key"]
 ===== `key` 
 

data/lib/logstash/filters/fingerprint.rb

@@ -70,6 +70,11 @@ class LogStash::Filters::Fingerprint < LogStash::Filters::Base
   # of the source fields given.
   config :concatenate_sources, :validate => :boolean, :default => false
 
+  # When set to `true` and `method` isn't `UUID` or `PUNCTUATION`, the 
+  # plugin concatenates the names and values of all fields in the event 
+  # without having to proide the field names in the `source` attribute
+  config :concatenate_all_fields, :validate => :boolean, :default => false
+
   def register
     # convert to symbol for faster comparisons
     @method = @method.to_sym
@@ -119,10 +124,16 @@ class LogStash::Filters::Fingerprint < LogStash::Filters::Base
         event.set(@target, event.get(field).gsub(/[^[\p{P}\p{S}]]/,''))
       end
     else
-      if @concatenate_sources
+      if @concatenate_sources || @concatenate_all_fields
         to_string = ""
-        @source.sort.each do |k|
-          to_string << "|#{k}|#{event.get(k)}"
+        if @concatenate_all_fields
+          event.to_hash.sort.map do |k,v|
+            to_string << "|#{k}|#{v}"
+          end
+        else
+          @source.sort.each do |k|
+            to_string << "|#{k}|#{event.get(k)}"
+          end
         end
         to_string << "|"
         @logger.debug? && @logger.debug("String built", :to_checksum => to_string)

data/logstash-filter-fingerprint.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-fingerprint'
-  s.version         = '3.0.4'
+  s.version         = '3.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Fingerprint fields using by replacing values with a consistent hash."
   s.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"

data/spec/filters/fingerprint_spec.rb

@@ -51,6 +51,23 @@ describe LogStash::Filters::Fingerprint do
     end
   end
 
+  describe "fingerprint string with SHA1 alogrithm on all event fields" do
+    config <<-CONFIG
+      filter {
+        fingerprint {
+          concatenate_all_fields => true
+          key => "longencryptionkey"
+          method => 'SHA1'
+        }
+      }
+    CONFIG
+
+    # The @timestamp field is specified in this sample event as we need the event contents to be constant for the tests
+    sample("@timestamp" => "2017-07-26T14:44:27.064Z", "clientip" => "123.123.123.123", "message" => "This is a test message", "log_level" => "INFO", "offset" => 123456789, "type" => "test") do
+      insist { subject.get("fingerprint") } == "d7c617f4d40b2cb677a7003af68a41c415f58031"
+    end
+  end
+
   describe "fingerprint string with SHA1 alogrithm and base64 encoding" do
     config <<-CONFIG
       filter {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-fingerprint
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement