gitlab-fluent-plugin-redis-slowlog 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c1ce26c15184cd4542891a3175434b81ed44b295a6ffd2a8c96222d4fd16da8
-  data.tar.gz: 632613b3d6b036a6f94c66bea02dc08d5dff119202b1614f5df4ff1efd3c1c58
+  metadata.gz: 1c64f62b09c3902e94875fa90ca310357fda747eb68960f81c28f4f0e566ed0d
+  data.tar.gz: 3ccbe9ea9af8e67dc6e0b226538494462889bedebb7e9706fb88efebf2001999
 SHA512:
-  metadata.gz: aea063934370511db16b64743463868b909d4685c141e0d56365f2edb604688125851d815b5c241f0a721be42e17785aea0f6ce862e726b050e1812d70a0bd2a
-  data.tar.gz: 99ff9bf22f51fc3b5d6bffc55db8c3979b67bc41a4ef0ba69bb4ab136332a6de938694f39a9f4fc4409a2f41dcfdcb84a14bc8aec6fc353544a14dd9578713c2
+  metadata.gz: 1c394e1220236241046c06ef56a7fb59e823e46a9d4fa0382b589b4d7af035b7d9832a5c3c2daa207341e368b9f208707ed502617bcd7c6c55de9cf2af253093
+  data.tar.gz: 3b03fe4132255c47dccfff8411a31bd94b5a41ceb3806e96f1fd6875963d68560f47a61180c683b700c5f96556e9b860f204ae78240aa7c910beccf753e8cd8c

data/lib/fluent/plugin/in_redis_slowlog.rb

@@ -4,6 +4,8 @@ require "redis"
 module Fluent
   module Plugin
     class RedisSlowlogInput < Fluent::Plugin::Input
+      helpers :thread
+
       Fluent::Plugin.register_input("redis_slowlog", self)
 
       Entry = Struct.new(:id, :timestamp, :exec_time_us, :command)
@@ -16,6 +18,7 @@ module Fluent
       config_param :password, :string,  default: nil
       config_param :logsize,  :integer, default: 128
       config_param :interval, :integer, default: 10
+      config_param :timeout,  :integer, default: 2
 
       def configure(conf)
         super
@@ -25,7 +28,8 @@ module Fluent
           host: host,
           port: port,
           path: path,
-          password: password
+          password: password,
+          timeout: timeout
         )
       end
 
@@ -38,7 +42,7 @@ module Fluent
         end
 
         self.watching = true
-        self.watcher = Thread.new(&method(:watch))
+        self.watcher = thread_create(:redis_slowlog_watcher, &method(:watch))
       end
 
       def shutdown
@@ -57,10 +61,17 @@ module Fluent
         # Check the current id of the slowlog, and start logging from there
         current_log_id = get_slowlogs(1).first&.id || -1
 
-        while watching
-          sleep interval
-
-          current_log_id = output(current_log_id)
+        begin
+          while watching
+            sleep interval
+
+            current_log_id = output(current_log_id)
+          end
+        rescue Redis::BaseError => e
+          msg = "Error fetching slowlogs: #{e.inspect}"
+          log.error(msg)
+          router.emit("#{tag}.error", Fluent::EventTime.new(Time.now.to_i), { "message" => msg })
+          retry
         end
       end
 

data/spec/fluent/plugin/redis_slowlog_input_spec.rb

@@ -34,12 +34,13 @@ describe Fluent::Plugin::RedisSlowlogInput do
         path: "/path/to/redis.sock",
         host: "localhost",
         port: 1234,
-        password: "5iveL!fe" }
+        password: "5iveL!fe",
+        timeout: 2 }
     end
 
     it "delegates all of them to redis-rb" do
       # In ruby 2.5+ this could be config.slice(*[])
-      redis_params = config.select { |name, _| [:url, :path, :host, :port, :password].include?(name) }
+      redis_params = config.select { |name, _| [:url, :path, :host, :port, :password, :timeout].include?(name) }
 
       expect(Redis).to receive(:new).with(redis_params).and_return(fake_redis)
 
@@ -70,6 +71,9 @@ describe Fluent::Plugin::RedisSlowlogInput do
     end
 
     it "polls the slowlog with the configured interval and size" do
+      # thread_create startup
+      expect(plugin).to receive(:sleep).with(0.1).at_least(:once)
+      # core test
       expect(fake_redis).to receive(:slowlog).with("get", 1).ordered
       expect(plugin).to receive(:sleep).with(0).ordered
       expect(fake_redis).to receive(:slowlog).with("get", 10).ordered
@@ -82,6 +86,22 @@ describe Fluent::Plugin::RedisSlowlogInput do
       run
     end
 
+    it "retries when a connection error occurs" do
+      # thread_create startup
+      expect(plugin).to receive(:sleep).with(0.1).at_least(:once)
+      # core test
+      expect(fake_redis).to receive(:slowlog).with("get", 1).ordered
+      expect(plugin).to receive(:sleep).with(0).ordered
+      expect(fake_redis).to receive(:slowlog).with("get", 10).ordered.and_raise(Redis::ConnectionError)
+      expect(plugin).to receive(:sleep).with(0).ordered
+      expect(fake_redis).to receive(:slowlog).with("get", 10).ordered
+
+      # Limit to 2 cycles
+      allow(plugin).to receive(:watching).thrice.and_return(true, true, false)
+
+      run
+    end
+
     context "when the slowlog returns entries", :aggregate_failures do
       let(:startup_slowlog) { [[25637, 1590522108, 5, %w[SCAN 0]]] }
       let(:logged_slowlog) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-fluent-plugin-redis-slowlog
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Bob Van Landuyt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler