logstash-filter-collate 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7181265c0002280794b3e582c4baee7fa319832
-  data.tar.gz: 5eab4c0d691daa871e9a4a4c8a3df203d8d4fd09
+  metadata.gz: bbd0595fd0f8e570ba2ae97441c3fd416c2dc540
+  data.tar.gz: 63b1f467fef950ade3d10e03054abdbb7ce17750
 SHA512:
-  metadata.gz: 7671b269924e73d8022f0fa461454c25a952d70a34f19bbee52e331f411c796972526853d04bf72e9e470cd6285fc5e573697b50ae49752cd217d6f7215bbcf4
-  data.tar.gz: 76580fda06062d05f4f566e2b65a8f6677e1c48a20f7a25e0787f05a1dba6f4bff45ec368c7522f575a80c765620958ed0316ec834d71bbab078edb70bd088e8
+  metadata.gz: 001dafbe595860fda47da8d95d7e9347a640252c3a703f107e99a887cf8878cb6f74995bbf60afbd99a1960c1225be826b4d9686bedbc630ab7cc130355949a6
+  data.tar.gz: 95d2d9793561b20d431047586d42b5ff0de9429daa138468ff10a39f3a995854fd43e29d482ba85c9250fefd1fb2a1f6a913c5f309a1f56c72eaee2dc9be06a2

data/CHANGELOG.md

@@ -1,9 +1,11 @@
-# 2.0.4
-  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
-# 2.0.3
-  - New dependency requirements for logstash-core for the 5.0 release
+## 2.0.4
+ - internal,deps: Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+
+## 2.0.3
+ - internal,deps: New dependency requirements for logstash-core for the 5.0 release
+
 ## 2.0.0
- - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+ - internal: Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
- - Dependency on logstash-core update to 2.0
+ - internal,deps: Dependency on logstash-core update to 2.0
 

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-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/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%20Filters/job/logstash-plugin-filter-collate-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-collate-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-collate.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-collate)
 
 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,84 @@
+:plugin: collate
+: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}"]
+
+=== Collate filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Collate events by time or count.
+
+The original goal of this filter was to merge the logs from different sources
+by the time of log, for example, in real-time log collection, logs can be
+collated by amount of 3000 logs or can be collated in 30 seconds.
+
+The config looks like this:
+[source,ruby]
+    filter {
+      collate {
+        count => 3000
+        interval => "30s"
+        order => "ascending"
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Collate 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}-count>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-interval>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-order>> |<<string,string>>, one of `["ascending", "descending"]`|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}-count"]
+===== `count` 
+
+  * Value type is <<number,number>>
+  * Default value is `1000`
+
+How many logs should be collated.
+
+[id="plugins-{type}s-{plugin}-interval"]
+===== `interval` 
+
+  * Value type is <<string,string>>
+  * Default value is `"1m"`
+
+The `interval` is the time window which how long the logs should be collated. (default `1m`)
+
+[id="plugins-{type}s-{plugin}-order"]
+===== `order` 
+
+  * Value can be any of: `ascending`, `descending`
+  * Default value is `"ascending"`
+
+The `order` collated events should appear in.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/collate.rb

@@ -13,7 +13,7 @@ require "logstash/namespace"
 # [source,ruby]
 #     filter {
 #       collate {
-#         size => 3000
+#         count => 3000
 #         interval => "30s"
 #         order => "ascending"
 #       }

data/logstash-filter-collate.gemspec

@@ -1,17 +1,17 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-collate'
-  s.version         = '2.0.4'
+  s.version         = '2.0.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Collate events by time or count"
-  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)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-collate
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 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,7 @@ 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 +64,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/collate.rb
 - logstash-filter-collate.gemspec
 - spec/filters/collate_spec.rb