logstash-filter-uuid 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6155ec051b59acd27f1f5318081c88d48f7484e
-  data.tar.gz: 98e3b8f17a720e6971f075b2473c7ff408608220
+  metadata.gz: 36f2c6233f852976d7c1314fb365aa32b62f394a
+  data.tar.gz: 3ecf812989d1912005a995d9fde24c6d0f073e19
 SHA512:
-  metadata.gz: 9b67d184365484e4b92e86460313b1383a06417e75a8a0c48d7fb47eac931ac39625af08b19988dbdaf1442dd82b7ddd5fea452edc402bf817df67d3d976f3e8
-  data.tar.gz: f20517dc3d1a420d690079a444319c35e830647e05bb88b652bbdff219ab982910961a65ff0b7a784cbd0819dce048f326da7e98ff836751a408eae560e6010f
+  metadata.gz: 4d0add02d984ba5e219b789026c30cd237fbe9078bca0484aa1015ade5cb77190bb0713eb012917947c350a8092c52600ff96b2319d1582a2ec5cce3e4dc68ef
+  data.tar.gz: ec4ef5b7dfdd8aa5a3e4b4c739ec5c1c9015afaa9f754571ee7dd5f7a74c0232fc93b57c2f87c097060290030979dc594e91de98092905a9cd054fa46da22d32

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,95 @@
+:plugin: uuid
+: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}"]
+
+=== Uuid filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+The uuid filter allows you to generate a
+https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID]
+and add it as a field to each processed event.
+
+This is useful if you need to generate a string that's unique for every
+event, even if the same input is processed multiple times. If you want
+to generate strings that are identical each time a event with a given
+content is processed (i.e. a hash) you should use the
+<<plugins-filters-fingerprint,fingerprint filter>> instead.
+
+The generated UUIDs follow the version 4 definition in
+https://tools.ietf.org/html/rfc4122[RFC 4122]) and will be
+represented as a standard hexadecimal string format, e.g.
+"e08806fe-02af-406c-bbde-8a5ae4475e57".
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Uuid 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}-overwrite>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|Yes
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-overwrite"]
+===== `overwrite` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+If the value in the field currently (if any) should be overridden
+by the generated UUID. Defaults to `false` (i.e. if the field is
+present, with ANY value, it won't be overridden)
+
+Example:
+[source,ruby]
+   filter {
+      uuid {
+        target    => "uuid"
+        overwrite => true
+      }
+   }
+
+[id="plugins-{type}s-{plugin}-target"]
+===== `target` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Select the name of the field where the generated UUID should be
+stored.
+
+Example:
+[source,ruby]
+    filter {
+      uuid {
+        target => "uuid"
+      }
+    }
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/uuid.rb

@@ -3,21 +3,31 @@ require "logstash/filters/base"
 require "logstash/namespace"
 require "securerandom"
 
-# The uuid filter allows you to add a `UUID` field to messages.
-# This is useful to be able to control the `_id` messages are indexed into Elasticsearch
-# with, so that you can insert duplicate messages (i.e. the same message multiple times
-# without creating duplicates) - for log pipeline reliability
+# The uuid filter allows you to generate a
+# https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID]
+# and add it as a field to each processed event.
 #
+# This is useful if you need to generate a string that's unique for every
+# event, even if the same input is processed multiple times. If you want
+# to generate strings that are identical each time a event with a given
+# content is processed (i.e. a hash) you should use the
+# <<plugins-filters-fingerprint,fingerprint filter>> instead.
+#
+# The generated UUIDs follow the version 4 definition in
+# https://tools.ietf.org/html/rfc4122[RFC 4122]) and will be
+# represented as a standard hexadecimal string format, e.g.
+# "e08806fe-02af-406c-bbde-8a5ae4475e57".
 class LogStash::Filters::Uuid < LogStash::Filters::Base
   config_name "uuid"
 
-  # Add a UUID to a field.
+  # Select the name of the field where the generated UUID should be
+  # stored.
   #
   # Example:
   # [source,ruby]
   #     filter {
   #       uuid {
-  #         target => "@uuid"
+  #         target => "uuid"
   #       }
   #     }
   config :target, :validate => :string, :required => true
@@ -30,7 +40,7 @@ class LogStash::Filters::Uuid < LogStash::Filters::Base
   # [source,ruby]
   #    filter {
   #       uuid {
-  #         target    => "@uuid"
+  #         target    => "uuid"
   #         overwrite => true
   #       }
   #    }

data/logstash-filter-uuid.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-uuid'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The uuid filter allows you to add a UUID field to messages."
   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-uuid
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/uuid.rb
 - logstash-filter-uuid.gemspec
 - spec/filters/uuid_spec.rb
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: The uuid filter allows you to add a UUID field to messages.