logstash-codec-compress_spooler 2.0.4-java → 2.0.5-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3fc666c802ab50b5667083da7d68137a137858b
-  data.tar.gz: 295fedaeb7c1afde8aa0199421d74185b69a5c2f
+SHA256:
+  metadata.gz: 5e86db1e691c4ede63e18f698d253de72ef26a32aa655264121887bdb4905fe0
+  data.tar.gz: a244ba2bdb7aa08013534652cb6fe569b27290506cb3a881ce5db1a2a2f110f1
 SHA512:
-  metadata.gz: 62e1b5a29a19c753d80174643bf404e7376e9b2d32b172d75077fbf548a900f6148dbb14a57f7194b29fb19bc697e04e0969834ea6f0a038dd091697a6d26d6a
-  data.tar.gz: d8bde3f12797bef8bf0608ed192ed6f353e2ae0a9fb34974ac11b8227e2a495ac10544b29420bc34da2a81c3d0caf8834675f9318f6d405a4890dfe2716cedbf
+  metadata.gz: 24e9c421fab67c92ffc33f90b93fe214e6545b083fccf6453ebfbfa31253b2a23137cb6d21f00458bf79ff5b9190eb84c68e560a4c73dcd7c40da4257f8c7a02
+  data.tar.gz: 0a25bb51dcfbac612cd99646edab34fa9ebec6c20b2e2ebb23a25aed22ffe1411d3b26b02f2d8bac706f4982c4ad7920f3ec24fd7ec1c527f066b351786e17d7

data/Gemfile

@@ -1,2 +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/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012–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.

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Codecs/job/logstash-plugin-codec-compress_spooler-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Codecs/job/logstash-plugin-codec-compress_spooler-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-codec-compress_spooler.svg)](https://travis-ci.org/logstash-plugins/logstash-codec-compress_spooler)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,7 +55,12 @@ 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
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# 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
 

data/docs/index.asciidoc

@@ -0,0 +1,64 @@
+:plugin: compress_spooler
+:type: codec
+
+///////////////////////////////////////////
+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}"]
+
+=== Compress_spooler codec plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Compress_spooler Codec Configuration Options
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-compress_level>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-min_flush_time>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-spool_size>> |<<number,number>>|No
+|=======================================================================
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-compress_level"]
+===== `compress_level` 
+
+  * Value type is <<number,number>>
+  * Default value is `6`
+
+
+
+[id="plugins-{type}s-{plugin}-min_flush_time"]
+===== `min_flush_time` 
+
+  * Value type is <<number,number>>
+  * Default value is `0`
+
+The amount of time in seconds since last flush before a flush is forced,
+on the next event.
+Values smaller than 0 disables time based flushing.
+
+[id="plugins-{type}s-{plugin}-spool_size"]
+===== `spool_size` 
+
+  * Value type is <<number,number>>
+  * Default value is `50`
+
+
+
+

data/lib/logstash/codecs/compress_spooler.rb

@@ -6,12 +6,18 @@ class LogStash::Codecs::CompressSpooler < LogStash::Codecs::Base
   config :spool_size, :validate => :number, :default => 50
   config :compress_level, :validate => :number, :default => 6
 
+  # The amount of time in seconds since last flush before a flush is forced,
+  # on the next event.
+  # Values smaller than 0 disables time based flushing.
+  config :min_flush_time, :validate => :number, :default => 0
+
   public
 
   def register
     require "msgpack"
     require "zlib"
     @buffer = []
+    @last_flush = Time.now.to_i
   end
 
   def decode(data)
@@ -25,9 +31,10 @@ class LogStash::Codecs::CompressSpooler < LogStash::Codecs::Base
     # MessagePack#pack which relies on pure Ruby object recognition
     @buffer << LogStash::Util.normalize(event.to_hash).merge(LogStash::Event::TIMESTAMP => event.timestamp.to_iso8601)
     # If necessary, we flush the buffer and get the data compressed
-    if @buffer.length >= @spool_size
+    if @buffer.length >= @spool_size || time_to_flush?
       @on_event.call(compress(@buffer, @compress_level))
       @buffer.clear
+      @last_flush = Time.now.to_i
     end
   end # def encode
 
@@ -53,4 +60,9 @@ class LogStash::Codecs::CompressSpooler < LogStash::Codecs::Base
     z.close
     result
   end
+
+  def time_to_flush?
+    return @min_flush_time > 0 && (@last_flush + @min_flush_time < Time.now.to_i)
+  end
+
 end # class LogStash::Codecs::CompressSpooler

data/logstash-codec-compress_spooler.gemspec

@@ -1,17 +1,17 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-codec-compress_spooler'
-  s.version         = '2.0.4'
+  s.version         = '2.0.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "codec that processes compressed spooled data"
-  s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  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/**/*','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)/})

data/spec/codecs/compress_spooler_spec.rb

@@ -143,6 +143,33 @@ describe LogStash::Codecs::CompressSpooler do
           expect(buffer.size).to eq(2)
         end
       end
+
+      context "message spooling if min flush time is set" do
+        let(:spool_size) { 10 }
+        let(:min_flush_time) { 2 }
+        let(:compress_spooler_config) { { "spool_size" => spool_size, "min_flush_time" => min_flush_time } } 
+        subject(:codec) { LogStash::Codecs::CompressSpooler.new(compress_spooler_config) }
+        let(:data) { {"foo" => "bar"} }
+
+        it "dont'f flush the initial messages, but flush after min flush time on next message" do
+          codec.encode(event)
+          buffer= codec.instance_variable_get(:@buffer)
+          expect(buffer.size).to eq(1)
+
+          codec.encode(event)
+          buffer= codec.instance_variable_get(:@buffer)
+          expect(buffer.size).to eq(2)
+
+          sleep(min_flush_time + 1)
+
+          buffer= codec.instance_variable_get(:@buffer)
+          expect(buffer.size).to eq(2)
+
+          codec.encode(event)
+          buffer= codec.instance_variable_get(:@buffer)
+          expect(buffer.size).to eq(0)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-compress_spooler
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+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: []
@@ -64,6 +66,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/codecs/compress_spooler.rb
 - logstash-codec-compress_spooler.gemspec
 - spec/codecs/compress_spooler_spec.rb
@@ -89,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key:
 specification_version: 4
 summary: codec that processes compressed spooled data