logstash-filter-sleep 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 557f29612aab142f21baed492f22ff142bda0ff3
-  data.tar.gz: 24a7d91dbc4769ca829332b9e7f827bb76765366
+  metadata.gz: 314c409bf1daada52a5d06807255db5e4d44a37f
+  data.tar.gz: 62f4b0294d31f1d467f403fcbe4ec1aff54106a9
 SHA512:
-  metadata.gz: 40f691b559423b76048d6abb5a12611ca34ffb54176f2f7e1f7f55017b7520ecfb107784dc11cf0222380b82039204680f1725d47219ab4e5a0bc53dd977fa66
-  data.tar.gz: 1ff75fb5a927dc3dcca4347275c838426ebaa6c96292dad47831842181d7cee610e4aeffe10254851d2849cc3ef708c61d32d91f15b07b413c028eb6ce4411ca
+  metadata.gz: 35f83090d22fffd517dd17b2e03cc9fecd196fd1f858fd50755a2060b7f516c8396a6fe89ec69c2a2b10484565e73c3b990881cda1e98bfd6a3ab6539302fa48
+  data.tar.gz: ab626be6ad5d76624aa64aefc1029670f85edbd5416d9ac86b1f0023f9536c970cd9bdbd0b79f8347c011a0504c016b7ddfb8727bc1a324a737d878c135ac887

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 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,119 @@
+:plugin: sleep
+: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}"]
+
+=== Sleep filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Sleep a given amount of time. This will cause logstash
+to stall for the given amount of time. This is useful
+for rate limiting, etc.
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Sleep 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}-every>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-replay>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-time>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-every"]
+===== `every` 
+
+  * Value type is <<string,string>>
+  * Default value is `1`
+
+Sleep on every N'th. This option is ignored in replay mode.
+
+Example:
+[source,ruby]
+    filter {
+      sleep {
+        time => "1"   # Sleep 1 second
+        every => 10   # on every 10th event
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-replay"]
+===== `replay` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Enable replay mode.
+
+Replay mode tries to sleep based on timestamps in each event.
+
+The amount of time to sleep is computed by subtracting the
+previous event's timestamp from the current event's timestamp.
+This helps you replay events in the same timeline as original.
+
+If you specify a `time` setting as well, this filter will
+use the `time` value as a speed modifier. For example,
+a `time` value of 2 will replay at double speed, while a
+value of 0.25 will replay at 1/4th speed.
+
+For example:
+[source,ruby]
+    filter {
+      sleep {
+        time => 2
+        replay => true
+      }
+    }
+
+The above will sleep in such a way that it will perform
+replay 2-times faster than the original time speed.
+
+[id="plugins-{type}s-{plugin}-time"]
+===== `time` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The length of time to sleep, in seconds, for every event.
+
+This can be a number (eg, 0.5), or a string (eg, `%{foo}`)
+The second form (string with a field value) is useful if
+you have an attribute of your event that you want to use
+to indicate the amount of time to sleep.
+
+Example:
+[source,ruby]
+    filter {
+      sleep {
+        # Sleep 1 second for every event.
+        time => "1"
+      }
+    }
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-sleep.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-sleep'
-  s.version         = '3.0.3'
+  s.version         = '3.0.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Sleep a given amount of time"
   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/**/*','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)/})

metadata

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