logstash-filter-split-sbt 3.1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 203fffeb050a4ecd74275d9853bff83a87993eb3
+  data.tar.gz: a77b5f73f945b93f0c7d74aae63b38b8f04cd8bc
+SHA512:
+  metadata.gz: b8e0ccd02ee69c6da6a9f378eae9d27126bde2198b4ce42dd1ca9151cca5287e2616ad5594852840463845609ac2aba7e3b33ff8e86dde62248e075428c8a3b2
+  data.tar.gz: 5940bae42224b8d88c6c36779f1e3a1e743a8aba97e06c13e8049cf139291a10627a5de7d48ed8ac688e1d8628eb427b901f48f2a4856b3e009efd166ba8a5ae

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## 3.1.4
+  - Fix some documentation issues
+
+## 3.1.3
+  - Improved performance by no longer cloning the source field if it is the same as the target field
+## 3.1.1
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+
+## 3.1.0
+  - Log and tag attempts to split invalid types instead of crashing logstash
+## 3.0.1
+  - Republish all the gems under jruby.
+## 3.0.0
+  - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
+# 2.0.4
+  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+# 2.0.3
+  - New dependency requirements for logstash-core for the 5.0 release
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0

data/CONTRIBUTORS

@@ -0,0 +1,18 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Colin Surprenant (colinsurprenant)
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* Pete Fritchman (fetep)
+* Philippe Weber (wiibaa)
+* Pier-Hugues Pellerin (ph)
+* R. Toma (rtoma)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+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/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,98 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-split.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-split)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

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}s-{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/lib/logstash/filters/split.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# 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.
+class LogStash::Filters::Split < LogStash::Filters::Base
+  PARSE_FAILURE_TAG = '_split_type_failure'.freeze
+
+  config_name "split"
+
+  # 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.
+  config :terminator, :validate => :string, :default => "\n"
+
+  # 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]"
+  config :field, :validate => :string, :default => "message"
+
+  # The field within the new event which the value is split into.
+  # If not set, the target field defaults to split field name.
+  config :target, :validate => :string
+
+  public
+  def register
+    # Nothing to do
+  end # def register
+
+  public
+  def filter(event)
+    
+
+    original_value = event.get(@field)
+
+    if original_value.is_a?(Array)
+      splits = target.nil? ? event.remove(@field) : original_value
+    elsif original_value.is_a?(String)
+      # Using -1 for 'limit' on String#split makes ruby not drop trailing empty
+      # splits.
+      splits = original_value.split(@terminator, -1)
+    else
+      logger.warn("Only String and Array types are splittable. field:#{@field} is of type = #{original_value.class}")
+      event.tag(PARSE_FAILURE_TAG)
+      return
+    end
+
+    # Skip filtering if splitting this event resulted in only one thing found.
+    return if splits.length == 1 && original_value.is_a?(String)
+    #or splits[1].empty?
+
+    splits.each do |value|
+      next if value.nil? || value.empty?
+
+      event_split = event.clone
+      @logger.debug("Split event", :value => value, :field => @field)
+      if @target.nil?
+        event_split.set(@field, value)
+      else
+        event_split.set(@target, value)
+      end
+      filter_matched(event_split)
+
+      # Push this new event onto the stack at the LogStash::FilterWorker
+      yield event_split
+    end
+
+    # Cancel this event, we'll use the newly generated ones above.
+    event.cancel
+  end # def filter
+end # class LogStash::Filters::Split

data/logstash-filter-split.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-split-sbt'
+  s.version         = '3.1.4.1'
+  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"
+  s.authors         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  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)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/filters/split_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/split"
+require "logstash/event"
+
+describe LogStash::Filters::Split do
+
+  describe "all defaults" do
+    config <<-CONFIG
+      filter {
+        split { }
+      }
+    CONFIG
+
+    sample "big\nbird\nsesame street" do
+      insist { subject.length } == 3
+      insist { subject[0].get("message") } == "big"
+      insist { subject[1].get("message") } == "bird"
+      insist { subject[2].get("message") } == "sesame street"
+    end
+  end
+
+  describe "custome terminator" do
+    config <<-CONFIG
+      filter {
+        split {
+          terminator => "\t"
+        }
+      }
+    CONFIG
+
+    sample "big\tbird\tsesame street" do
+      insist { subject.length } == 3
+      insist { subject[0].get("message") } == "big"
+      insist { subject[1].get("message") } == "bird"
+      insist { subject[2].get("message") } == "sesame street"
+    end
+  end
+
+  describe "custom field" do
+    config <<-CONFIG
+      filter {
+        split {
+          field => "custom"
+        }
+      }
+    CONFIG
+
+    sample("custom" => "big\nbird\nsesame street", "do_not_touch" => "1\n2\n3") do
+      insist { subject.length } == 3
+      subject.each do |s|
+         insist { s.get("do_not_touch") } == "1\n2\n3"
+      end
+      insist { subject[0].get("custom") } == "big"
+      insist { subject[1].get("custom") } == "bird"
+      insist { subject[2].get("custom") } == "sesame street"
+    end
+  end
+
+  describe "split array" do
+    config <<-CONFIG
+      filter {
+        split {
+          field => "array"
+        }
+      }
+    CONFIG
+
+    sample("array" => ["big", "bird", "sesame street"], "untouched" => "1\n2\n3") do
+      insist { subject.length } == 3
+      subject.each do |s|
+         insist { s.get("untouched") } == "1\n2\n3"
+      end
+      insist { subject[0].get("array") } == "big"
+      insist { subject[1].get("array") } == "bird"
+      insist { subject[2].get("array") } == "sesame street"
+    end
+
+    sample("array" => ["big"], "untouched" => "1\n2\n3") 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
+    config <<-CONFIG
+      filter {
+        split {
+          field => "array"
+          target => "element"
+        }
+      }
+    CONFIG
+
+    sample("array" => ["big", "bird", "sesame street"]) do
+      insist { subject.length } == 3
+      insist { subject[0].get("element") } == "big"
+      insist { subject[1].get("element") } == "bird"
+      insist { subject[2].get("element") } == "sesame street"
+    end
+  end
+
+  context "when invalid type is passed" do
+    let(:filter) { LogStash::Filters::Split.new({"field" => "field"}) }
+    let(:logger) { filter.logger }
+    let(:event) { event = LogStash::Event.new("field" => 10) }
+
+    before do
+      allow(filter.logger).to receive(:warn).with(anything)
+      filter.filter(event)
+    end
+    
+    it "should log an error" do
+      expect(filter.logger).to have_received(:warn).with(/Only String and Array types are splittable/)
+    end
+
+    it "should add a '_splitparsefailure' tag" do
+      expect(event.get("tags")).to include(LogStash::Filters::Split::PARSE_FAILURE_TAG)
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-split-sbt
+version: !ruby/object:Gem::Version
+  version: 3.1.4.1
+platform: ruby
+authors:
+- Elastic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/logstash/filters/split.rb
+- spec/filters/split_spec.rb
+- logstash-filter-split.gemspec
+- CHANGELOG.md
+- README.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- docs/index.asciidoc
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: The split filter is for splitting multiline messages into separate events.
+test_files:
+- spec/filters/split_spec.rb