logstash-filter-truncate 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68f37db86bda4de74978902b01f9dcd4628d7525
-  data.tar.gz: 3ac1b4f08c99a5d167302fa828868c1a524925b2
+  metadata.gz: 7cf39e6a114d7a4009db9ecd95141f257ebe0b07
+  data.tar.gz: e52131367130d3af6a7ebf1e7922015a989047c6
 SHA512:
-  metadata.gz: 5559123d9bcf737271ff90147864bafd0d97568bed99893253400aa219ee43262f204366d7a1e248d2f4c277f6754bd0bda35a0897649cc6fc889199216abef8
-  data.tar.gz: b5ef11bb6b6be7aa2a2263b9af4ffe9cf0869fdf001b6581b0a9230d233578b17d6a7c534f33600941d47d62cfca00b0ec80b994ad333a30f08d74d599798d09
+  metadata.gz: 250aea4f5f329c99e402d9a9dc787e89dc2d89ce6aab956a028de67cb7e9420873f41a465b0cf01d9847c8f77cd5a02ecbea3985e04c9eb3f47f2fed059fe31c
+  data.tar.gz: 1c817cec96009a69ba17c787da917cc15778b32dcacfb87665cc6dd36d54940271854bee4ee252da6f8d6a1539ad64b22e7546c2c11f633bef2bd74919e339b5

data/CHANGELOG.md

@@ -1 +1,6 @@
+## 1.0.1
+  - Method filter_matched wasn't being called after truncate #2
+
+## 1.0.0
+
 ## 0.0.1

data/Gemfile

@@ -1,3 +1,11 @@
 source 'https://rubygems.org'
 
 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,84 @@
+:plugin: truncate
+: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}"]
+
+=== Truncate filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+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).
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Truncate 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}-fields>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-length_bytes>> |<<number,number>>|Yes
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-fields"]
+===== `fields` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+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).
+
+[id="plugins-{type}s-{plugin}-length_bytes"]
+===== `length_bytes` 
+
+  * This is a required setting.
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+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"
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/truncate.rb

@@ -46,6 +46,7 @@ class LogStash::Filters::Truncate < LogStash::Filters::Base
     else
       Truncator.truncate_all(event, @length_bytes)
     end
+    filter_matched(event)
   end
 
   module Truncator

data/logstash-filter-truncate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-truncate'
-  s.version         = '1.0.0'
+  s.version         = '1.0.2'
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','*.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/truncate_spec.rb

@@ -84,6 +84,14 @@ describe LogStash::Filters::Truncate do
       end
     end
   end
-end
 
+  describe "calling of filter_matched" do
+    subject { described_class.new("length_bytes" => 1, "fields" => [ "example" ]) }
+    let(:event) { LogStash::Event.new("example" => 1000) }
 
+    it "should be called" do
+      expect(subject).to receive(:filter_matched).once
+      subject.filter(event)
+    end
+  end
+end

metadata

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