fluent-plugin-opensearch 1.0.8 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba58a770b6f7d4aa621091bee5315988649ef54d2bb4b4c23e980d9ee8598008
-  data.tar.gz: 5f6023c9456af019bf82141180a76b01bc322418456c191ceae72c7f794fe44f
+  metadata.gz: c8fec7ab831f92c422c3982f9e3986e7737138ac8c2d03c27e91248c222388e2
+  data.tar.gz: 7a285e493ce2248453902cab4f4b2838d5cea49362bf93f03f314dc2fdc3a373
 SHA512:
-  metadata.gz: 98474ac3e7329082aace9f0d671c0ecf60844fa0bab91c431be8c0dc8ddd0bcfeca60ef0612d8c7e79459a4da528f266ecce0a42eea5029d28fce7483d6e87ec
-  data.tar.gz: 5879925be1f7b7079eb7f7c44d50145aab2f1b76afb6f99d3345252d25f96ce7b8fcf3bd1a215252d6e7a1ab76cc727a02bc6b2aaa854e9f98e969c485e7df61
+  metadata.gz: 1c43d875fb76266ccdf2901ae25ecba1e9298263d03b0f11560936e1097a8edb306dbb70d564107ce3508f462f07ff3be0d6795e3ddfc951d3c8e764d217487c
+  data.tar.gz: a8733006a11d8548dd41eab5dd8a626122d9c7044f73cc3ec18b2e18d916e47a898f8780556299e07c5d541aa24aba877f4733402051610a9a77c54bf8899136

data/.github/workflows/coverage.yaml

@@ -8,9 +8,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby 3.0
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.0'
+          ruby-version: '3.1'
       - name: Build and test with Rake
         run: |
           gem install bundler

data/.github/workflows/linux.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
         os:
           - ubuntu-latest
     name: Ruby ${{ matrix.ruby }} unit testing on ${{ matrix.os }}

data/.github/workflows/macos.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
         os:
           - macOS-latest
     name: Ruby ${{ matrix.ruby }} unit testing on ${{ matrix.os }}

data/.github/workflows/windows.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
         os:
           - windows-latest
     name: Ruby ${{ matrix.ruby }} unit testing on ${{ matrix.os }}

data/History.md

@@ -2,6 +2,15 @@
 
 ### [Unreleased]
 
