fluent-plugin-kubernetes_metadata_filter 2.4.4 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0960ac42673a9a25d8c1e293f152f432a89abe9bdad0cf2065670c9a5dee2a0c'
-  data.tar.gz: d351fb9d627c46b6da586ed9fa77f64ac2c3d475f924473a948fc190b3bbc9b2
+  metadata.gz: e067ab263fb4e86956da0e6ee07540701e8c728b3f658a9e7d27fbca6ac28307
+  data.tar.gz: 155aff320729d471fe41a09b9a5b838ac70f4bc5d32de39f95735d8ec4cf2213
 SHA512:
-  metadata.gz: 2cf30a65489f4d740302fa0c461cec207f0d8581a88be4a3692059a40fd17f3619b38f291f5a5dc3f585965d264113ed556d0f9fdea848a1ff818a0e7aa959e8
-  data.tar.gz: 66b9d0ad3e645b2f98c4a19f3d73cec2970a1e99a442520c2ea21d127be3071d2b54d020c97c37d3766324e92e1b035dbbb1782ed539c2db22294ebd0f571ad9
+  metadata.gz: afa694eaa98e032be272fcc94a6a6c9703185255f43d24475c0b1516e2ef3fb4f57040398e67197512701c5b3e14c04946c9516efee1dcefdf922342d592731c
+  data.tar.gz: 528302e11718e025dbadd349122fd7addd345284781b38c6a03d9bb8815b25d744248ec4cee866324fe13f40b340dedb424cbf33ec9a8e1f6a1782ba851aca29

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-kubernetes_metadata_filter (2.4.4)
+    fluent-plugin-kubernetes_metadata_filter (2.4.5)
       fluentd (>= 0.14.0, < 2)
       kubeclient (< 5)
       lru_redux

data/README.md

@@ -208,6 +208,7 @@ Then output becomes as belows
     "host": "jimmi-redhat.localnet",
     "pod_name":"fabric8-console-controller-98rqc",
     "pod_id": "c76927af-f563-11e4-b32d-54ee7527188d",
+    "pod_ip": "172.17.0.8",
     "container_name": "fabric8-console-container",
     "namespace_name": "default",
     "namespace_id": "23437884-8e08-4d95-850b-e94378c9b2fd",

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.4.4"
+  gem.version       = "2.4.5"
   gem.authors       = ["Jimmi Dyson"]
   gem.email         = ["jimmidyson@gmail.com"]
   gem.description   = %q{Filter plugin to add Kubernetes metadata}

data/lib/fluent/plugin/kubernetes_metadata_watch_namespaces.rb

@@ -29,7 +29,6 @@ module KubernetesMetadata
       # the configuration.
       namespace_watcher = start_namespace_watch
       Thread.current[:namespace_watch_retry_backoff_interval] = @watch_retry_interval
-      Thread.current[:namespace_watch_retry_count] = 0
 
       # Any failures / exceptions in the followup watcher notice
       # processing will be swallowed and retried. These failures /
@@ -96,11 +95,19 @@ module KubernetesMetadata
       watcher
     end
 
+    # Reset namespace watch retry count and backoff interval as there is a
+    # successful watch notice.
+    def reset_namespace_watch_retry_stats
+      Thread.current[:namespace_watch_retry_count] = 0
+      Thread.current[:namespace_watch_retry_backoff_interval] = @watch_retry_interval
+    end
+
     # Process a watcher notice and potentially raise an exception.
     def process_namespace_watcher_notices(watcher)
       watcher.each do |notice|
         case notice.type
           when 'MODIFIED'
+            reset_namespace_watch_retry_stats
             cache_key = notice.object['metadata']['uid']
             cached    = @namespace_cache[cache_key]
             if cached
@@ -110,10 +117,16 @@ module KubernetesMetadata
               @stats.bump(:namespace_cache_watch_misses)
             end
           when 'DELETED'
+            reset_namespace_watch_retry_stats
             # ignore and let age out for cases where
             # 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}"
           else
+            reset_namespace_watch_retry_stats
             # Don't pay attention to creations, since the created namespace may not
             # be used by any namespace on this node.
             @stats.bump(:namespace_cache_watch_ignored)

data/lib/fluent/plugin/kubernetes_metadata_watch_pods.rb

@@ -98,12 +98,19 @@ module KubernetesMetadata
       watcher
     end
 
+    # Reset pod watch retry count and backoff interval as there is a
+    # successful watch notice.
+    def reset_pod_watch_retry_stats
+      Thread.current[:pod_watch_retry_count] = 0
+      Thread.current[:pod_watch_retry_backoff_interval] = @watch_retry_interval
+    end
+
     # Process a watcher notice and potentially raise an exception.
     def process_pod_watcher_notices(watcher)
       watcher.each do |notice|
         case notice.type
           when 'MODIFIED'
-            Thread.current[:pod_watch_retry_count] = 0
+            reset_pod_watch_retry_stats
             cache_key = notice.object['metadata']['uid']
             cached    = @cache[cache_key]
             if cached
@@ -116,12 +123,16 @@ module KubernetesMetadata
               @stats.bump(:pod_cache_watch_misses)
             end
           when 'DELETED'
-            Thread.current[:pod_watch_retry_count] = 0
+            reset_pod_watch_retry_stats
             # ignore and let age out for cases where pods
             # 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}"
           else
-            Thread.current[:pod_watch_retry_count] = 0
+            reset_pod_watch_retry_stats
             # Don't pay attention to creations, since the created pod may not
             # end up on this node.
             @stats.bump(:pod_cache_watch_ignored)

data/test/plugin/test_watch_namespaces.rb

@@ -70,6 +70,12 @@ class WatchNamespacesTestTest < WatchTest
             }
          }
        )
+       @error = OpenStruct.new(
+         type: 'ERROR',
+         object: {
+           'message' => 'some error message'
+         }
+       )
      end
 
     test 'namespace list caches namespaces' do
@@ -137,6 +143,39 @@ class WatchNamespacesTestTest < WatchTest
           assert_equal(3, @stats[:namespace_watch_failures])
           assert_equal(2, Thread.current[:namespace_watch_retry_count])
           assert_equal(4, Thread.current[:namespace_watch_retry_backoff_interval])
+          assert_nil(@stats[:namespace_watch_error_type_notices])
+        end
+      end
+    end
+
+    test 'namespace watch retries when error is received' do
+      @client.stub :get_namespaces, @initial do
+        @client.stub :watch_namespaces, [@error] do
+          assert_raise Fluent::UnrecoverableError do
+            set_up_namespace_thread
+          end
+          assert_equal(3, @stats[:namespace_watch_failures])
+          assert_equal(2, Thread.current[:namespace_watch_retry_count])
+          assert_equal(4, Thread.current[:namespace_watch_retry_backoff_interval])
+          assert_equal(3, @stats[:namespace_watch_error_type_notices])
+        end
+      end
+    end
+
+    test 'namespace watch continues after retries succeed' do
+      @client.stub :get_namespaces, @initial do
+        @client.stub :watch_namespaces, [@modified, @error, @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_failures], :>=, 3)
+          assert_operator(Thread.current[:namespace_watch_retry_count], :<=, 1)
+          assert_operator(Thread.current[:namespace_watch_retry_backoff_interval], :<=, 1)
+          assert_operator(@stats[:namespace_watch_error_type_notices], :>=, 3)
         end
       end
     end

data/test/plugin/test_watch_pods.rb

@@ -136,6 +136,12 @@ class DefaultPodWatchStrategyTest < WatchTest
             }
          }
        )
+       @error = OpenStruct.new(
+         type: 'ERROR',
+         object: {
+           'message' => 'some error message'
+         }
+       )
      end
 
     test 'pod list caches pods' do
@@ -219,6 +225,39 @@ class DefaultPodWatchStrategyTest < WatchTest
           assert_equal(3, @stats[:pod_watch_failures])
           assert_equal(2, Thread.current[:pod_watch_retry_count])
           assert_equal(4, Thread.current[:pod_watch_retry_backoff_interval])
+          assert_nil(@stats[:pod_watch_error_type_notices])
+        end
+      end
+    end
+
+    test 'pod watch retries when error is received' do
+      @client.stub :get_pods, @initial do
+        @client.stub :watch_pods, [@error] do
+          assert_raise Fluent::UnrecoverableError do
+            set_up_pod_thread
+          end
+          assert_equal(3, @stats[:pod_watch_failures])
+          assert_equal(2, Thread.current[:pod_watch_retry_count])
+          assert_equal(4, Thread.current[:pod_watch_retry_backoff_interval])
+          assert_equal(3, @stats[:pod_watch_error_type_notices])
+        end
+      end
+    end
+
+    test 'pod watch continues after retries succeed' do
+      @client.stub :get_pods, @initial do
+        @client.stub :watch_pods, [@modified, @error, @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_failures], :>=, 3)
+          assert_operator(Thread.current[:pod_watch_retry_count], :<=, 1)
+          assert_operator(Thread.current[:pod_watch_retry_backoff_interval], :<=, 1)
+          assert_operator(@stats[:pod_watch_error_type_notices], :>=, 3)
         end
       end
     end

data/test/plugin/watch_test.rb

@@ -33,6 +33,8 @@ class WatchTest < Test::Unit::TestCase
     @watch_retry_exponential_backoff_base = 2
     @cache = {}
     @stats = KubernetesMetadata::Stats.new
+    Thread.current[:pod_watch_retry_count] = 0
+    Thread.current[:namespace_watch_retry_count] = 0
 
     @client = OpenStruct.new
     def @client.resourceVersion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-kubernetes_metadata_filter
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.4.5
 platform: ruby
 authors:
 - Jimmi Dyson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd