logstash-filter-translate 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8003929e0ef9c30f41f95b144ce3872b60cceaa7
-  data.tar.gz: b92c98f43df88c648a684f638cd04fed8e12336b
+  metadata.gz: bfc9d748a0e3154c355b43202c3583de6852f192
+  data.tar.gz: 505b2845b2a50e11f7fb6318fa36e4f82f7485d0
 SHA512:
-  metadata.gz: 2a65ab7595ecbd6eb16bbec0127f9052060c6601be096658b76b9ccdbb4ede9b176047adae3c9aaeeb8e17d22d6cf7f54a8bd6ca00bed52052c40b8f95494cbc
-  data.tar.gz: 0a7bb3d83cebf55531bf35bff3a626528932fe78de627e46ac0edc91fa7230296069943503529fec868f942a79dd914c74492550fd658ce69f98df98df458c51
+  metadata.gz: 773183d1b34ab1b5ec10c925c85c77e4f43bc992b4a1a15d501449c52d62d8b2d3512b722cbe241ade0ed6d174c5a83e0e359bba0db3fb304415ae702f7482eb
+  data.tar.gz: 77c37788a42fd3e4d174e56600de8fb988d5a950c8f0022be6c903ba15641a40631f78236c64745dbccfab819e7ca1e1e91f9791e145835dd58ec128c25aed26

data/CHANGELOG.md

@@ -1,10 +1,13 @@
+# 2.1.4
+  - Fix threadsafety issues by adding in a read/write lock
+
 # 2.1.3
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
 # 2.1.2
   - New dependency requirements for logstash-core for the 5.0 release
 ## 2.1.1
   - Add more descriptive message with the dictionary could not be loaded,
-  also include test for it. 
+  also include test for it.
 
 ## 2.1.0
   - Added other formats, a part from YAML, to be used when loading
@@ -12,7 +15,7 @@
   YAML, JSON and CSV.
 
 ## 2.0.0
-  - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+  - 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
 

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-translate-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-translate-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-translate.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-translate)
 
 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/lib/logstash/filters/translate.rb

@@ -4,6 +4,9 @@ require "logstash/namespace"
 require "json"
 require "csv"
 
+java_import 'java.util.concurrent.locks.ReentrantReadWriteLock'
+
+
 # A general search and replace tool which uses a configured hash
 # and/or a file to determine replacement values. Currently supported are 
 # YAML, JSON and CSV files.
@@ -121,10 +124,14 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   config :fallback, :validate => :string
 
   def register
+    rw_lock = java.util.concurrent.locks.ReentrantReadWriteLock.new
+    @read_lock = rw_lock.readLock
+    @write_lock = rw_lock.writeLock
+    
     if @dictionary_path
       @next_refresh = Time.now + @refresh_interval
       raise_exception = true
-      load_dictionary(raise_exception)
+      lock_for_write { load_dictionary(raise_exception) }
     end
 
     @logger.debug? and @logger.debug("#{self.class.name}: Dictionary - ", :dictionary => @dictionary)
@@ -135,12 +142,34 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
     end
   end # def register
 
+  def lock_for_read
+    @read_lock.lock
+    begin
+      yield
+    ensure
+      @read_lock.unlock
+    end
+  end
+
+  def lock_for_write
+    @write_lock.lock
+    begin
+      yield
+    ensure
+      @write_lock.unlock
+    end
+  end
+
   def filter(event)
     if @dictionary_path
-      if @next_refresh < Time.now
-        load_dictionary
-        @next_refresh = Time.now + @refresh_interval
-        @logger.info("refreshing dictionary file")
+      if needs_refresh?
+        lock_for_write do
+          if needs_refresh?
+            load_dictionary
+            @next_refresh = Time.now + @refresh_interval
+            @logger.info("refreshing dictionary file")
+          end
+        end
       end
     end
 
@@ -155,15 +184,16 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
         if @regex
           key = @dictionary.keys.detect{|k| source.match(Regexp.new(k))}
           if key
-            event[@destination] = @dictionary[key]
+            event[@destination] = lock_for_read { @dictionary[key] }
             matched = true
           end
         elsif @dictionary.include?(source)
-          event[@destination] = @dictionary[source]
+          event[@destination] = lock_for_read { @dictionary[source] }
           matched = true
         end
-      else 
-        translation = source.gsub(Regexp.union(@dictionary.keys), @dictionary)
+      else
+        translation = lock_for_read { source.gsub(Regexp.union(@dictionary.keys), @dictionary) }
+        
         if source != translation
           event[@destination] = translation.force_encoding(Encoding::UTF_8)
           matched = true
@@ -225,7 +255,7 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   end
 
   def merge_dictionary!(data, raise_exception=false)
-      @dictionary.merge!(data)
+    @dictionary.merge!(data)
   end
 
   def loading_exception(e, raise_exception=false)
@@ -236,4 +266,8 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
       @logger.warn("#{msg}, continuing with old dictionary", :dictionary_path => @dictionary_path)
     end
   end
+
+  def needs_refresh?
+    @next_refresh < Time.now
+  end
 end # class LogStash::Filters::Translate

data/logstash-filter-translate.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-translate'
-  s.version         = '2.1.3'
+  s.version         = '2.1.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "A general search and replace tool which uses a configured hash and/or a YAML file to determine replacement values."
-  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"

metadata

@@ -1,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-translate
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         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: '1.0'
-- !ruby/object:Gem::Dependency
+        version: '0'
   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
+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: []
@@ -70,12 +70,12 @@ 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: []