logstash-filter-aggregate 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4888d214c341865c9c54f9bf4e3c4e438a9b355
-  data.tar.gz: 495cc82d7bf71d00679198be178e40bc9a296048
+  metadata.gz: 847b68e7346466cf927e4975469593a48ebb9771
+  data.tar.gz: 9b0dd0eb302cfba006c09970a2442ccf5d316fa9
 SHA512:
-  metadata.gz: dd15d7f6ad1dd1b1e30db72373c6bf787eff2caf6515c7e46262cdf681d984886e9c9edc6d8f4d622efaae9943f403ec9b516f9eec7dc9a3b800044f11c2609c
-  data.tar.gz: 90be8ce2b39f9d59404427c3833e5fb753f512e9c6a4e69f3093d0de6e0363e8c30bf922fe96b8e41582580b43bd7fae15bd2b8a65d02dca82f98fc32636a726
+  metadata.gz: d8d934c2ba456f1d828bf97e7cee1c5027d424e08340d6fd1be63944558c03daec0cf387b33621b4cb769dda443adb1e1693a7cf3e14b41990bd4d5b87673a34
+  data.tar.gz: 6cdf6281964d83d2c64dc19eb764b9d15e50fdfd9fc50d29e1d7d0af10edb67f7757eef66bb2bc70dbe856dda67ee9d9c1f4908de4b33adc85411b44356e2c6e

data/BUILD.md

@@ -1,82 +1,82 @@
-# Logstash Plugin
-
-This is a plugin for [Logstash](https://github.com/elastic/logstash).
-
-It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
-
-## Documentation
-
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
-
-- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
-
-## Developing
-
-### 1. Plugin Developement and Testing
-
-#### Code
-- To get started, you'll need JRuby with the Bundler gem installed.
-
-- Create a new plugin or clone an existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
-
-- Install dependencies
-```sh
-bundle install
-```
-
-#### Test
-
-- Update your dependencies
-
-```sh
-bundle install
-```
-
-- Run tests
-
-```sh
-bundle exec rspec
-```
-
-### 2. Running your unpublished Plugin in Logstash
-
-#### 2.1 Run in a local Logstash clone
-
-- Edit Logstash `Gemfile` and add the local plugin path, for example:
-```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
-```
-- Install plugin
-```sh
-bin/plugin install --no-verify
-```
-- Run Logstash with your plugin
-```sh
-bin/logstash -e 'filter {awesome {}}'
-```
-At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
-
-#### 2.2 Run in an installed Logstash
-
-You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
-
-- Build your plugin gem
-```sh
-gem build logstash-filter-awesome.gemspec
-```
-- Install the plugin from the Logstash home
-```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
-```
-- Start Logstash and proceed to test the plugin
-
-## Contributing
-
-All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
-
-Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
-
-It is more important to the community that you are able to contribute.
-
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone an existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
 For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/CHANGELOG.md

@@ -1,24 +1,28 @@
-# 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
-
-# v 2.0.2
-- fix issue #5 : when code call raises an exception, the error is logged and the event is tagged '_aggregateexception'. It avoids logstash crash.
-
-# v 2.0.0
- - 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
-
-# v 0.1.3
-- break compatibility with logstash 1.4
-- remove "milestone" method call which is deprecated in logstash 1.5
-- enhanced tests using 'expect' command
-- add a second example in documentation
-
-# v 0.1.2
-- compatible with logstash 1.4
-- first version available on github
+## 2.1.0
+ - new feature: add new option "aggregate_maps_path" so that aggregate maps can be stored at logstash shutdown and reloaded at logstash startup
+
+## 2.0.5
+ - 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.4
+ - internal,deps: New dependency requirements for logstash-core for the 5.0 release
+
+## 2.0.3
+ - bugfix: fix issue #10 : numeric task_id is now well processed
+
+## 2.0.2
+ - bugfix: fix issue #5 : when code call raises an exception, the error is logged and the event is tagged '_aggregateexception'. It avoids logstash crash.
+
+## 2.0.0
+ - 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
+ - internal,deps: Dependency on logstash-core update to 2.0
+
+## 0.1.3
+ - breaking: remove "milestone" method call which is deprecated in logstash 1.5, break compatibility with logstash 1.4
+ - internal,test: enhanced tests using 'expect' command
+ - docs: add a second example in documentation
+
+## 0.1.2
+ - compatible with logstash 1.4
+ - first version available on github

data/CONTRIBUTORS

@@ -1,13 +1,13 @@
-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)
-
-Note: If you've sent us patches, bug reports, or otherwise contributed to
-Logstash, and you aren't on the list above and want to be, please let us know
-and we'll make sure you're here. Contributions from folks like you are what make
-open source awesome.
+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)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
-gemspec
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -1,13 +1,13 @@
-Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,161 +1,167 @@
-# Logstash Filter Aggregate Documentation
-
-[![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
-
-* with these given logs : 
-```
-     INFO - 12345 - TASK_START - start
-     INFO - 12345 - SQL - sqlQuery1 - 12
-     INFO - 12345 - SQL - sqlQuery2 - 34
-     INFO - 12345 - TASK_END - end
-```
-
-* you can aggregate "sql duration" for the whole task with this configuration : 
-``` ruby
-     filter {
-         grok {
-             match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
-         }
-     
-         if [logger] == "TASK_START" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "map['sql_duration'] = 0"
-                 map_action => "create"
-             }
-         }
-     
-         if [logger] == "SQL" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "map['sql_duration'] += event['duration']"
-                 map_action => "update"
-             }
-         }
-     
-         if [logger] == "TASK_END" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "event['sql_duration'] = map['sql_duration']"
-                 map_action => "update"
-                 end_of_task => true
-                 timeout => 120
-             }
-         }
-     }
-```
-
-* the final event then looks like :
-``` ruby
-{
-         "message" => "INFO - 12345 - TASK_END - end",
-    "sql_duration" => 46
-}
-```
-
-the field `sql_duration` is added and contains the sum of all sql queries durations.
-
-## Example #2
-
-* If you have the same logs than example #1, but without a start log : 
-```
-     INFO - 12345 - SQL - sqlQuery1 - 12
-     INFO - 12345 - SQL - sqlQuery2 - 34
-     INFO - 12345 - TASK_END - end
-```
-
-* you can also aggregate "sql duration" with a slightly different configuration : 
-``` ruby
-     filter {
-         grok {
-             match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
-         }
-     
-         if [logger] == "SQL" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "map['sql_duration'] ||= 0 ; map['sql_duration'] += event['duration']"
-             }
-         }
-     
-         if [logger] == "TASK_END" {
-             aggregate {
-                 task_id => "%{taskid}"
-                 code => "event['sql_duration'] = map['sql_duration']"
-                 end_of_task => true
-                 timeout => 120
-             }
-         }
-     }
-```
-
-* the final event is exactly the same than example #1
-* the key point is the "||=" ruby operator.  
-it allows to initialize 'sql_duration' map entry to 0 only if this map entry is not already initialized
-
-
-## How it works
-- the filter needs a "task_id" to correlate events (log lines) of a same task
-- at the task beggining, filter creates a map, attached to task_id
-- for each event, you can execute code using 'event' and 'map' (for instance, copy an event field to map)
-- in the final event, you can execute a last code (for instance, add map data to final event)
-- after the final event, the map attached to task is deleted
-- in one filter configuration, it is recommanded to define a timeout option to protect the filter against unterminated tasks. It tells the filter to delete expired maps
-- 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.  
-This value must uniquely identify the task in the system.  
-This option is required.  
-Example value : `"%{application}%{my_task_id}"`  
-
-- **code:**  
-The code to execute to update map, using current event.  
-Or on the contrary, the code to execute to update event, using current map.  
-You will have a 'map' variable and an 'event' variable available (that is the event itself).  
-This option is required.  
-Example value : `"map['sql_duration'] += event['duration']"`  
-
-- **map_action:**  
-Tell the filter what to do with aggregate map (default :  "create_or_update").  
-`create`: create the map, and execute the code only if map wasn't created before  
-`update`: doesn't create the map, and execute the code only if map was created before  
-`create_or_update`: create the map if it wasn't created before, execute the code in all cases  
-Default value: `create_or_update`  
-
-- **end_of_task:**  
-Tell the filter that task is ended, and therefore, to delete map after code execution.  
-Default value: `false`  
-
-- **timeout:**  
-The amount of seconds after a task "end event" can be considered lost.  
-The task "map" is then evicted.  
-The default value is 0, which means no timeout so no auto eviction.  
-
-
-## Need Help?
-
-Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
-
-
-## Want to contribute?
-
-Read [BUILD.md](BUILD.md).
+# Logstash Filter Aggregate Documentation
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-aggregate.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-aggregate)
+
+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
+
+* with these given logs : 
+```
+     INFO - 12345 - TASK_START - start
+     INFO - 12345 - SQL - sqlQuery1 - 12
+     INFO - 12345 - SQL - sqlQuery2 - 34
+     INFO - 12345 - TASK_END - end
+```
+
+* you can aggregate "sql duration" for the whole task with this configuration : 
+``` ruby
+     filter {
+         grok {
+             match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
+         }
+     
+         if [logger] == "TASK_START" {
+             aggregate {
+                 task_id => "%{taskid}"
+                 code => "map['sql_duration'] = 0"
+                 map_action => "create"
+             }
+         }
+     
+         if [logger] == "SQL" {
+             aggregate {
+                 task_id => "%{taskid}"
+                 code => "map['sql_duration'] += event['duration']"
+                 map_action => "update"
+             }
+         }
+     
+         if [logger] == "TASK_END" {
+             aggregate {
+                 task_id => "%{taskid}"
+                 code => "event['sql_duration'] = map['sql_duration']"
+                 map_action => "update"
+                 end_of_task => true
+                 timeout => 120
+             }
+         }
+     }
+```
+
+* the final event then looks like :
+``` ruby
+{
+         "message" => "INFO - 12345 - TASK_END - end",
+    "sql_duration" => 46
+}
+```
+
+the field `sql_duration` is added and contains the sum of all sql queries durations.
+
+## Example #2
+
+* If you have the same logs than example #1, but without a start log : 
+```
+     INFO - 12345 - SQL - sqlQuery1 - 12
+     INFO - 12345 - SQL - sqlQuery2 - 34
+     INFO - 12345 - TASK_END - end
+```
+
+* you can also aggregate "sql duration" with a slightly different configuration : 
+``` ruby
+     filter {
+         grok {
+             match => [ "message", "%{LOGLEVEL:loglevel} - %{NOTSPACE:taskid} - %{NOTSPACE:logger} - %{WORD:label}( - %{INT:duration:int})?" ]
+         }
+     
+         if [logger] == "SQL" {
+             aggregate {
+                 task_id => "%{taskid}"
+                 code => "map['sql_duration'] ||= 0 ; map['sql_duration'] += event['duration']"
+             }
+         }
+     
+         if [logger] == "TASK_END" {
+             aggregate {
+                 task_id => "%{taskid}"
+                 code => "event['sql_duration'] = map['sql_duration']"
+                 end_of_task => true
+                 timeout => 120
+             }
+         }
+     }
+```
+
+* the final event is exactly the same than example #1
+* the key point is the "||=" ruby operator.  
+it allows to initialize 'sql_duration' map entry to 0 only if this map entry is not already initialized
+
+
+## How it works
+- the filter needs a "task_id" to correlate events (log lines) of a same task
+- at the task beggining, filter creates a map, attached to task_id
+- for each event, you can execute code using 'event' and 'map' (for instance, copy an event field to map)
+- in the final event, you can execute a last code (for instance, add map data to final event)
+- after the final event, the map attached to task is deleted
+- in one filter configuration, it is recommanded to define a timeout option to protect the filter against unterminated tasks. It tells the filter to delete expired maps
+- 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.  
+This value must uniquely identify the task in the system.  
+This option is required.  
+Example value : `"%{application}%{my_task_id}"`  
+
+- **code:**  
+The code to execute to update map, using current event.  
+Or on the contrary, the code to execute to update event, using current map.  
+You will have a 'map' variable and an 'event' variable available (that is the event itself).  
+This option is required.  
+Example value : `"map['sql_duration'] += event['duration']"`  
+
+- **map_action:**  
+Tell the filter what to do with aggregate map (default :  "create_or_update").  
+`create`: create the map, and execute the code only if map wasn't created before  
+`update`: doesn't create the map, and execute the code only if map was created before  
+`create_or_update`: create the map if it wasn't created before, execute the code in all cases  
+Default value: `create_or_update`  
+
+- **end_of_task:**  
+Tell the filter that task is ended, and therefore, to delete map after code execution.  
+Default value: `false`  
+
+- **timeout:**  
+The amount of seconds after a task "end event" can be considered lost.  
+When timeout occurs for a task, The task "map" is evicted.  
+The default value is 0, which means no timeout so no auto eviction.  
+
+- **aggregate_maps_path:**  
+The path to file where aggregate maps are stored when logstash stops and are loaded from when logstash starts.  
+If not defined, aggregate maps will not be stored at logstash stop and will be lost.   
+Should be defined for only one aggregate filter (as aggregate maps are global).  
+Example value : `"/path/to/.aggregate_maps"`
+
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+
+## Want to contribute?
+
+Read [BUILD.md](BUILD.md).