fluent-plugin-mutate_filter 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c5e97b05afb87f1d5b466ba464630f4d643861e
-  data.tar.gz: 69b17c8f7134faf9ac80edddf88174e064e63d80
+SHA256:
+  metadata.gz: 7d0517ddeae000508f12d85beee6701f9affe4667f49ce4a618949836471885d
+  data.tar.gz: c239f8b83fdf848fb6cd1155e8c419e8096757fdf1eb3a6276cbc631a30b0a25
 SHA512:
-  metadata.gz: 21a198e9f7295e335563409132ed161017dc5a6fc9fb5e9a39b646390b45367613c8606513c3dc650761b01b72cb5a177222cebc95fb2fdcb420d6ce11b29309
-  data.tar.gz: 4edca7c0bde6bc600f431183d3f1707bd4914f3f8f37a3ca645d9175782c9fca5b6aac3ed00f8a8e4298020c7a6f37110da7235b18adb40e82c4865eca97a8dc
+  metadata.gz: ad221f7cacb7a57fe4edbbb3f3c4a8b3bfddc7de81d3956e231ff21003240f6e1137667f94cee02b13630ec48b1e6cc655170f288504174f4302c05b45fa28d4
+  data.tar.gz: 55e77cd251abaa3886a4aa97acbf5521cd293d2ace9be6485b81645f29545b37dcd867663b93c88a98e04e1442dbcb9e9396ad763e3f872b6e0281404c9eca65

data/.rbenv-gemsets

@@ -0,0 +1 @@
+fluentd-1.2

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -1,4 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in fluent-plugin-mutate_filter.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   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 [yyyy] [name of copyright owner]
+
+   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

@@ -1,33 +1,134 @@
-# Fluent::MutateFilter
+# fluent-plugin-mutate
 
-This gem provides the `mutate` filter for Fluentd which is designed to replicate the way `mutate` works in Logstash as much as possible.
+[Fluentd](https://fluentd.org/) filter plugin to transform records.
 
-To be honest, this is a translation of [logstash-filter-mutate](https://github.com/logstash-plugins/logstash-filter-mutate) bordering on copy-paste.
+This gem provides the `mutate` filter for Fluentd which is designed to replicate the way `mutate` works in Logstash.
 
-## Requirements
+## Installation
 
-* Fluentd v0.12+
+### RubyGems
 
-## Installation
+```
+$ gem install fluent-plugin-mutate_filter
+```
 
-```bash
-gem install fluent-plugin-mutate_filter
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-mutate"
 ```
 
-## Configuration Options
+And then execute:
 
-All of the documentation and potential options are documented in the config_params section of the filter module. Below, only a subset of the options are displayed.
+```
+$ bundle
+```
+
+## Configuration
+
+The mutate filter accepts a list of `<mutate>` blocks which will be executed
+in sequence, applying their respective mutation `@type`.
+
+Each block will be evaluated in the order with which they were defined in the
+configuration file. Multiple keys within a same block _should_ be evaluated in
+the defined order, however this shouldn't be relied upon.
+
+While evaluating mutations, should an exception occur, it will be logged and
+further mutations will continue to be evaluated.
 
 ```
-<filter *>
-  @type     mutate
-  rename {
-    "old_field_name": "new_field_name",
-    "old_nest.field_name": "new_nest.field_name"
-  }
-  replace {
-    "new_nest.field_name": "%{old_nest.field_name}"
-  }
-</filter>
+<filter **>
+  @type mutate
+
+  <mutate>
+    @type     rename
+    old_key1  "new_key1"
+    old_key2  "new_key2"
+  </mutate>
+
+  <mutate>
+    @type     gsub
+    new_key2  ["^\\[log \\d{4}-\\d{2}-\\d{2}T.*\\] {","{"]
+  </mutate>
+</filter
 ```
 
+Global options:
+
+* `expand_nesting (true)|false`: Treat periods in field names as separators. Allowing you to reference `{ deeply: { nested: { key: value } } }` as deeply.nested.key.
+* `prune_empty (true)|false`: At the end of the list of mutations, delete any values with empty Maps or Arrays or Nil values.
+
+### Replacement Patterns
+
+Certain mutators, such as `gsub`, `replace` and `update` may contain special patterns which will be evaluated during the mutation. Supported patterns are:
+
+* `%{key}`: Pattern will be replaced by record key value. When `expand_nesting` is enabled, the key may be in dot notation.
+* `%e{ENV_VAR}`: Pattern will be replaced by an environment variable. If `ENV\_VAR` is `hostname`, then the machine's hostname will be injected.
+
+### Mutation Types
+
+##### `convert string|integer|float|boolean|datetime`
+
+Convert the key's value to a given type.
+
+##### `gsub [pattern, replace]`
+
+Apply a regex find and replace on a key's value.
+
+Additionally, new\_value may contain replacement patterns which will be evaluated during the replacement.
+
+##### `join <separator>`
+
+Join the components of an Array key using separator, converting it to a String.
+
+##### `lowercase true|false`
+
+Lowercase the key's value. If the value is an Array, then apply the filter to all array elements.
+
+##### `merge <source_field>`
+
+Merge the value of source\_field, which may be an Array or a Map, into the key's value.
+
+##### `parse json`
+
+Parse a key's value from JSON to a object.
+
+##### `rename <new_name>`
+
+Rename a key to a new key name.
+
+##### `remove true|false`
+
+Remove a key and it's value, whether the value be a string or an object.
+
+##### `replace <new_value>
+
+Replace the value of a key with new\_value, if the key exists. Otherwise, set the value of the key to new\_value.
+
+Additionally, new\_value may contain replacement patterns which will be evaluated during the replacement.
+
+##### `update <new_value>`
+
+Replace the value of a key with new\_value, if the key exists. Otherwise, ignore this operation.
+
+Additionally, new\_value may contain replacement patterns which will be evaluated during the replacement.
+
+##### `uppercase true|false`
+
+Uppercase the key's value. If the value is an Array, then apply the filter to all array elements.
+
+##### `split <separator>`
+
+Split the value of key using separator, converting it to an Array.
+
+##### `strip true|false`
+
+Remove whitespace surrounding a key's value. If the value is an Array, apply the filter to each element.
+
+## Copyright
+
+* Copyright(c) 2018- Jonathan Serafini
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -1,2 +1,13 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-mutate_filter.gemspec

@@ -1,18 +1,32 @@
-# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 Gem::Specification.new do |spec|
-  spec.name          = "fluent-plugin-mutate_filter"
-  spec.version       = "0.3.1"
-  spec.authors       = ["Jonathan Serafini"]
-  spec.email         = ["jonathan@serafini.ca"]
+  spec.name    = "fluent-plugin-mutate_filter"
+  spec.version = "1.0.0"
+  spec.authors = ["Jonathan Serafini"]
+  spec.email   = ["jonathan@serafini.ca"]
+
   spec.summary       = %q{A mutate filter for Fluent which functions like Logstash.}
-  spec.description   = spec.description
+  spec.description   = spec.summary
   spec.homepage      = "https://github.com/JonathanSerafini/fluent-plugin-mutate_filter"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = []
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "fluentd", [">= 0.12.0"]
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
 end