Merge pull request #142 from aYukiSekiguchi/prevent_refresh_from_stop…

…ping_on_exception Prevent AWS credentials refresh from stopping on exception
fluent · Oct 2, 2024 · e180c21 · e180c21
2 parents c840b29 + b877206
commit e180c21
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/lib/fluent/plugin/out_opensearch.rb b/lib/fluent/plugin/out_opensearch.rb
@@ -350,7 +350,11 @@ class << self
 
             @credential_mutex.synchronize do
               @_os = nil
-              @_aws_credentials = aws_credentials(@endpoint)
+              begin
+                @_aws_credentials = aws_credentials(@endpoint)
+              rescue => e
+                log.error("Failed to get new AWS credentials: #{e}")
+              end
             end
           end
         end

diff --git a/test/plugin/test_out_opensearch.rb b/test/plugin/test_out_opensearch.rb
@@ -3977,4 +3977,26 @@ def test_ignore_excetion_handles_appropriate_ones
       end
     }
   end
+
+  def test_no_aws_credentials_refresh_exception
+    # See https://github.com/fluent/fluent-plugin-opensearch/issues/129
+    endpoint_config =
+      Fluent::Config::Element.new('endpoint', '', {
+                                    'url' => "https://search-opensearch.aws.example.com/",
+                                    'region' => "local",
+                                    'access_key_id' => 'YOUR_AWESOME_KEY',
+                                    'secret_access_key' => 'YOUR_AWESOME_SECRET',
+                                    'refresh_credentials_interval' => '0',
+                                  }, [])
+    config = Fluent::Config::Element.new('ROOT', '**', { '@type' => 'opensearch' },
+                                         [endpoint_config])
+    # aws_credentials will be called twice in
+    # OpenSearchOutput#configure call, and in the 2nd call was changed not
+    # to emit exception. (instead, logging error) so check the error logs
+    flexmock(Fluent::Plugin::OpenSearchOutput).new_instances.should_receive(:aws_credentials)
+      .and_return(true).and_raise(::RuntimeError.new("No valid AWS credentials found."))
+    d = driver(config)
+    d.run
+    assert { d.logs.any?(/\[error\]: Failed to get new AWS credentials: No valid AWS credentials found.\n/) }
+  end
 end