fluent-plugin-kubernetes_metadata_filter 2.5.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1991a6b8cd09f65728588401e697dda36954b94cf75b625789c6e7773d50ccf
-  data.tar.gz: df46f28a113c17aa3e2174d3ad23edb0b5b93fb6d65d5f02787d6ac83ac129a2
+  metadata.gz: a683b622df5649113828c46b650d722a5042c4c92023de4ea3350c1a5057bf8c
+  data.tar.gz: 86572e207c7aa2b595510922ac7b3946d3f2f1a4031d3f795d8356700c54d140
 SHA512:
-  metadata.gz: 1a41d498af8a2e92723c05679608294d07acf2cf7a87dfdf5921fe3a385df6369003eef939dd5aeabf970c67f31eb319ac1485d566ac110bcbe6b79f5acc392a
-  data.tar.gz: e62c355dbdb0ac1e89e43534c5929c80e82b166f5c614b1967d6ff79658835881a9c6803d5072e85a41c83fbefc8db326ba95c6d2f1c5a20ca1b8a0f18ce3cf1
+  metadata.gz: 77a3f4c2b33a0fe48e7b85636415d9b1d8d7aa1bba07af6c801290830a14f2c190c2dec76f9d48c7f0bc99131cb785dcf681217c5e42e90f3dfc9a24ad81f6e2
+  data.tar.gz: 051563042ca5826bb5f07a00367672b63718aac7a49f4e32cd9b83ba1312493ebafeee5211c8846eb4f3b0d5ec07f22c52d6f24ae059c4c6560d707f8a60404a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-kubernetes_metadata_filter (2.5.0)
+    fluent-plugin-kubernetes_metadata_filter (2.5.2)
       fluentd (>= 0.14.0, < 1.12)
       kubeclient (< 5)
       lru_redux
@@ -58,8 +58,12 @@ GEM
     http-parser (1.2.1)
       ffi-compiler (>= 1.0, < 2.0)
     http_parser.rb (0.6.0)
-    kubeclient (4.7.0)
+    jsonpath (1.0.5)
+      multi_json
+      to_regexp (~> 0.2.1)
+    kubeclient (4.8.0)
       http (>= 3.0, < 5.0)
+      jsonpath (~> 1.0)
       recursive-open-struct (~> 1.1, >= 1.1.1)
       rest-client (~> 2.0)
     lru_redux (1.1.0)
@@ -69,6 +73,7 @@ GEM
     mini_mime (1.0.2)
     minitest (4.7.5)
     msgpack (1.3.3)
+    multi_json (1.15.0)
     netrc (0.11.0)
     parallel (1.19.2)
     parser (2.7.1.4)
@@ -113,6 +118,7 @@ GEM
     test-unit-rr (1.0.5)
       rr (>= 1.1.1)
       test-unit (>= 2.5.2)
+    to_regexp (0.2.1)
     tzinfo (2.0.2)
       concurrent-ruby (~> 1.0)
     tzinfo-data (1.2020.1)

data/fluent-plugin-kubernetes_metadata_filter.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-kubernetes_metadata_filter"
-  gem.version       = "2.5.0"
+  gem.version       = "2.5.2"
   gem.authors       = ["Jimmi Dyson"]
   gem.email         = ["jimmidyson@gmail.com"]
   gem.description   = %q{Filter plugin to add Kubernetes metadata}

data/lib/fluent/plugin/kubernetes_metadata_common.rb

@@ -19,6 +19,12 @@
 module KubernetesMetadata
   module Common
 
+    class GoneError < StandardError
+      def initialize(msg="410 Gone")
+        super
+      end
+    end
+
     def match_annotations(annotations)
       result = {}
       @annotations_regexps.each do |regexp|

data/lib/fluent/plugin/kubernetes_metadata_watch_namespaces.rb

@@ -39,6 +39,12 @@ module KubernetesMetadata
         begin
           namespace_watcher ||= get_namespaces_and_start_watcher
           process_namespace_watcher_notices(namespace_watcher)
+        rescue GoneError => e
+          # Expected error. Quietly go back through the loop in order to
+          # start watching from the latest resource versions
+          @stats.bump(:namespace_watch_gone_errors)
+          log.info("410 Gone encountered. Restarting namespace watch to reset resource versions.", e)
+          namespace_watcher = nil
         rescue Exception => e
           @stats.bump(:namespace_watch_failures)
           if Thread.current[:namespace_watch_retry_count] < @watch_retry_max_times
@@ -123,9 +129,14 @@ module KubernetesMetadata
             # deleted but still processing logs
             @stats.bump(:namespace_cache_watch_deletes_ignored)
           when 'ERROR'
-            @stats.bump(:namespace_watch_error_type_notices)
-            message = notice['object']['message'] if notice['object'] && notice['object']['message']
-            raise "Error while watching namespaces: #{message}"
+            if notice.object && notice.object['code'] == 410
+              @stats.bump(:namespace_watch_gone_notices)
+              raise GoneError
+            else
+              @stats.bump(:namespace_watch_error_type_notices)
+              message = notice['object']['message'] if notice['object'] && notice['object']['message']
+              raise "Error while watching namespaces: #{message}"
+            end
           else
             reset_namespace_watch_retry_stats
             # Don't pay attention to creations, since the created namespace may not

data/lib/fluent/plugin/kubernetes_metadata_watch_pods.rb

@@ -19,6 +19,7 @@
 require_relative 'kubernetes_metadata_common'
 
 module KubernetesMetadata
+
   module WatchPods
 
     include ::KubernetesMetadata::Common
@@ -39,6 +40,12 @@ module KubernetesMetadata
         begin
           pod_watcher ||= get_pods_and_start_watcher
           process_pod_watcher_notices(pod_watcher)
+        rescue GoneError => e
+          # Expected error. Quietly go back through the loop in order to
+          # start watching from the latest resource versions
+          @stats.bump(:pod_watch_gone_errors)
+          log.info("410 Gone encountered. Restarting pod watch to reset resource versions.", e)
+          pod_watcher = nil
         rescue Exception => e
           @stats.bump(:pod_watch_failures)
           if Thread.current[:pod_watch_retry_count] < @watch_retry_max_times
@@ -129,9 +136,14 @@ module KubernetesMetadata
             # deleted but still processing logs
             @stats.bump(:pod_cache_watch_delete_ignored)
           when 'ERROR'
-            @stats.bump(:pod_watch_error_type_notices)
-            message = notice['object']['message'] if notice['object'] && notice['object']['message']
-            raise "Error while watching pods: #{message}"
+            if notice.object && notice.object['code'] == 410
+              @stats.bump(:pod_watch_gone_notices)
+              raise GoneError
+            else
+              @stats.bump(:pod_watch_error_type_notices)
+              message = notice['object']['message'] if notice['object'] && notice['object']['message']
+              raise "Error while watching pods: #{message}"
+            end
           else
             reset_pod_watch_retry_stats
             # Don't pay attention to creations, since the created pod may not

data/test/plugin/test_watch_namespaces.rb

@@ -76,6 +76,20 @@ class WatchNamespacesTestTest < WatchTest
            'message' => 'some error message'
          }
        )
+       @gone = OpenStruct.new(
+           type: 'ERROR',
+           object: {
+               'code' => 410,
+               'kind' => 'Status',
+               'message' => 'too old resource version: 123 (391079)',
+               'metadata' => {
+                   'name' => 'gone',
+                   'namespace' => 'gone',
+                   'uid' => 'gone_uid'
+               },
+               'reason' => 'Gone'
+           }
+       )
      end
 
     test 'namespace list caches namespaces' do
@@ -179,4 +193,30 @@ class WatchNamespacesTestTest < WatchTest
         end
       end
     end
+
+    test 'namespace watch raises a GoneError when a 410 Gone error is received' do
+      @cache['gone_uid'] = {}
+      @client.stub :watch_namespaces, [@gone] do
+        assert_raise KubernetesMetadata::Common::GoneError do
+          process_namespace_watcher_notices(start_namespace_watch)
+        end
+        assert_equal(1, @stats[:namespace_watch_gone_notices])
+      end
+    end
+
+    test 'namespace watch retries when 410 Gone errors are encountered' do
+      @client.stub :get_namespaces, @initial do
+        @client.stub :watch_namespaces, [@created, @gone, @modified] do
+          # Force the infinite watch loop to exit after 3 seconds. Verifies that
+          # no unrecoverable error was thrown during this period of time.
+          assert_raise Timeout::Error.new('execution expired') do
+            Timeout.timeout(3) do
+              set_up_namespace_thread
+            end
+          end
+          assert_operator(@stats[:namespace_watch_gone_errors], :>=, 3)
+          assert_operator(@stats[:namespace_watch_gone_notices], :>=, 3)
+        end
+      end
+    end
 end

data/test/plugin/test_watch_pods.rb

@@ -142,6 +142,20 @@ class DefaultPodWatchStrategyTest < WatchTest
            'message' => 'some error message'
          }
        )
+       @gone = OpenStruct.new(
+           type: 'ERROR',
+           object: {
+               'code' => 410,
+               'kind' => 'Status',
+               'message' => 'too old resource version: 123 (391079)',
+               'metadata' => {
+                   'name' => 'gone',
+                   'namespace' => 'gone',
+                   'uid' => 'gone_uid'
+               },
+               'reason' => 'Gone'
+           }
+       )
      end
 
     test 'pod list caches pods' do
@@ -261,4 +275,30 @@ class DefaultPodWatchStrategyTest < WatchTest
         end
       end
     end
+
+    test 'pod watch raises a GoneError when a 410 Gone error is received' do
+      @cache['gone_uid'] = {}
+      @client.stub :watch_pods, [@gone] do
+        assert_raise KubernetesMetadata::Common::GoneError do
+          process_pod_watcher_notices(start_pod_watch)
+        end
+        assert_equal(1, @stats[:pod_watch_gone_notices])
+      end
+    end
+
+    test 'pod watch retries when 410 Gone errors are encountered' do
+      @client.stub :get_pods, @initial do
+        @client.stub :watch_pods, [@created, @gone, @modified] do
+          # Force the infinite watch loop to exit after 3 seconds. Verifies that
+          # no unrecoverable error was thrown during this period of time.
+          assert_raise Timeout::Error.new('execution expired') do
+            Timeout.timeout(3) do
+              set_up_pod_thread
+            end
+          end
+          assert_operator(@stats[:pod_watch_gone_errors], :>=, 3)
+          assert_operator(@stats[:pod_watch_gone_notices], :>=, 3)
+        end
+      end
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-kubernetes_metadata_filter
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Jimmi Dyson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd