logstash-filter-json 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75b6415ca4f107d636b1305a1cfa50f5fe6116a5
-  data.tar.gz: 4b1adb7d1a1b8c24fc464dfcdd055b4d0372115c
+  metadata.gz: eaaa5dc9665555401807b85ab686e70d61cc5f6b
+  data.tar.gz: e32c2c03935902774be46e98a1ad12b2e7a7dda6
 SHA512:
-  metadata.gz: 9c4057279fe3c6911553fc383883bc41deaccaee6f3cad0f56298d451d2bcb870176aa9ea0cf24c81c98acf1b4b11b675803444d9a419e41fe80baa907472fae
-  data.tar.gz: aa96a6fd9b490b9967f62ef022ae380af6edd232a850f164496d81c41067623a5508c5b6fe6c3b00f3c35985c07aedc8c88d3e86e58896cbff54fc4e271c1a49
+  metadata.gz: ec227571f7f30cfe2dde812e1af56146d1582d9ab5a8797cd5019e8b50fa2e63f79dd0926e7cd64834c54c33dc6fa6c82884ab9f94a30697dbe635ada1083bc6
+  data.tar.gz: f81f408df31f56b35421ebb9e0b9f76a4cc9d4f86484ec9ad0a9d33114aeb63bdbebe7306489ecb8ee7c2ec478f95ed2dc7a7c80aa7531ffb21a04a27abf2e14

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,121 @@
+:plugin: json
+: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}"]
+
+=== Json filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This is a JSON parsing filter. It takes an existing field which contains JSON and
+expands it into an actual data structure within the Logstash event.
+
+By default it will place the parsed JSON in the root (top level) of the Logstash event, but this
+filter can be configured to place the JSON into any arbitrary event field, using the
+`target` configuration.
+
+This plugin has a few fallback scenario when something bad happen during the parsing of the event.
+If the JSON parsing fails on the data, the event will be untouched and it will be tagged with a
+`_jsonparsefailure` then you can use conditionals to clean the data. You can configured this tag with then
+`tag_on_failure` option.
+
+If the parsed data contains a `@timestamp` field, we will try to use it for the event's `@timestamp`, if the
+parsing fails, the field will be renamed to `_@timestamp` and the event will be tagged with a
+`_timestampparsefailure`.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Json 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}-skip_on_invalid_json>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-source>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-tag_on_failure>> |<<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}-skip_on_invalid_json"]
+===== `skip_on_invalid_json` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Allow to skip filter on invalid json (allows to handle json and non-json data without warnings)
+
+[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.
+
+The configuration for the JSON filter:
+[source,ruby]
+    source => source_field
+
+For example, if you have JSON data in the `message` field:
+[source,ruby]
+    filter {
+      json {
+        source => "message"
+      }
+    }
+
+The above would parse the json from the `message` field
+
+[id="plugins-{type}s-{plugin}-tag_on_failure"]
+===== `tag_on_failure` 
+
+  * Value type is <<array,array>>
+  * Default value is `["_jsonparsefailure"]`
+
+Append values to the `tags` field when there has been no
+successful match
+
+[id="plugins-{type}s-{plugin}-target"]
+===== `target` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Define the target field for placing the parsed data. If this setting is
+omitted, the JSON data will be stored at the root (top level) of the event.
+
+For example, if you want the data to be put in the `doc` field:
+[source,ruby]
+    filter {
+      json {
+        target => "doc"
+      }
+    }
+
+JSON in the value of the `source` field will be expanded into a
+data structure in the `target` field.
+
+NOTE: if the `target` field already exists, it will be overwritten!
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-json.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-json'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This is a JSON parsing filter. It takes an existing field which contains JSON and expands it into an actual data structure within the Logstash event."
   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-json
 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/json.rb
 - logstash-filter-json.gemspec
 - spec/filters/json_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: This is a JSON parsing filter. It takes an existing field which contains JSON and expands it into an actual data structure within the Logstash event.