logstash-filter-fingerprint 3.2.2 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13e031f1122fff7d28e213e702e7d4ffbae573c76daf65445bb8e1059187f7db
-  data.tar.gz: 20046dd2014ef538c96de60c2c7ac7c5ec62542f14f3dbb65f5987ad79e4bf81
+  metadata.gz: 5985afeb097946794b24fa48da9e78f4a4146e39b7a39b4be98f11c2b74cd7f8
+  data.tar.gz: 1e6ba943dbae9448dacf4bcf8f4d268aa48381d816be73630f6594358090c8d4
 SHA512:
-  metadata.gz: 4213b3572ebbae2559d5873fc0b2e2322c0c2b5d7df1dd2e8361c55b5d684560862b1b26f3d0ad54a2e0e827a51d31c393e466ed1d0a979694567aff7e7a9289
-  data.tar.gz: 4c4acdab141a7159c8eabd411f23e2d66925c3baecda1f2b75b0a57e000e18883c55edf81a1e1601d2ced5b3ecbda9d9884c12fc0f129ecab7987d35d72627a2
+  metadata.gz: 63d38e83879e80b301af57fd82fbf60630ace866b6f102425e8d3ae97467b5384b17268215e52854c35bf1c24e7dfe8f6bd448fa9821f7289610c794232d7a48
+  data.tar.gz: 566ef91a8e6d67abf113bdd07621f65d47a290d0b12f7278d881d3eb13cdaf8c6346147eee3d4534a4184ec70544440177b9821b54e61f58ace71a84ae821669

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.2.3
+  - [DOC] Expanded description for concatenate_sources behavior and provided examples [#60](https://github.com/logstash-plugins/logstash-filter-fingerprint/pull/60)
+
 ## 3.2.2
   - Fixed lack of consistent fingerprints on Hash/Map objects [#55](https://github.com/logstash-plugins/logstash-filter-fingerprint/pull/55)
 

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-fingerprint.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-fingerprint)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-fingerprint.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-fingerprint)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -23,9 +23,9 @@ include::{include_path}/plugin_header.asciidoc[]
 Create consistent hashes (fingerprints) of one or more fields and store
 the result in a new field.
 
-This can e.g. be used to create consistent document ids when inserting
-events into Elasticsearch, allowing events in Logstash to cause existing
-documents to be updated rather than new documents to be created.
+You can use this plugin to create consistent document ids when  events are
+inserted into Elasticsearch. This approach means that existing documents can be
+updated instead of creating new documents.
 
 NOTE: When the `target` option is set to `UUID` the result won't be
 a consistent hash but a random
@@ -72,9 +72,53 @@ base64 encoded rather than hex encoded strings.
 When set to `true` and `method` isn't `UUID` or `PUNCTUATION`, the
 plugin concatenates the names and values of all fields given in the
 `source` option into one string (like the old checksum filter) before
-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.
+doing the fingerprint computation. 
+
+If `false` and multiple source fields are given, the target field will be single
+fingerprint of the last source field.
+
+**Example: `concatenate_sources`=false**
+
+This example produces a single fingerprint that is computed from "birthday," the
+last source field.
+
+[source,ruby]
+-----
+fingerprint {
+  source => ["user_id", "siblings", "birthday"]
+}
+-----
+
+The output is:
+
+[source,ruby]
+-----
+"fingerprint" => "6b6390a4416131f82b6ffb509f6e779e5dd9630f". 
+-----
+
+**Example: `concatenate_sources`=false with array**
+
+If the last source field is an array, you get an array of fingerprints. 
+
+In this example, "siblings" is an array ["big brother", "little sister", "little brother"].
+
+[source,ruby]
+-----
+fingerprint {
+  source => ["user_id", "siblings"]
+}
+-----
+
+The output is:
+
+[source,ruby]
+-----
+ "fingerprint" => [
+        [0] "8a8a9323677f4095fcf0c8c30b091a0133b00641",
+        [1] "2ce11b313402e0e9884e094409f8d9fcf01337c2",
+        [2] "adc0b90f9391a82098c7b99e66a816e9619ad0a7"
+    ],
+-----
 
 [id="plugins-{type}s-{plugin}-concatenate_all_fields"]
 ===== `concatenate_all_fields` 

