logstash-filter-aggregate 2.0.3 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6500c98a915954331abf2a5e589c58497d735a4c
-  data.tar.gz: a2936e86e9e33cb497a9d86b22356d1a9c5299ac
+  metadata.gz: b4888d214c341865c9c54f9bf4e3c4e438a9b355
+  data.tar.gz: 495cc82d7bf71d00679198be178e40bc9a296048
 SHA512:
-  metadata.gz: 38d0789ad10b94338d1ece65b84e4d7dbf60ab320da55ef1921426509ffd4f4516c2457ccad2723a5c98b19fc5e2490e3676dba80496970d03dbec23312a6d3e
-  data.tar.gz: b19dbfc2e2af9202dd6b992fbbf925fd8c8280ef404e8c054e2291f2ffac80b4550c91f7c8502f9c158d0ef6774a6d515dd294f0c7426215795b586a09e1b721
+  metadata.gz: dd15d7f6ad1dd1b1e30db72373c6bf787eff2caf6515c7e46262cdf681d984886e9c9edc6d8f4d622efaae9943f403ec9b516f9eec7dc9a3b800044f11c2609c
+  data.tar.gz: 90be8ce2b39f9d59404427c3833e5fb753f512e9c6a4e69f3093d0de6e0363e8c30bf922fe96b8e41582580b43bd7fae15bd2b8a65d02dca82f98fc32636a726

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.0.5
+  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+# 2.0.4
+  - New dependency requirements for logstash-core for the 5.0 release
 # v 2.0.3
 - fix issue #10 : numeric task_id is now well processed
 

data/CONTRIBUTORS

@@ -1,6 +1,9 @@
 The following is a list of people who have contributed ideas, code, bug
 reports, or in general have helped logstash along its way.
 
+Maintainers:
+* Fabien Baligand (fbaligand)
+
 Contributors:
 * Fabien Baligand (fbaligand)
 

data/README.md

@@ -3,6 +3,10 @@
 [![Build Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-aggregate-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-aggregate-unit/)
 
 The aim of this filter is to aggregate information available among several events (typically log lines) belonging to a same task, and finally push aggregated information into final task event.
+
+You should be very careful to set logstash filter workers to 1 (`-w 1` flag) for this filter to work 
+correctly otherwise documents
+may be processed out of sequence and unexpected results will occur.
  
 ## Example #1
 
@@ -108,6 +112,14 @@ it allows to initialize 'sql_duration' map entry to 0 only if this map entry is
 - if no timeout is defined, by default, all maps older than 1800 seconds are automatically deleted
 - finally, if `code` execution raises an exception, the error is logged and event is tagged '_aggregateexception'
 
+## Use Cases
+- extract some cool metrics from task logs and push them into task final log event (like in example #1 and #2)
+- extract error information in any task log line, and push it in final task event (to get a final document with all error information if any)
+- extract all back-end calls as a list, and push this list in final task event (to get a task profile)
+- extract all http headers logged in several lines to push this list in final task event (complete http request info)
+- for every back-end call, collect call details available on several lines, analyse it and finally tag final back-end call log line (error, timeout, business-warning, ...)
+- Finally, task id can be any correlation id matching your need : it can be a session id, a file path, ...
+
 ## Aggregate Plugin Options
 - **task_id :**  
 The expression defining task ID to correlate logs.  

data/lib/logstash/filters/aggregate.rb

@@ -7,6 +7,10 @@ require "thread"
 # 
 # The aim of this filter is to aggregate information available among several events (typically log lines) belonging to a same task,
 # and finally push aggregated information into final task event.
+#
+# You should be very careful to set logstash filter workers to 1 (`-w 1` flag) for this filter to work 
+# correctly otherwise documents
+# may be processed out of sequence and unexpected results will occur.
 # 
 # ==== Example #1
 # 
@@ -117,6 +121,15 @@ require "thread"
 # * finally, if `code` execution raises an exception, the error is logged and event is tagged '_aggregateexception'
 #
 #
+# ==== Use Cases
+# * extract some cool metrics from task logs and push them into task final log event (like in example #1 and #2)
+# * extract error information in any task log line, and push it in final task event (to get a final document with all error information if any)
+# * extract all back-end calls as a list, and push this list in final task event (to get a task profile)
+# * extract all http headers logged in several lines to push this list in final task event (complete http request info)
+# * for every back-end call, collect call details available on several lines, analyse it and finally tag final back-end call log line (error, timeout, business-warning, ...)
+# * Finally, task id can be any correlation id matching your need : it can be a session id, a file path, ...
+#
+#
 class LogStash::Filters::Aggregate < LogStash::Filters::Base
 
   config_name "aggregate"

data/logstash-filter-aggregate.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-aggregate'
-  s.version         = '2.0.3'
+  s.version         = '2.0.5'
   s.licenses = ['Apache License (2.0)']
   s.summary = "The aim of this filter is to aggregate information available among several events (typically log lines) belonging to a same task, and finally push aggregated information into final task event."
   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"
@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
   s.add_development_dependency 'logstash-devutils', '~> 0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-aggregate
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.5
 platform: ruby
 authors:
 - Elastic
@@ -9,58 +9,52 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2016-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 3.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - <
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.0'
+  name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !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'
 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
 email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/logstash/filters/aggregate.rb
-- spec/filters/aggregate_spec.rb
-- spec/filters/aggregate_spec_helper.rb
-- logstash-filter-aggregate.gemspec
 - BUILD.md
 - CHANGELOG.md
-- README.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
+- README.md
+- lib/logstash/filters/aggregate.rb
+- logstash-filter-aggregate.gemspec
+- spec/filters/aggregate_spec.rb
+- spec/filters/aggregate_spec_helper.rb
 homepage: https://github.com/logstash-plugins/logstash-filter-aggregate
 licenses:
 - Apache License (2.0)
@@ -73,17 +67,17 @@ 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.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: The aim of this filter is to aggregate information available among several events (typically log lines) belonging to a same task, and finally push aggregated information into final task event.