logstash-filter-xml 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7758cb2a1b75e1ec1f02f0d31f6d3592d27f5c8c
-  data.tar.gz: f1af18c5f4c689cafc1c38e5bb32bd5f8ab45631
+  metadata.gz: 7d881613a9476f371194d156039ef75376370ea1
+  data.tar.gz: cc62baf200c453069fc2aa700d055520721a6a02
 SHA512:
-  metadata.gz: 72bb73bf8def84fc335661e29d361521bd77b7c07e1b55fb0db650dadcc26958d410464eadb079ef8447c30758dda185e867bb64cfe6b39b425884cc42a4f46e
-  data.tar.gz: acd1c0e7ba251a177f8d8c25534fabeddc9ec7d0adbba7c87ceedd13ea90f82603467c04022db98c1906d02a98bc57d24d3dca7ad289da550f5ad45916362e6e
+  metadata.gz: 5e05791be78c175edcb859708c53f3ada769a7212bd9b85f1a424c7367dfe6fcc6f9e2a6eb7a38025a779c6fdba86f75bc2930ed113f3f7bea2aa116bafe6028
+  data.tar.gz: 0caaa2f55c9e761095efd82147b1b0c986f1d4078c15e3cc31b5f1a37803ddb11f0ba3c3e4809693c7c5a2b9ee9a3bd7cc04d943d5cd2b7fe3c273948372e66f

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,187 @@
+:plugin: xml
+: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}"]
+
+=== Xml filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+XML filter. Takes a field that contains XML and expands it into
+an actual datastructure.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Xml 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}-force_array>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-force_content>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-namespaces>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-remove_namespaces>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-source>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-store_xml>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-suppress_empty>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-xpath>> |<<hash,hash>>|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}-force_array"]
+===== `force_array` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+By default the filter will force single elements to be arrays. Setting this to 
+false will prevent storing single elements in arrays.
+
+[id="plugins-{type}s-{plugin}-force_content"]
+===== `force_content` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+By default the filter will expand attributes differently from content inside
+of tags. This option allows you to force text content and attributes to always
+parse to a hash value.
+
+[id="plugins-{type}s-{plugin}-namespaces"]
+===== `namespaces` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+By default only namespaces declarations on the root element are considered.
+This allows to configure all namespace declarations to parse the XML document.
+
+Example:
+
+[source,ruby]
+filter {
+  xml {
+    namespaces => {
+      "xsl" => "http://www.w3.org/1999/XSL/Transform"
+      "xhtml" => http://www.w3.org/1999/xhtml"
+    }
+  }
+}
+
+
+[id="plugins-{type}s-{plugin}-remove_namespaces"]
+===== `remove_namespaces` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Remove all namespaces from all nodes in the document.
+Of course, if the document had nodes with the same names but different namespaces, they will now be ambiguous.
+
+[id="plugins-{type}s-{plugin}-source"]
+===== `source` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Config for xml to hash is:
+[source,ruby]
+    source => source_field
+
+For example, if you have the whole XML document in your `message` field:
+[source,ruby]
+    filter {
+      xml {
+        source => "message"
+      }
+    }
+
+The above would parse the XML from the `message` field.
+
+[id="plugins-{type}s-{plugin}-store_xml"]
+===== `store_xml` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+By default the filter will store the whole parsed XML in the destination
+field as described above. Setting this to false will prevent that.
+
+[id="plugins-{type}s-{plugin}-suppress_empty"]
+===== `suppress_empty` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+By default, output nothing if the element is empty.
+If set to `false`, empty element will result in an empty hash object.
+
+[id="plugins-{type}s-{plugin}-target"]
+===== `target` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Define target for placing the data
+
+For example if you want the data to be put in the `doc` field:
+[source,ruby]
+    filter {
+      xml {
+        target => "doc"
+      }
+    }
+
+XML in the value of the source field will be expanded into a
+datastructure in the `target` field.
+Note: if the `target` field already exists, it will be overridden.
+Required if `store_xml` is true (which is the default).
+
+[id="plugins-{type}s-{plugin}-xpath"]
+===== `xpath` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+xpath will additionally select string values (non-strings will be
+converted to strings with Ruby's `to_s` function) from parsed XML
+(using each source field defined using the method above) and place
+those values in the destination fields. Configuration:
+[source,ruby]
+xpath => [ "xpath-syntax", "destination-field" ]
+
+Values returned by XPath parsing from `xpath-syntax` will be put in the
+destination field. Multiple values returned will be pushed onto the
+destination field as an array. As such, multiple matches across
+multiple source fields will produce duplicate entries in the field.
+
+More on XPath: http://www.w3schools.com/xml/xml_xpath.asp
+
+The XPath functions are particularly powerful:
+http://www.w3schools.com/xsl/xsl_functions.asp
+
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-xml.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-xml'
-  s.version         = '4.0.2'
+  s.version         = '4.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Takes a field that contains XML and expands it into an actual datastructure."
   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/xml_spec.rb

@@ -382,19 +382,4 @@ describe LogStash::Filters::Xml do
       end
     end
   end
-
-  describe "plugin registration" do
-    config <<-CONFIG
-    filter {
-      xml {
-        xmldata => "message"
-        store_xml => true
-      }
-    }
-    CONFIG
-
-    sample("xmldata" => "<foo>random message</foo>") do
-      insist { subject }.raises(LogStash::ConfigurationError)
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-xml
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/xml.rb
 - logstash-filter-xml.gemspec
 - spec/filters/xml_spec.rb