logstash-filter-split 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c289e206791d9973f7c598e12d78142a7dae422
-  data.tar.gz: 8cbde317a3f26193de7a38c505a356f691aade5a
+  metadata.gz: bac465c92c547ae65d21d9e8fff888b430c86610
+  data.tar.gz: 8c0a31fa0b00a6cbe23f41953a0e7050d1a88072
 SHA512:
-  metadata.gz: a26f3dce99502455905ee8a98832f63fd59af391121d10045343b3a21130fa04b8bf78326a13b8f1df6d73d365a6651c2526074a1a623a8432b58c8fcfc70686
-  data.tar.gz: 4e4432deac0dc8732c6934e3b8cf79b650fb9e28417f894a7a68886e907f795d5cd084f687023578920da58eedaffc9f0a277026a45346c29547368dd6699153
+  metadata.gz: 6192819d80a89065954d3b8f77d7cf997dcf3d6ce38a57d58747832e6603f434381a57965a9655e7f6ae7dbe4c5d83005efc7ffc95b21b7e96feafa79ff0451c
+  data.tar.gz: 860b16e6b425cb639dce6b5cc32f40929e344b8f52168eb2457b65b5a9fa8b665700a0c05ed23e4647dce2360cd8e6d0591c4687a646850fa681b8b4038a92c9

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,111 @@
+:plugin: split
+: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}"]
+
+=== Split filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+The split filter clones an event by splitting one of its fields and
+placing each value resulting from the split into a clone of the original
+event. The field being split can either be a string or an array.
+
+An example use case of this filter is for taking output from the
+<<plugins-inputs-exec,exec input plugin>> which emits one event for
+the whole output of a command and splitting that output by newline -
+making each line an event.
+
+Split filter can also be used to split array fields in events into individual events.
+A very common pattern in JSON & XML is to make use of lists to group data together.
+
+For example, a json structure like this:
+
+[source,js]
+----------------------------------
+{ field1: ...,
+ results: [
+   { result ... },
+   { result ... },
+   { result ... },
+   ...
+] }
+----------------------------------
+
+The split filter can be used on the above data to create separate events for each value of `results` field
+
+[source,js]
+----------------------------------
+filter {
+ split {
+   field => "results"
+ }
+}
+----------------------------------
+
+The end result of each split is a complete copy of the event
+with only the current split section of the given field changed.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Split 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}-field>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-terminator>> |<<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}-field"]
+===== `field` 
+
+  * Value type is <<string,string>>
+  * Default value is `"message"`
+
+The field which value is split by the terminator.  
+Can be a multiline message or the ID of an array.  
+Nested arrays are referenced like: "[object_id][array_id]"
+
+[id="plugins-{type}s-{plugin}-target"]
+===== `target` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The field within the new event which the value is split into.
+If not set, the target field defaults to split field name.
+
+[id="plugins-{type}s-{plugin}-terminator"]
+===== `terminator` 
+
+  * Value type is <<string,string>>
+  * Default value is `"\n"`
+
+The string to split on. This is usually a line terminator, but can be any
+string. If you are splitting a JSON array into multiple events, you can ignore this field.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-split.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-split'
-  s.version         = '3.1.1'
+  s.version         = '3.1.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The split filter is for splitting multiline messages into separate events."
   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)/})

data/spec/filters/split_spec.rb

@@ -80,6 +80,11 @@ describe LogStash::Filters::Split do
       insist { subject.is_a?(Logstash::Event) }
       insist { subject.get("array") } == "big"
     end
+
+    sample("array" => ["single-element"], "untouched" => "1\n2\n3") do
+      insist { subject.get("array") } == "single-element"
+      insist { subject.get("untouched") } == "1\n2\n3"
+    end
   end
 
   describe "split array into new field" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-split
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 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/split.rb
 - logstash-filter-split.gemspec
 - spec/filters/split_spec.rb
@@ -81,7 +82,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 split filter is for splitting multiline messages into separate events.