+### 1.0.10
+ - Replace File.exists? with File.exist? to work with Ruby 3.2 (#93)
+ - Add a constraint for dependent gem to stay on Faraday v1 (#90)
+ - README.md: Fix a link to opensearch-ruby (#85)
+
+### 1.0.9
+ - Adjust GitHub workflows (#89)
+ - out\_opensearch: Provide service_name choices for handling serverless (#88)
+
 ### 1.0.8
  - Use faraday 1.x explicitly (#71)
 

data/README.OpenSearchInput.md

@@ -68,7 +68,7 @@ hosts host1:port1,host2:port2,host3:port3
 
 You can specify multiple OpenSearch hosts with separator ",".
 
-If you specify multiple hosts, this plugin will load balance updates to OpenSearch. This is an [opensearch-ruby](https://github.com/opensearch/opensearch-ruby) feature, the default strategy is round-robin.
+If you specify multiple hosts, this plugin will load balance updates to OpenSearch. This is an [opensearch-ruby](https://github.com/opensearch-project/opensearch-ruby) feature, the default strategy is round-robin.
 
 If you specify `hosts` option, `host` and `port` options are ignored.
 

data/README.md

@@ -1577,6 +1577,19 @@ If you want to expire AWS credentials in certain interval, you should specify `r
 </endpoint>
 ```
 
+### Use OpenSearch Serverless
+
+If you want to use Serverless version of OpenSearch service, you have to specify `aoss` in `aws_service_name` under `endpoint` section:
+
+```aconf
+<endpoint>
+  url https://CLUSTER_ENDPOINT_URL
+  region us-east-2
+  # ...
+  aws_service_name aoss # default is es that is for AWS OpenSearch Service not Serverless.
+</endpoint>
+```
+
 ## Troubleshooting
 
 See [Troubleshooting document](README.Troubleshooting.md)

data/fluent-plugin-opensearch.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = 'fluent-plugin-opensearch'
-  s.version       = '1.0.8'
+  s.version       = '1.0.10'
   s.authors       = ['Hiroshi Hatake']
   s.email         = ['cosmo0920.wp@gmail.com']
   s.description   = %q{Opensearch output plugin for Fluent event collector}
@@ -27,8 +27,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'opensearch-ruby'
   s.add_runtime_dependency "aws-sdk-core", "~> 3"
   s.add_runtime_dependency "faraday", "~> 1.10"
-  s.add_runtime_dependency "faraday_middleware-aws-sigv4"
-
+  s.add_runtime_dependency "faraday_middleware-aws-sigv4", "~> 0.6.1"
 
   s.add_development_dependency 'rake', '>= 0'
   s.add_development_dependency 'webrick', '~> 1.7.0'

data/lib/fluent/plugin/opensearch_index_template.rb

@@ -29,7 +29,7 @@ require_relative './opensearch_error'
 
 module Fluent::OpenSearchIndexTemplate
   def get_template(template_file)
-    if !File.exists?(template_file)
+    if !File.exist?(template_file)
       raise "If you specify a template_name you must specify a valid template file (checked '#{template_file}')!"
     end
     file_contents = IO.read(template_file).gsub(/\n/,'')
@@ -37,7 +37,7 @@ module Fluent::OpenSearchIndexTemplate
   end
 
   def get_custom_template(template_file, customize_template)
-    if !File.exists?(template_file)
+    if !File.exist?(template_file)
       raise "If you specify a template_name you must specify a valid template file (checked '#{template_file}')!"
     end
     file_contents = IO.read(template_file).gsub(/\n/,'')

data/lib/fluent/plugin/out_opensearch.rb

@@ -195,6 +195,7 @@ module Fluent::Plugin
       config_param :assume_role_web_identity_token_file, :string, :default => nil
       config_param :sts_credentials_region, :string, :default => nil
       config_param :refresh_credentials_interval, :time, :default => "5h"
+      config_param :aws_service_name, :enum, list: [:es, :aoss], :default => :es
     end
 
     config_section :buffer do
@@ -622,7 +623,7 @@ module Fluent::Plugin
                          lambda do |f|
                            f.request(
                              :aws_sigv4,
-                             service: 'es',
+                             service: @endpoint.aws_service_name.to_s,
                              region: @endpoint.region,
                              credentials: @_aws_credentials,
                            )

data/test/plugin/test_out_opensearch.rb

@@ -315,6 +315,39 @@ class OpenSearchOutputTest < Test::Unit::TestCase
     assert_equal "fluentd", instance.endpoint.assume_role_session_name
     assert_nil instance.endpoint.assume_role_web_identity_token_file
     assert_nil instance.endpoint.sts_credentials_region
+    assert_equal :es, instance.endpoint.aws_service_name
+  end
+
+  data("OpenSearch Service" => [:es, 'es'],
+       "OpenSearch Serverless" => [:aoss, 'aoss'])
+  test 'configure endpoint section w/ aws_service_name' do |data|
+    expected, conf = data
+    config = Fluent::Config::Element.new(
+      'ROOT', '', {
+        '@type' => 'opensearch',
+      }, [
+        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',
+                                      'aws_service_name' => conf,
+                                    }, []),
+        Fluent::Config::Element.new('buffer', 'tag', {}, [])
+
+      ])
+    instance = driver(config).instance
+
+    assert_equal "https://search-opensearch.aws.example.com", instance.endpoint.url
+    assert_equal "local", instance.endpoint.region
+    assert_equal "YOUR_AWESOME_KEY", instance.endpoint.access_key_id
+    assert_equal "YOUR_AWESOME_SECRET", instance.endpoint.secret_access_key
+    assert_nil instance.endpoint.assume_role_arn
+    assert_nil instance.endpoint.ecs_container_credentials_relative_uri
+    assert_equal "fluentd", instance.endpoint.assume_role_session_name
+    assert_nil instance.endpoint.assume_role_web_identity_token_file
+    assert_nil instance.endpoint.sts_credentials_region
+    assert_equal expected, instance.endpoint.aws_service_name
   end
 
   test 'configure compression' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-opensearch
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.10
 platform: ruby
 authors:
 - Hiroshi Hatake
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -84,16 +84,16 @@ dependencies:
   name: faraday_middleware-aws-sigv4
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +241,7 @@ licenses:
 - Apache-2.0
 metadata:
   changelog_uri: https://github.com/fluent/fluent-plugin-opensearch/blob/master/History.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -256,8 +256,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Opensearch output plugin for Fluent event collector
 test_files: