logstash-filter-memcached 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a5b909f6459b8a3d4ae405b3d9e076ed4c1bb7eab344dbc5f4a8a98c55268d0
-  data.tar.gz: 4dbf8017bcf03a1f6462da74df69b1ca8485b57df2c585f772cf38a158858c94
+  metadata.gz: c0dac09d5a353628d2b9507a8eb576ef034128eb603edd1f4445640c9ac06e44
+  data.tar.gz: 408ca2ab17dfb94cf400c0ffd2675b7e250879d05bdefeb6ab19454c2cc908af
 SHA512:
-  metadata.gz: bda94d2ee65f231e5a40bc8ffa4b32e8c04126694e74f66b1aee3e8a2e33cc56ca96707fb5cf2e1f29c8fd48e6a51d02e98ed70a2bcd5286cc9e2c7f2c1bc6a7
-  data.tar.gz: d094cebcab25b085d0f8aca5d6611fb7654e7d9f5ee56f7c64250998a427742b39c1ee35afdffdc0b6c05341b55d81329445423369096a68cf92f737fc62e07c
+  metadata.gz: 621ae0fb00da753e3268c04c2cd8d6c11e1f85b56348ca5334385a565daa174726291bdd9f15543b3f1f82169dcce2e7386707defa38d920f9cc502676d0772c
+  data.tar.gz: da42210db0f5dfb326a48fb67acd63223bf866c9c8a1e3a397dafa892078b913b8bce3f37a9d194d8496a19a79cab8cb1d5b0553ff3ed383a69152018693a156

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+## 0.1.1
+ - The plugin common options (e.g., `add_field`, `add_tag`, etc.) are now correctly only invoked when the plugin successfully gets one or more values from, or sets one or more values to memcached (#4)
+ - Fix links to argument types in documentation (#3)
+
 ## 0.1.0
-  - Plugin created with the logstash plugin generator
+  - Initial release

data/lib/logstash/filters/memcached.rb

@@ -81,10 +81,10 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
   end # def register
 
   def filter(event)
-    do_set(event)
-    do_get(event)
+    set_success = do_set(event)
+    get_success = do_get(event)
 
-    filter_matched(event)
+    filter_matched(event) if (set_success || get_success)
   end # def filter
 
   def close
@@ -94,7 +94,7 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
   private
 
   def do_get(event)
-    return unless @get && !@get.empty?
+    return false unless @get && !@get.empty?
 
     event_fields_by_memcached_key = @get.each_with_object({}) do |(memcached_key_template, event_field), memo|
       memcached_key = event.sprintf(memcached_key_template)
@@ -104,19 +104,23 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
     memcached_keys = event_fields_by_memcached_key.keys
     cache_hits_by_memcached_key = cache.get_multi(memcached_keys)
 
+    cache_hits = 0
     event_fields_by_memcached_key.each do |memcached_key, event_field|
       value = cache_hits_by_memcached_key[memcached_key]
       if value.nil?
         logger.trace("cache:get miss", context(key: memcached_key))
       else
         logger.trace("cache:get hit", context(key: memcached_key, value: value))
+        cache_hits += 1
         event.set(event_field, value)
       end
     end
+
+    return cache_hits > 0
   end
 
   def do_set(event)
-    return unless @set && !@set.empty?
+    return false unless @set && !@set.empty?
 
     values_by_memcached_key = @set.each_with_object({}) do |(event_field, memcached_key_template), memo|
       memcached_key = event.sprintf(memcached_key_template)
@@ -125,12 +129,16 @@ class LogStash::Filters::Memcached < LogStash::Filters::Base
       memo[memcached_key] = value unless value.nil?
     end
 
+    return false if values_by_memcached_key.empty?
+
     cache.multi do
       values_by_memcached_key.each do |memcached_key, value|
         logger.trace("cache:set", context(key: memcached_key, value: value))
         cache.set(memcached_key, value)
       end
     end
+
+    return true
   end
 
   def establish_connection

data/logstash-filter-memcached.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-memcached'
-  s.version       = '0.1.0'
+  s.version       = '0.1.1'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'A Logstash filter plugin for interacting with memcached'
   s.homepage      = 'https://github.com/yaauie/logstash-filter-memcached'

data/spec/filters/memcached_spec.rb

@@ -5,16 +5,16 @@ require "logstash/filters/memcached"
 LogStash::Logging::Logger::configure_logging("TRACE")
 
 describe LogStash::Filters::Memcached do
-  subject { described_class.new(config) }
+  subject(:memcached_filter) { described_class.new(config) }
   let(:cache) { double('memcached') }
   before(:each) do
-    allow(subject).to receive(:establish_connection).and_return(cache)
-    allow(subject).to receive(:close)
-    subject.register
+    allow(memcached_filter).to receive(:establish_connection).and_return(cache)
+    allow(memcached_filter).to receive(:close)
+    memcached_filter.register
   end
 
   after(:each) do
-    subject.close
+    memcached_filter.close
   end
 
   describe "#get" do
@@ -29,9 +29,26 @@ describe LogStash::Filters::Memcached do
 
     it "retrieves data from memcache" do
       expect(cache).to receive(:get_multi).with(["success/true/answer"]).and_return({"success/true/answer" => "42"})
-      subject.filter(event)
+      expect(memcached_filter).to receive(:filter_matched)
+      memcached_filter.filter(event)
       expect(event.get("ultimate")).to eq("answer" => "42")
     end
+
+    context 'when memcached does not hold the value' do
+      before do
+        expect(cache).to receive(:get_multi).with(["success/true/answer"]).and_return({"success/true/answer" => nil})
+      end
+
+      it 'does not invoke `filter_matched`' do
+        expect(memcached_filter).to_not receive(:filter_matched)
+        memcached_filter.filter(event)
+      end
+
+      it 'does not populate the value' do
+        memcached_filter.filter(event)
+        expect(event.include?("ultimate")).to be false
+      end
+    end
   end
 
   describe "#set" do
@@ -42,12 +59,37 @@ describe LogStash::Filters::Memcached do
         "set" => { "[answer]" => "success/%{success}/answer" },
       }
     end
-    let(:data) { { "answer" => "42", "success" => "true" } }
-    before(:each) { allow(cache).to receive(:multi) {|&b| b.call } }
+    before(:each) do
+      allow(cache).to receive(:multi) {|&b| b.call }
+      allow(cache).to receive(:set)
+    end
+
+    context 'when the event includes the value to set' do
+      let(:data) { { "answer" => "42", "success" => "true" } }
+
+      it "sets data on memcached" do
+        expect(cache).to receive(:set).with("success/true/answer", "42")
+        memcached_filter.filter(event)
+      end
+
+      it 'invokes `filter_matched`' do
+        expect(memcached_filter).to receive(:filter_matched)
+        memcached_filter.filter(event)
+      end
+    end
+
+    context 'when the event does not include the value being set' do
+      let(:data) { { "success" => "true" } }
+
+      it 'does not set data on memcached' do
+        expect(cache).to_not receive(:set)
+        memcached_filter.filter(event)
+      end
 
-    it "sets data on memcache" do
-      expect(cache).to receive(:set).with("success/true/answer", "42")
-      subject.filter(event)
+      it 'does not invoke `filter_matched`' do
+        expect(memcached_filter).to_not receive(:filter_matched)
+        memcached_filter.filter(event)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-memcached
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ry Biesemeyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement