logstash-filter-dissect 1.1.4 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21b60b83ce9a628a4c1879f0cffa16b3266595a5858fa5874998d3ca971718a6
-  data.tar.gz: e6b49de027860dcd0f6316ff93632aa8dd33f2bc9323258babfdbe867ea23bb3
+  metadata.gz: 6a0a1db8e2b1cd398f4f32e5433a8560a154aacd2b841e8eba1fb9709f1798f6
+  data.tar.gz: a446ac8adc62d322318d0a05e060779f87ef61111c1ad6c536211cd8826e9a74
 SHA512:
-  metadata.gz: ee8590d5715087e826fe63853919972602161ddeddb6055a3585aef0dc6c2a9ce5ca6c1bcdc575703fb145abf41381ec1e460b5fa2c224fea16b0325555c7c47
-  data.tar.gz: 562fc016a5fe3e6312ecc1949a53764ebff4ae0a67cdfee903ca4c0f021ecdecd90fcedb690aba3acb35edb00ebf81960236315d383f33c12ef70a5b146deaaf
+  metadata.gz: '083b2aa51fc8fa242d90268d1e3efd712e894cdc2a67457d95a7c8830a1e2ad866e6fd5aec71c7b33edf9bbb17faf454944c85d5f2d22d5d25d6566a9827d48f'
+  data.tar.gz: 7f689abdb37eae898c3195c27b0704f3bf8700eab3bcf2fc3e8f1d14911df29692916436282db590b14814f08f36fbf7c168668afe2250a74cdca0ba663fde8e

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 1.2.3
+  - Update log4j dependencies to 2.17.0
+
+## 1.2.2
+  - Update log4j dependencies [#80](https://github.com/logstash-plugins/logstash-filter-dissect/pull/80)
+  - Fix: update to Gradle 7 [#78](https://github.com/logstash-plugins/logstash-filter-dissect/pull/78)
+
+## 1.2.1
+ - [DOC] Added note to clarify notation for dot or nested fields [#76](https://github.com/logstash-plugins/logstash-filter-dissect/pull/76)
+
+## 1.2.0
+  - Fix Trailing Delimiters requires a false field. A skip field is
+  automatically added when a final delimiter is detected in the dissect pattern.
+  This requires that strict delimiter finding is enforced  - meaning a "no match"
+  results if every delimiter is not found in exactly the declared order
+  [Issue #22](https://github.com/logstash-plugins/logstash-filter-dissect/issues/22)
+
 ## 1.1.4
   - Replace v1.1.3 as it packaged the v1.1.1 jar and therefore does not have the fixes below
   - Yank v1.1.3 from rubygems.org

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 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
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-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.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   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/README.md

@@ -31,7 +31,7 @@ Please read BUILD_INSTRUCTIONS.md
 
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-dissect.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-dissect)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-dissect.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-dissect)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/VERSION

@@ -1 +1 @@
-1.1.4
+1.2.3

data/docs/index.asciidoc

@@ -20,29 +20,60 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-The Dissect filter is a kind of split operation. Unlike a regular split operation where one delimiter is applied to
-the whole string, this operation applies a set of delimiters to a string value. +
-Dissect does not use regular expressions and is very fast. +
-However, if the structure of your text varies from line to line then Grok is more suitable. +
-There is a hybrid case where Dissect can be used to de-structure the section of the line that is reliably repeated and
-then Grok can be used on the remaining field values with more regex predictability and less overall work to do. +
+The Dissect filter plugin tokenizes incoming strings using defined patterns. 
+It extracts unstructured event data into fields using
+delimiters. This process is called tokenization.
 
-A set of fields and delimiters is called a *dissection*.
+Unlike a regular split operation where one delimiter is applied to the whole
+string, the Dissect operation applies a set of delimiters to a string value. 
 
+NOTE: All keys must be found and extracted for tokenization to be successful.
+If one or more keys cannot be found, an error occurs and the original event is
+not modified.
+
+===== Dissect or Grok? Or both?
+
+Dissect differs from Grok in that it does not use regular expressions and is faster. 
+Dissect works well when data is reliably repeated.
+Grok is a better choice when the structure of your text varies from line to line.
+
+You can use both Dissect and Grok for a hybrid use case when a section of the
+line is reliably repeated, but the entire line is not. The Dissect filter can
+deconstruct the section of the line that is repeated. The Grok filter can process
+the remaining field values with more regex predictability.
+
+===== Terminology
+
+*dissect pattern* - the set of fields and delimiters describing the textual 
+format. Also known as a dissection. 
 The dissection is described using a set of `%{}` sections:
-....
-%{a} - %{b} - %{c}
-....
+`%{a} - %{b} - %{c}`
+
+*field* - the text from `%{` to `}` inclusive.
+
+*delimiter* - the text between `}` and the next `%{` characters.
+Any set of characters other than `%{`, `'not }'`, or `}` is a delimiter.
+
+*key* - the text between the `%{` and `}`, exclusive of the `?`, `+`, `&` prefixes 
+and the ordinal suffix. 
 
-A *field* is the text from `%` to `}` inclusive.
+Examples:
 
-A *delimiter* is the text between a `}` and next `%{` characters.
+`%{?aaa}` - the key is `aaa` 
 
-[NOTE]
-Any set of characters that do not fit `%{`, `'not }'`, `}` pattern is a delimiter.
+`%{+bbb/3}` - the key is `bbb` 
+
+`%{&ccc}` - the key is `ccc` 
+
+NOTE: Using the `.` (dot) as `key` will generate fields with `.` in the field name. If
+you want to get nested fields, use the brackets notation such as `%{[fieldname][subfieldname]}`.
+
+===== Sample configuration
 
 The config might look like this:
-....
+
+[source,ruby]
+-----
   filter {
     dissect {
       mapping => {
@@ -50,93 +81,141 @@ The config might look like this:
       }
     }
   }
-....
-When dissecting a string from left to right, text is captured upto the first delimiter - this captured text is stored in the first field.
-This is repeated for each field/# delimiter pair thereafter until the last delimiter is reached, then *the remaining text is stored in the last field*. +
+-----
+
+When a string is dissected from left to right, text is captured up to the first
+delimiter. The captured text is stored in the first field. This is repeated
+for each field/# delimiter pair until the last delimiter is reached.
+Then *the remaining text is stored in the last field*. 
+
+==== Notations
+
+<<plugins-{type}s-{plugin}-normal>>
 
-*The Key:* +
-The key is the text between the `%{` and `}`, exclusive of the ?, +, & prefixes and the ordinal suffix. +
-`%{?aaa}` - key is `aaa` +
-`%{+bbb/3}` - key is `bbb` +
-`%{&ccc}` - key is `ccc` +
+<<plugins-{type}s-{plugin}-skip>>
 
+<<plugins-{type}s-{plugin}-append>> 
+
+<<plugins-{type}s-{plugin}-indirect>> 
+
+===== Notes and usage guidelines
+
+* For append or indirect fields, the key can refer to a field that already exists in the event before dissection.
+
+* Use a Skip field if you do not want the indirection key/value stored.
++
+Example: 
++
+`%{?a}: %{&a}` applied to text `google: 77.98` will build a key/value of `google => 77.98`.
+
+* Append and indirect cannot be combined. 
++
+Examples:
++
+`%{+&something}` will add a value to the `&something` key (probably not the intended outcome). 
++
+`%{&+something}` will add a value to the `+something` key (again probably unintended). 
+
+[id="plugins-{type}s-{plugin}-normal"]
 ===== Normal field notation
-The found value is added to the Event using the key. +
-`%{some_field}` - a normal field has no prefix or suffix
+The found value is added to the Event using the key. 
+A normal field has no prefix or suffix.
+
+Example:
+
+`%{some_field}`
 
-*Skip field notation:* +
-The found value is stored internally but not added to the Event. +
+
+[id="plugins-{type}s-{plugin}-skip"]
+===== Skip field notation
+The found value is stored internally, but is not added to the Event. 
 The key, if supplied, is prefixed with a `?`.
 
+Examples:
+
 `%{}` is an empty skip field.
 
 `%{?foo}` is a named skip field.
 
+[id="plugins-{type}s-{plugin}-append"]
 ===== Append field notation
-The value is appended to another value or stored if its the first field seen. +
-The key is prefixed with a `+`. +
-The final value is stored in the Event using the key. +
+If the value is the first field seen, it is stored. 
+Subsequent fields are appended to another value. 
 
-[NOTE]
-====
-The delimiter found before the field is appended with the value. +
+The key is prefixed with a `+`. 
+The final value is stored in the Event using the key. 
+
+NOTE: The delimiter found before the field is appended with the value. 
 If no delimiter is found before the field, a single space character is used.
-====
 
-`%{+some_field}` is an append field. +
+Examples:
+
+`%{+some_field}` is an append field. 
+
 `%{+some_field/2}` is an append field with an order modifier.
 
-An order modifier, `/digits`, allows one to reorder the append sequence. +
-e.g. for a text of `1 2 3 go`, this `%{+a/2} %{+a/1} %{+a/4} %{+a/3}` will build a key/value of `a => 2 1 go 3` +
-Append fields without an order modifier will append in declared order. +
-e.g. for a text of `1 2 3 go`, this `%{a} %{b} %{+a}` will build two key/values of `a => 1 3 go, b => 2` +
+**Order modifiers**
+
+An order modifier, `/digits`, allows one to reorder the append sequence. 
+
+Example: 
 
+For text `1 2 3 go`, this `%{+a/2} %{+a/1} %{+a/4} %{+a/3}` will build a key/value of `a => 2 1 go 3`. 
+
+*Append fields* without an order modifier will append in declared order. 
+
+Example:
+
+For text `1 2 3 go`, this `%{a} %{b} %{+a}` will build two key/values of `a => 1 3 go, b => 2` 
+
+[id="plugins-{type}s-{plugin}-indirect"]
 ===== Indirect field notation
-The found value is added to the Event using the found value of another field as the key. +
-The key is prefixed with a `&`. +
-`%{&some_field}` - an indirect field where the key is indirectly sourced from the value of `some_field`. +
-e.g. for a text of `error: some_error, some_description`, this `error: %{?err}, %{&err}` will build a key/value of `some_error => some_description`.
+The found value is added to the Event using the found value of another field as the key. 
+The key is prefixed with a `&`. 
 
-[NOTE]
-for append and indirect field the key can refer to a field that already exists in the event before dissection.
+Examples:
 
-[NOTE]
-use a Skip field if you do not want the indirection key/value stored.
+`%{&some_field}` is an indirect field where the key is indirectly sourced from the value of `some_field`. 
+
+For text `error: some_error, some_description`, this notation `error: %{?err}, %{&err}` will build a key/value of `some_error => some_description`.
 
-e.g. for a text of `google: 77.98`, this `%{?a}: %{&a}` will build a key/value of `google => 77.98`.
 
-[NOTE]
-===============================
-append and indirect cannot be combined and will fail validation. +
-`%{+&something}` - will add a value to the `&something` key, probably not the intended outcome. +
-`%{&+something}` will add a value to the `+something` key, again probably unintended. +
-===============================
 
 ==== Multiple Consecutive Delimiter Handling
 
-[IMPORTANT]
-===============================
-Starting from version 1.1.1 of this plugin, multiple found delimiter handling has changed.
-Now multiple consecutive delimiters will be seen as missing fields by default and not padding.
+IMPORTANT: Multiple found delimiter handling has changed starting with version 1.1.1 of this plugin.
+Now multiple consecutive delimiters are seen as missing fields by default and not padding.
 If you are already using Dissect and your source text has fields padded with extra delimiters,
 you will need to change your config. Please read the section below.
-===============================
+
 
 ===== Empty data between delimiters
+
 Given this text as the sample used to create a dissection:
-....
+
+[source,ruby]
+-----
 John Smith,Big Oaks,Wood Lane,Hambledown,Canterbury,CB34RY
-....
+-----
+
 The created dissection, with 6 fields, is:
-....
+
+[source,ruby]
+-----
 %{name},%{addr1},%{addr2},%{addr3},%{city},%{zip}
-....
+-----
+
 When a line like this is processed:
-....
+
+[source,ruby]
+-----
 Jane Doe,4321 Fifth Avenue,,,New York,87432
-....
+-----
+
 Dissect will create an event with empty fields for `addr2 and addr3` like so:
-....
+
+[source,ruby]
+-----
 {
   "name": "Jane Doe",
   "addr1": "4321 Fifth Avenue",
@@ -145,23 +224,31 @@ Dissect will create an event with empty fields for `addr2 and addr3` like so:
   "city": "New York"
   "zip": "87432"
 }
-....
+-----
 
 ===== Delimiters used as padding to visually align fields
 *Padding to the right hand side*
 
 Given these texts as the samples used to create a dissection:
-....
+
+[source,ruby]
+-----
 00000043 ViewReceive     machine-321
 f3000a3b Calc            machine-123
-....
+-----
+
 The dissection, with 3 fields, is:
-....
+
+[source,ruby]
+-----
 %{id} %{function->} %{server}
-....
+-----
+
 Note, above, the second field has a `->` suffix which tells Dissect to ignore padding to its right. +
 Dissect will create these events:
-....
+
+[source,ruby]
+-----
 {
   "id": "00000043",
   "function": "ViewReceive",
@@ -172,30 +259,38 @@ Dissect will create these events:
   "function": "Calc",
   "server": "machine-321"
 }
-....
-[IMPORTANT]
-Always add the `->` suffix to the field on the left of the padding.
+-----
+
+IMPORTANT: Always add the `->` suffix to the field on the left of the padding.
 
 *Padding to the left hand side (to the human eye)*
 
 Given these texts as the samples used to create a dissection:
-....
+
+[source,ruby]
+-----
 00000043     ViewReceive machine-321
 f3000a3b            Calc machine-123
-....
+-----
+
 The dissection, with 3 fields, is now:
-....
+
+[source,ruby]
+-----
 %{id->} %{function} %{server}
-....
+-----
+
 Here the `->` suffix moves to the `id` field because Dissect sees the padding as being to the right of the `id` field. +
 
 ==== Conditional processing
 
-You probably want to use this filter inside an `if` block. +
+You probably want to use this filter inside an `if` block. 
 This ensures that the event contains a field value with a suitable structure for the dissection.
 
-For example...
-....
+Example:
+
+[source,ruby]
+-----
 filter {
   if [type] == "syslog" or "syslog" in [tags] {
     dissect {
@@ -205,7 +300,7 @@ filter {
     }
   }
 }
-....
+-----
 
 [id="plugins-{type}s-{plugin}-options"]
 ==== Dissect Filter Configuration Options
@@ -231,20 +326,23 @@ filter plugins.
   * Value type is <<hash,hash>>
   * Default value is `{}`
 
-With this setting `int` and `float` datatype conversions can be specified. +
-These will be done after all `mapping` dissections have taken place. +
-Feel free to use this setting on its own without a `mapping` section. +
+With this setting `int` and `float` datatype conversions can be specified. 
+These will be done after all `mapping` dissections have taken place. 
+Feel free to use this setting on its own without a `mapping` section. 
+
+*Example*
 
-For example
 [source, ruby]
+-----
 filter {
   dissect {
     convert_datatype => {
-      cpu => "float"
-      code => "int"
+      "cpu" => "float"
+      "code" => "int"
     }
   }
 }
+-----
 
 [id="plugins-{type}s-{plugin}-mapping"]
 ===== `mapping`
@@ -254,14 +352,16 @@ filter {
 
 A hash of dissections of `field => value` +
 [IMPORTANT]
-Don't use an escaped newline `\n` in the value, it will be seen as two characters `\` + `n`+
-Instead use actual line breaks in the config.+
+Don't use an escaped newline `\n` in the value. It will be interpreted as two characters `\` + `n`.
+Instead use actual line breaks in the config.
 Also use single quotes to define the value if it contains double quotes.
 
 A later dissection can be done on values from a previous dissection or they can be independent.
 
-For example
+*Example*
+
 [source, ruby]
+-----
 filter {
   dissect {
     mapping => {
@@ -272,9 +372,10 @@ filter {
     }
   }
 }
+-----
 
 This is useful if you want to keep the field `description` but also
-dissect it some more.
+dissect it further.
 
 [id="plugins-{type}s-{plugin}-tag_on_failure"]
 ===== `tag_on_failure`

data/lib/jruby-dissect-library_jars.rb

@@ -1,4 +1,4 @@
 # AUTOGENERATED BY THE GRADLE SCRIPT. DO NOT EDIT.
 
 require 'jar_dependencies'
-require_jar('org.logstash.dissect', 'jruby-dissect-library', '1.1.4')
+require_jar('org.logstash.dissect', 'jruby-dissect-library', '1.2.3')

data/logstash-filter-dissect.gemspec

@@ -1,8 +1,6 @@
-DISSECT_VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), "VERSION"))).strip unless defined?(DISSECT_VERSION)
-
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-dissect'
-  s.version = DISSECT_VERSION
+  s.version = '1.2.3' # version will be checked against VERSION file by `rake vendor`
   s.licenses = ['Apache License (2.0)']
   s.summary = "Extracts unstructured event data into fields using delimiters"
   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"

data/spec/filters/dissect_spec.rb

@@ -328,4 +328,25 @@ describe LogStash::Filters::Dissect do
       end
     end
   end
+
+  describe "Compatibility suite" do
+    tests = LogStash::Json.load(File.read(File.join(File.dirname(__FILE__), "/../fixtures/dissect_tests.json")))
+    tests.each do |test|
+      describe test["name"] do
+        let(:options) { { "mapping" => { "message" => test["tok"] } } }
+        subject { described_class.new(options) }
+        let(:event) { LogStash::Event.new({ "message" => test["msg"] }) }
+        before(:each) do
+          subject.register
+          subject.filter(event)
+        end
+
+        it "should dissect properly" do
+          test["expected"].each do |k, v|
+            expect(event.get(k)).to eq(v)
+          end
+        end
+      end
+    end
+end
 end

data/spec/fixtures/dissect_tests.json

@@ -0,0 +1,157 @@
+[
+  {
+    "name": "Complex stack trace",
+    "tok": "%{day}-%{month}-%{year} %{hour} %{severity} [%{thread_id}] %{origin} %{message}",
+    "msg": "18-Apr-2018 06:53:20.411 INFO [http-nio-8080-exec-1] org.apache.coyote.http11.Http11Processor.service Error parsing HTTP request header\n Note: further occurrences of HTTP header parsing errors will be logged at DEBUG level.\n java.lang.IllegalArgumentException: Invalid character found in method name. HTTP method names must be tokens\n    at org.apache.coyote.http11.Http11InputBuffer.parseRequestLine(Http11InputBuffer.java:426)\n    at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:687)\n    at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:66)\n    at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:790)\n    at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1459)\n    at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\n    at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)\n    at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)\n    at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\n    at java.lang.Thread.run(Thread.java:748)",
+    "expected": {
+      "day": "18",
+      "hour": "06:53:20.411",
+      "message": "Error parsing HTTP request header\n Note: further occurrences of HTTP header parsing errors will be logged at DEBUG level.\n java.lang.IllegalArgumentException: Invalid character found in method name. HTTP method names must be tokens\n    at org.apache.coyote.http11.Http11InputBuffer.parseRequestLine(Http11InputBuffer.java:426)\n    at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:687)\n    at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:66)\n    at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:790)\n    at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1459)\n    at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\n    at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)\n    at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)\n    at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\n    at java.lang.Thread.run(Thread.java:748)",
+      "month": "Apr",
+      "origin": "org.apache.coyote.http11.Http11Processor.service",
+      "severity": "INFO",
+      "thread_id": "http-nio-8080-exec-1",
+      "year": "2018"
+    },
+    "skip": false
+  },
+  {
+    "name": "simple dissect",
+    "tok": "%{key}",
+    "msg": "foobar",
+    "expected": {
+      "key": "foobar"
+    },
+    "skip": false
+  },
+  {
+    "name": "dissect two replacement",
+    "tok": "%{key1} %{key2}",
+    "msg": "foo bar",
+    "expected": {
+      "key1": "foo",
+      "key2": "bar"
+    },
+    "skip": false
+  },
+  {
+    "name": "one level dissect not end of string",
+    "tok": "/var/%{key}/log",
+    "msg": "/var/foobar/log",
+    "expected": {
+      "key": "foobar"
+    },
+    "skip": false
+  },
+  {
+    "name": "one level dissect",
+    "tok": "/var/%{key}",
+    "msg": "/var/foobar/log",
+    "expected": {
+      "key": "foobar/log"
+    },
+    "skip": false
+  },
+  {
+    "name": "multiple keys dissect end of string",
+    "tok": "/var/%{key}/log/%{key1}",
+    "msg": "/var/foobar/log/apache",
+    "expected": {
+      "key": "foobar",
+      "key1": "apache"
+    },
+    "skip": false
+  },
+  {
+    "name": "multiple keys not end of string",
+    "tok": "/var/%{key}/log/%{key1}.log",
+    "msg": "/var/foobar/log/apache.log",
+    "expected": {
+      "key": "foobar",
+      "key1": "apache"
+    },
+    "skip": false
+  },
+  {
+    "name": "simple ordered",
+    "tok": "%{+key/3} %{+key/1} %{+key/2}",
+    "msg": "1 2 3",
+    "expected": {
+      "key": "2 3 1"
+    },
+    "skip": false
+  },
+  {
+    "name": "simple append",
+    "tok": "%{key}-%{+key}-%{+key}",
+    "msg": "1-2-3",
+    "expected": {
+      "key": "1-2-3"
+    },
+    "skip": false
+  },
+  {
+    "name": "indirect field",
+    "tok": "%{key} %{\u0026key}",
+    "msg": "hello world",
+    "expected": {
+      "hello": "world",
+      "key": "hello"
+    },
+    "skip": false
+  },
+  {
+    "name": "skip field",
+    "tok": "%{} %{key}",
+    "msg": "hello world",
+    "expected": {
+      "key": "world"
+    },
+    "skip": false
+  },
+  {
+    "name": "named skiped field with indirect",
+    "tok": "%{?key} %{\u0026key}",
+    "msg": "hello world",
+    "expected": {
+      "hello": "world"
+    },
+    "skip": false
+  },
+  {
+    "name": "missing fields",
+    "tok": "%{name},%{addr1},%{addr2},%{addr3},%{city},%{zip}",
+    "msg": "Jane Doe,4321 Fifth Avenue,,,New York,87432",
+    "expected": {
+      "addr1": "4321 Fifth Avenue",
+      "addr2": "",
+      "addr3": "",
+      "city": "New York",
+      "name": "Jane Doe",
+      "zip": "87432"
+    },
+    "skip": false
+  },
+  {
+    "name": "ignore right padding",
+    "tok": "%{id} %{function-\u003e} %{server}",
+    "msg": "00000043 ViewReceive     machine-321",
+    "expected": {
+      "function": "ViewReceive",
+      "id": "00000043",
+      "server": "machine-321"
+    },
+    "skip": false
+  },
+  {
+    "name": "ignore left padding",
+    "tok": "%{id-\u003e} %{function} %{server}",
+    "msg": "00000043    ViewReceive machine-321",
+    "expected": {
+      "function": "ViewReceive",
+      "id": "00000043",
+      "server": "machine-321"
+    },
+    "skip": false
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-dissect
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -94,8 +94,9 @@ files:
 - lib/logstash/filters/dissect.rb
 - logstash-filter-dissect.gemspec
 - spec/filters/dissect_spec.rb
+- spec/fixtures/dissect_tests.json
 - spec/spec_helper.rb
-- vendor/jars/org/logstash/dissect/jruby-dissect-library/1.1.4/jruby-dissect-library-1.1.4.jar
+- vendor/jars/org/logstash/dissect/jruby-dissect-library/1.2.3/jruby-dissect-library-1.2.3.jar
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -118,11 +119,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Extracts unstructured event data into fields using delimiters
 test_files:
 - spec/filters/dissect_spec.rb
+- spec/fixtures/dissect_tests.json
 - spec/spec_helper.rb