logstash-filter-truncate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68f37db86bda4de74978902b01f9dcd4628d7525
+  data.tar.gz: 3ac1b4f08c99a5d167302fa828868c1a524925b2
+SHA512:
+  metadata.gz: 5559123d9bcf737271ff90147864bafd0d97568bed99893253400aa219ee43262f204366d7a1e248d2f4c277f6754bd0bda35a0897649cc6fc889199216abef8
+  data.tar.gz: b5ef11bb6b6be7aa2a2263b9af4ffe9cf0869fdf001b6581b0a9230d233578b17d6a7c534f33600941d47d62cfca00b0ec80b994ad333a30f08d74d599798d09

data/CHANGELOG.md

@@ -0,0 +1 @@
+## 0.0.1

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* ...
+
+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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 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 2016 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-truncate.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-truncate)
+
+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/lib/logstash/filters/truncate.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+# Allows you to truncate fields longer than a given length.
+#
+# This truncates on bytes values, not character count.  In practice, this
+# should mean that the truncated length is somewhere between `length_bytes` and
+# `length_bytes - 6` (UTF-8 supports up to 6-byte characters).
+class LogStash::Filters::Truncate < LogStash::Filters::Base
+  config_name "truncate"
+
+  # A list of fieldrefs to truncate if they are too long.
+  #
+  # If not specified, the default behavior will be to attempt truncation on all
+  # strings in the event. This default behavior could be computationally
+  # expensive, so if you know exactly which fields you wish to truncate, it is
+  # advised that you be specific and configure the fields you want truncated.
+  #
+  # Special behaviors for non-string fields:
+  # 
+  # * Numbers: No action
+  # * Array: this plugin will attempt truncation on all elements of that array.
+  # * Hash: truncate will try all values of the hash (recursively, if this hash
+  # contains other hashes).
+  config :fields, :validate => :string, :list => true
+
+  # Fields over this length will be truncated to this length.
+  #
+  # Truncation happens from the end of the text (the start will be kept).
+  #
+  # As an example, if you set `length_bytes => 10` and a field contains "hello
+  # world, how are you?", then this field will be truncated and have this value:
+  # "hello worl"
+  config :length_bytes, :validate => :number, :required => true
+
+  def register
+    # nothing
+  end
+
+  def filter(event)
+    if @fields
+      @fields.each do |field|
+        Truncator.truncate(event, field, @length_bytes)
+      end
+    else
+      Truncator.truncate_all(event, @length_bytes)
+    end
+  end
+
+  module Truncator
+    module_function
+    
+    def trim(value, length)
+      return value if value.bytesize <= length
+      return value if value.nil?
+      return "" if length == 0
+      return nil if length < 0
+
+      # Nothing to truncate if the string is empty.
+      return value if value.length == 0
+
+      # Do the actual truncation.
+      v = value.byteslice(0, length)
+
+      # Verify we didn't break the last multibyte character.
+      # If we did, keep backing up until it's a good one.
+      # Unpack 'U' here will throw an exception if the last character is not a
+      # valid UTF-8 character.
+      # Note: I am not certain this is the correct solution in all cases.
+      i = 0
+      while !(v[-1].valid_encoding? && v.bytesize > 0)
+        i += 1
+        return "" if length - i == 0
+        v = value.byteslice(0, length - i)
+      end
+
+      return v
+    end
+
+    def truncate_all(event, length)
+      # TODO(sissel): I couldn't find a better way to get the top level keys for
+      # an event. Nor could I find a way to iterate over all the keys in an
+      # event, so this may have to suffice.
+      fields = event.to_hash.keys.map { |k| "[#{k}]" }
+      fields.each do |field|
+        truncate(event, field, length)
+      end
+    end
+
+    def truncate(event, field, length)
+      value = event.get(field)
+      if value.is_a?(String)
+        event.set(field, trim(value, length))
+      elsif value.is_a?(Array)
+        new_list = value.map { |v| v.is_a?(String) ? trim(v, length) : v }
+        event.set(field, new_list)
+      elsif value.is_a?(Hash) || value.is_a?(java.util.Map)
+        value.keys.each do |key|
+          truncate(event, "#{field}[#{key}]", length)
+        end
+      end
+    end
+  end
+end

data/logstash-filter-truncate.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-truncate'
+  s.version         = '1.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This filter allows you to truncate fields to a given length."
+  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']
+
+  # 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"
+  s.add_development_dependency "flores", "~> 0.0.7"
+end

data/spec/filters/truncate_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/truncate"
+require "flores/random"
+require "flores/rspec"
+
+RSpec.configure do |config|
+  Flores::RSpec.configure(config)
+end
+
+
+describe LogStash::Filters::Truncate do
+  analyze_results
+
+  context "defaults" do
+    let(:data) {
+      {
+        "foo" => { "bar" => Flores::Random.text(0..1000) },
+        "one" => { "two" => { "three" => Flores::Random.text(0..1000) } },
+        "baz" => Flores::Random.text(0..1000),
+      }
+    }
+    let(:length) { Flores::Random.integer(0..1000) }
+    subject { described_class.new("length_bytes" => length) }
+    let(:event) { LogStash::Event.new(data) }
+
+    before { subject.filter(event) }
+
+    stress_it "should truncate all strings in the hash" do
+      expect(event.get("[foo][bar]").bytesize).to be <= length
+      expect(event.get("[one][two][three]").bytesize).to be <= length
+      expect(event.get("baz").bytesize).to be <= length
+    end
+  end
+
+  context "with string fields" do
+    let(:text) { Flores::Random.text(0..1000) }
+    let(:length) { Flores::Random.integer(0..1000) }
+    subject { described_class.new("length_bytes" => length, "fields" => [ "example" ]) }
+    let(:event) { LogStash::Event.new("message" => text, "example" => text) }
+
+    before do
+      subject.filter(event)
+    end
+
+    stress_it "should truncate the requested field" do
+      expect(event.get("example").bytesize).to be <= length
+    end
+
+    stress_it "should remain valid UTF-8" do
+      expect(event.get("example")).to be_valid_encoding
+    end
+
+    it "should not modify `message`" do
+      expect(event.get("message")).to be == text
+    end
+  end
+
+  context "with non-string fields" do
+    let(:number) { Flores::Random.integer(-500.. 500) }
+    let(:length) { Flores::Random.integer(0..1000) }
+    subject { described_class.new("length_bytes" => length, "fields" => [ "example" ]) }
+    let(:event) { LogStash::Event.new("example" => number) }
+
+
+    it "should do nothing" do
+      expect(event.get("example")).to be == number
+    end
+  end
+
+  context "with array fields" do
+    let(:count) { Flores::Random.integer(0..20) }
+    let(:list) { count.times.map { Flores::Random.text(0..1000) } }
+    let(:length) { Flores::Random.integer(0..1000) }
+    subject { described_class.new("length_bytes" => length, "fields" => [ "example" ]) }
+    let(:event) { LogStash::Event.new("example" => list) }
+
+    before { subject.filter(event) }
+
+    stress_it "should truncate all elements in a list" do
+      count.times do |i| 
+        expect(event.get("[example][#{i}]").bytesize).to be <= length
+      end
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-truncate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  name: flores
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+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:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/truncate.rb
+- logstash-filter-truncate.gemspec
+- spec/filters/truncate_spec.rb
+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.4.8
+signing_key:
+specification_version: 4
+summary: This filter allows you to truncate fields to a given length.
+test_files:
+- spec/filters/truncate_spec.rb