data/logstash-filter-fingerprint.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-fingerprint'
-  s.version         = '3.2.2'
+  s.version         = '3.2.3'
   s.licenses        = ['Apache-2.0']
   s.summary         = "Fingerprints fields 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

@@ -18,11 +18,11 @@ describe LogStash::Filters::Fingerprint do
 
   context "with a string field" do
     let(:data) { {"clientip" => "123.123.123.123" } }
-    let(:config) { super.merge("source" => ["clientip" ]) }
+    let(:config) { super().merge("source" => ["clientip" ]) }
 
     describe "the IPV4_NETWORK method" do
       let(:fingerprint_method) { "IPV4_NETWORK" }
-      let(:config) { super.merge("key" => 24) }
+      let(:config) { super().merge("key" => 24) }
 
       it "fingerprints the ip as the network" do
         expect(fingerprint).to eq("123.123.123.0")
@@ -45,20 +45,20 @@ describe LogStash::Filters::Fingerprint do
       end
 
       context "with HMAC" do
-        let(:config) { super.merge("key" => "longencryptionkey") }
+        let(:config) { super().merge("key" => "longencryptionkey") }
 
         it "fingerprints the value" do
           expect(fingerprint).to eq("fdc60acc4773dc5ac569ffb78fcb93c9630797f4")
         end
         context "with HMAC and base64 encoding" do
-          let(:config) { super.merge("base64encode" => true) }
+          let(:config) { super().merge("base64encode" => true) }
           it "fingerprints the value" do
             expect(fingerprint).to eq("/cYKzEdz3FrFaf+3j8uTyWMHl/Q=")
           end
         end
       end
       context "and base64 encoding" do
-        let(:config) { super.merge("base64encode" => true) }
+        let(:config) { super().merge("base64encode" => true) }
         it "fingerprints the value" do
           expect(fingerprint).to eq("OlB2xSC0tGP0OAaJbqCzl40J3K4=")
         end
@@ -71,12 +71,12 @@ describe LogStash::Filters::Fingerprint do
         expect(fingerprint).to eq("4dabcab210766e35f03e77120e6986d6e6d4752b2a9ff22980b9253d026080d8")
       end
       context "with HMAC" do
-        let(:config) { super.merge("key" => "longencryptionkey") }
+        let(:config) { super().merge("key" => "longencryptionkey") }
         it "fingerprints the value" do
           expect(fingerprint).to eq("345bec3eff242d53b568916c2610b3e393d885d6b96d643f38494fd74bf4a9ca")
         end
         context "and base64 encoding" do
-          let(:config) { super.merge("base64encode" => true) }
+          let(:config) { super().merge("base64encode" => true) }
           it "fingerprints the value" do
             expect(fingerprint).to eq("NFvsPv8kLVO1aJFsJhCz45PYhda5bWQ/OElP10v0qco=")
           end
@@ -90,12 +90,12 @@ describe LogStash::Filters::Fingerprint do
         expect(fingerprint).to eq("fd605b0a3af3e04ce0d7a0b0d9c48d67a12dab811f60072e6eae84e35d567793ffb68a1807536f11c90874065c2a4392")
       end
       context "with HMAC" do
-        let(:config) { super.merge("key" => "longencryptionkey") }
+        let(:config) { super().merge("key" => "longencryptionkey") }
         it "fingerprints the value" do
           expect(fingerprint).to eq("22d4c0e8c4fbcdc4887d2038fca7650f0e2e0e2457ff41c06eb2a980dded6749561c814fe182aff93e2538d18593947a")
         end
         context "and base64 encoding" do
-          let(:config) { super.merge("base64encode" => true) }
+          let(:config) { super().merge("base64encode" => true) }
           it "fingerprints the value" do
             expect(fingerprint).to eq("ItTA6MT7zcSIfSA4/KdlDw4uDiRX/0HAbrKpgN3tZ0lWHIFP4YKv+T4lONGFk5R6")
           end
@@ -108,12 +108,12 @@ describe LogStash::Filters::Fingerprint do
         expect(fingerprint).to eq("5468e2dc64ea92b617782aae884b35af60041ac9e168a283615b6a462c54c13d42fa9542cce9b7d76a8124ac6616818905e3e5dd35d6e519f77c3b517558639a")
       end
       context "with HMAC" do
-        let(:config) { super.merge("key" => "longencryptionkey") }
+        let(:config) { super().merge("key" => "longencryptionkey") }
         it "fingerprints the value" do
           expect(fingerprint).to eq("11c19b326936c08d6c50a3c847d883e5a1362e6a64dd55201a25f2c1ac1b673f7d8bf15b8f112a4978276d573275e3b14166e17246f670c2a539401c5bfdace8")
         end
         context "and base64 encoding" do
-          let(:config) { super.merge("base64encode" => true) }
+          let(:config) { super().merge("base64encode" => true) }
           it "fingerprints the value" do
             expect(fingerprint).to eq("EcGbMmk2wI1sUKPIR9iD5aE2Lmpk3VUgGiXywawbZz99i/FbjxEqSXgnbVcydeOxQWbhckb2cMKlOUAcW/2s6A==")
           end
@@ -126,12 +126,12 @@ describe LogStash::Filters::Fingerprint do
         expect(fingerprint).to eq("ccdd8d3d940a01b2fb3258c059924c0d")
       end
       context "with HMAC" do
-        let(:config) { super.merge("key" => "longencryptionkey") }
+        let(:config) { super().merge("key" => "longencryptionkey") }
         it "fingerprints the value" do
           expect(fingerprint).to eq("9336c879e305c9604a3843fc3e75948f")
         end
         context "and base64 encoding" do
-          let(:config) { super.merge("base64encode" => true) }
+          let(:config) { super().merge("base64encode" => true) }
           it "fingerprints the value" do
             expect(fingerprint).to eq("kzbIeeMFyWBKOEP8PnWUjw==")
           end
@@ -141,7 +141,7 @@ describe LogStash::Filters::Fingerprint do
   end
 
   context "multiple values in the source field" do
-    let(:config) { super.merge("source" => ["clientip" ]) }
+    let(:config) { super().merge("source" => ["clientip" ]) }
     let(:data) { { "clientip" => [ "123.123.123.123", "223.223.223.223" ] } }
 
     it "produces a fingerprint array" do
@@ -162,7 +162,7 @@ describe LogStash::Filters::Fingerprint do
   end
 
   context "when multiple fields are used" do
-    let(:config) { super.merge("source" => ['field1', 'field2']) }
+    let(:config) { super().merge("source" => ['field1', 'field2']) }
     let(:data) { { "field1" => "test1", "field2" => "test2" } }
 
     it "fingerprints the value of the last value" do
@@ -171,7 +171,7 @@ describe LogStash::Filters::Fingerprint do
     end
 
     describe "with concatenate_sources" do
-      let(:config) { super.merge("concatenate_sources" => true) }
+      let(:config) { super().merge("concatenate_sources" => true) }
       it "fingerprints the value of concatenated key/pairs" do
         # SHA1 of "|field1|test1|field2|test2|"
         expect(fingerprint).to eq("e3b6b71eedc656f1d29408264e8a75535db985cb")
@@ -181,7 +181,7 @@ describe LogStash::Filters::Fingerprint do
 
   describe "PUNCTUATION method" do
     let(:fingerprint_method) { 'PUNCTUATION' }
-    let(:config) { super.merge("source" => 'field1') }
+    let(:config) { super().merge("source" => 'field1') }
     let(:data) { { "field1" =>  "PHP Warning:  json_encode() [<a href='function.json-encode'>function.json-encode</a>]: Invalid UTF-8 sequence in argument in /var/www/htdocs/test.php on line 233" } }
 
     it "extracts punctiation as the fingerprint" do
@@ -191,10 +191,10 @@ describe LogStash::Filters::Fingerprint do
 
   context 'Timestamps' do
     epoch_time = Time.at(0).gmtime
-    let(:config) { super.merge("source" => ['@timestamp']) }
+    let(:config) { super().merge("source" => ['@timestamp']) }
 
     describe 'OpenSSL Fingerprinting' do
-      let(:config) { super.merge("key" => '0123') }
+      let(:config) { super().merge("key" => '0123') }
       let(:fingerprint_method) { "SHA1" }
       let(:data) { { "@timestamp" => epoch_time } }
       it "fingerprints the timestamp correctly" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-fingerprint
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.2.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement