logstash-filter-fingerprint 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3889ab595d8eca1bc3da12afedeccf70c57370d
-  data.tar.gz: e6b9ac28e026a168dc2b59ca51cd9df3af7369b6
+  metadata.gz: 1a502b11d145b463a450bd1669f6644bf051562c
+  data.tar.gz: b9e7aa2c105419346a1679800a90b7b7201ec801
 SHA512:
-  metadata.gz: 8ca3a82727adf9af513c611fe06151e22c251043a222bde4bb699e889186bf04631b27780ba75ad83daa9682a615a5d9fed40b543e35e0e82a4481e5c5d8edc1
-  data.tar.gz: 0a8f6d898e1d2109e968284c7c26c5feadc6bf66d8d61b64d6a25634ae1cd78af01002da0c4001f0edd83bdaec334983490f30edbabe2ea35eafa1f647532d6f
+  metadata.gz: 00789a1b6aa331ae025351a340e449790622cef8f2f77679408c1c0855c5f0c6127188fb7d6c715828da2d723ed1a2af02dc1e7dfc2737fb34c1fd165c19ac3b
+  data.tar.gz: dd546230448ecb213b3ae5246466614b6f144fd7a1fdd5f93530c295238bc1748a804b859783861556807304737cf6eccd0ebae31a39754429f3dabd62349a2c

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,139 @@
+:plugin: fingerprint
+:type: filter
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Fingerprint filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+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.
+
+NOTE: When using any method other than 'UUID', 'PUNCTUATION' or 'MURMUR3'
+you must set the key, otherwise the plugin will raise an exception
+
+NOTE: When the `target` option is set to `UUID` the result won't be
+a consistent hash but a random
+https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID].
+To generate UUIDs, prefer the <<plugins-filters-uuid,uuid filter>>.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Fingerprint Filter Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|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}-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
+| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-base64encode"]
+===== `base64encode` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+When set to `true`, the `SHA1`, `SHA256`, `SHA384`, `SHA512` and `MD5` fingerprint methods will produce
+base64 encoded rather than hex encoded strings.
+
+[id="plugins-{type}s-{plugin}-concatenate_sources"]
+===== `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 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.
+
+[id="plugins-{type}s-{plugin}-key"]
+===== `key` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+When used with the `IPV4_NETWORK` method fill in the subnet prefix length.
+Key is required with all methods except  `MURMUR3`, `PUNCTUATION` or `UUID`.
+With other methods fill in the HMAC key.
+
+[id="plugins-{type}s-{plugin}-method"]
+===== `method` 
+
+  * This is a required setting.
+  * Value can be any of: `SHA1`, `SHA256`, `SHA384`, `SHA512`, `MD5`, `MURMUR3`, `IPV4_NETWORK`, `UUID`, `PUNCTUATION`
+  * Default value is `"SHA1"`
+
+The fingerprint method to use.
+
+If set to `SHA1`, `SHA256`, `SHA384`, `SHA512`, or `MD5` the
+cryptographic keyed-hash function with the same name will be used to
+generate the fingerprint. If set to `MURMUR3` the non-cryptographic
+MurmurHash function will be used.
+
+If set to `IPV4_NETWORK` the input data needs to be a IPv4 address and
+the hash value will be the masked-out address using the number of bits
+specified in the `key` option. For example, with "1.2.3.4" as the input
+and `key` set to 16, the hash becomes "1.2.0.0".
+
+If set to `PUNCTUATION`, all non-punctuation characters will be removed
+from the input string.
+
+If set to `UUID`, a
+https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID] will
+be generated. The result will be random and thus not a consistent hash.
+
+[id="plugins-{type}s-{plugin}-source"]
+===== `source` 
+
+  * Value type is <<array,array>>
+  * Default value is `"message"`
+
+The name(s) of the source field(s) whose contents will be used
+to create the fingerprint. If an array is given, see the
+`concatenate_sources` option.
+
+[id="plugins-{type}s-{plugin}-target"]
+===== `target` 
+
+  * Value type is <<string,string>>
+  * Default value is `"fingerprint"`
+
+The name of the field where the generated fingerprint will be stored.
+Any current contents of that field will be overwritten.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/fingerprint.rb

@@ -34,7 +34,7 @@ class LogStash::Filters::Fingerprint < LogStash::Filters::Base
   config :target, :validate => :string, :default => 'fingerprint'
 
   # When used with the `IPV4_NETWORK` method fill in the subnet prefix length.
-  # Not required for `MURMUR3`, `PUNCTUATION` or `UUID` methods.
+  # Key is required with all methods except  `MURMUR3`, `PUNCTUATION` or `UUID`.
   # With other methods fill in the HMAC key.
   config :key, :validate => :string
 

data/logstash-filter-fingerprint.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-fingerprint'
-  s.version         = '3.0.3'
+  s.version         = '3.0.4'
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-fingerprint
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/fingerprint.rb
 - logstash-filter-fingerprint.gemspec
 - spec/filters/fingerprint_spec.rb