elastic-transport 8.3.6 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55e1343a320fd2a1dba29077ff4d9ad72b6adf62fe918856480f43e00e8a9927
-  data.tar.gz: da17629d377258be5b8564ba0bd82c3ef6119117e307a14ac60f8da14894e375
+  metadata.gz: 88698d9c25a84a6242bfb875623c2bca0bd9a0e5c40244272e88fe291b06a9e0
+  data.tar.gz: 90aff86e0a0f301908c888877d97a72ac926e9b5f7f48b23ad447813a729824d
 SHA512:
-  metadata.gz: e375ab5339638b8fedd29d38ae0ff6384407e8256c9201c383ee084689e4781752fe4cc9b23830a2380185234acfbbc59533d91f653ec51fff9007a433b033b3
-  data.tar.gz: 25a3847030def992ed441260e8921509ad5375353ad3e564218e799341bc53942e30245e6dad79c6e38e1783b993298e6729951320bb785e17308a2f5f9ca19f
+  metadata.gz: 3a235c8813516864b3b661790c56c9eeb6c8ee8b44a208d70a3309faca0075e9b45f25890be47d56ed29b845a70c5d3f6cd45c617592543993a0c6d788eb7211
+  data.tar.gz: 9cd571ba906d3e841f63f8bf3ea018820d0d9e2eddb9171f01785b6787df5ed19fecbeb0b05e494428af8853d2040c78c32f25a370c612d55a4a69ed77798682

data/.github/workflows/license.yml

@@ -7,7 +7,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3
+        ruby-version: '3.4'
     - name: Check license headers
       run: |
         ruby ./.github/check_license_headers.rb

data/.github/workflows/otel.yml

@@ -2,10 +2,10 @@ name: opentelemetry
 on:
   push:
     branches:
-      - 8.3
+      - main
   pull_request:
     branches:
-      - 8.3
+      - main
 jobs:
   test-otel:
     name: 'Test Open Telemetry'
@@ -16,8 +16,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.3', 'jruby-9.4']
-        es_version: ['9.2.0-SNAPSHOT']
+        ruby: ['3.4', 'jruby-9.4']
+        es_version: ['8.17.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

data/.github/workflows/tests.yml

@@ -1,11 +1,11 @@
-name: 8.3 tests
+name: main tests
 on:
   push:
     branches:
-      - 8.3
+      - main
   pull_request:
     branches:
-      - 8.3
+      - main
 jobs:
   test:
     name: 'Main tests'
@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby-9.3', 'jruby-9.4']
-        es_version: ['8.18.8-SNAPSHOT', '8.19.5-SNAPSHOT', '9.0.8-SNAPSHOT', '9.1.5-SNAPSHOT', '9.2.0-SNAPSHOT']
+        es_version: ['8.16.0-SNAPSHOT', '8.17.0-SNAPSHOT', '8.18.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -53,8 +53,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby-9.3']
-        es_version: ['8.19.5-SNAPSHOT']
+        ruby: ['3.0', '3.1', '3.2', '3.3', 'jruby-9.3']
+        es_version: ['8.16.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4

data/CHANGELOG.md

@@ -1,7 +1,39 @@
-## 8.3.6
+## 8.4.0
 
-- Moves `require 'timeout'` to the classes that use it. Closed [#79](https://github.com/elastic/elastic-transport-ruby/issues/79).
-- Sanitize url on OTEL spans, thanks @steve21168. Pull Request: [#98](https://github.com/elastic/elastic-transport-ruby/pull/98)
+- Adds support for **[Excon](https://github.com/excon/excon)** Faraday adapter. You can use the Excon adapter by setting it in when initializing an Elasticsearch client:
+
+```ruby
+require 'faraday/excon'
+
+Elasticsearch::Client.new(
+  host: host,
+  transport_options: transport_options,
+  adapter: :excon
+)
+```
+
+Excon may need some specific configuration for HTTPS/SSL. You may see certificate verification errors when trying to connect to Elastic. Excon has certificates bundled, but these can be customized:
+
+```ruby
+Excon.defaults[:ssl_ca_path] = path_to_certs
+ENV['SSL_CERT_DIR'] = path_to_certs
+Excon.defaults[:ssl_ca_file] = path_to_file
+ENV['SSL_CERT_FILE'] = path_to_file
+Excon.defaults[:ssl_verify_callback] = callback
+# (see OpenSSL::SSL::SSLContext#verify_callback)
+Excon.defaults[:ssl_verify_peer] = false` # (less secure).
+```
+
+- Adds support for **[Async::HTTP::Faraday](https://github.com/socketry/async-http-faraday)**. You can use the adapter by setting it when initializing an Elasticsearch client:
+```ruby
+require 'async-http-faraday'
+
+Elasticsearch::Client.new(
+  host: host,
+  adapter: :async_http
+)
+```
+- Minor refactors, styling fixes.
 
 ## 8.3.5
 

data/CONTRIBUTING.md

@@ -41,7 +41,13 @@ E.g.:
 $ rake docker:start[8.0.0-alpha1]
 ```
 
-You can find the available version in [Docker @ Elastic](https://www.docker.elastic.co/r/elasticsearch).
+You can find the available version in [Docker @ Elastic](https://www.docker.elastic.co/r/elasticsearch). You can also run Elasticsearch and Kibana locally with Docker with `start-local`:
+
+```bash
+curl -fsSL https://elastic.co/start-local | sh
+```
+
+This will run Elasticsearch in http://localhost:9200 and Kibana in http://localhost:5601. More information is available [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/run-elasticsearch-locally.html).
 
 # Contributing
 

data/Gemfile

@@ -21,13 +21,16 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'faraday-excon'
   gem 'faraday-httpclient'
   gem 'faraday-net_http_persistent'
   gem 'faraday-typhoeus'
+  gem 'mutex_m' if RUBY_VERSION >= '3.4'
   gem 'opentelemetry-sdk', require: false if RUBY_VERSION >= '3.0'
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'
   else
+    gem 'async-http-faraday'
     gem 'faraday-patron'
     gem 'oj'
     gem 'pry-byebug'

data/lib/elastic/transport/client.rb

@@ -123,8 +123,8 @@ module Elastic
       #
       def initialize(arguments = {}, &block)
         @arguments = arguments.transform_keys(&:to_sym)
-        @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call() : nil
-        @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call() : nil
+        @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call : nil
+        @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call : nil
         @arguments[:reload_connections] ||= false
         @arguments[:retry_on_failure]   ||= false
         @arguments[:delay_on_retry]     ||= 0
@@ -134,13 +134,7 @@ module Elastic
         @arguments[:http]               ||= {}
         @arguments[:enable_meta_header] = arguments.fetch(:enable_meta_header, true)
 
-        @hosts ||= __extract_hosts(@arguments[:hosts] ||
-                                   @arguments[:host] ||
-                                   @arguments[:url] ||
-                                   @arguments[:urls] ||
-                                   ENV['ELASTICSEARCH_URL'] ||
-                                   DEFAULT_HOST)
-
+        @hosts ||= extract_hosts
         @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
         @ca_fingerprint = @arguments.delete(:ca_fingerprint)
 
@@ -153,7 +147,7 @@ module Elastic
         else
           @transport_class = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
           @transport = if @transport_class == Transport::HTTP::Faraday
-                         @arguments[:adapter] ||= __auto_detect_adapter
+                         @arguments[:adapter] ||= auto_detect_adapter
                          set_meta_header # from include MetaHeader
                          @transport_class.new(hosts: @hosts, options: @arguments) do |faraday|
                            faraday.adapter(@arguments[:adapter])
@@ -246,7 +240,7 @@ module Elastic
       #
       # @api private
       #
-      def __extract_hosts(hosts_config)
+      def extract_hosts
         hosts = case hosts_config
                 when String
                   hosts_config.split(',').map { |h| h.strip! || h }
@@ -257,12 +251,20 @@ module Elastic
                 else
                   Array(hosts_config)
                 end
-
-        host_list = hosts.map { |host| __parse_host(host) }
+        host_list = hosts.map { |host| parse_host(host) }
         @arguments[:randomize_hosts] ? host_list.shuffle! : host_list
       end
 
-      def __parse_host(host)
+      def hosts_config
+        @arguments[:hosts] ||
+          @arguments[:host] ||
+          @arguments[:url] ||
+          @arguments[:urls] ||
+          ENV['ELASTICSEARCH_URL'] ||
+          DEFAULT_HOST
+      end
+
+      def parse_host(host)
         host_parts = case host
                      when String
                        if host =~ /^[a-z]+\:\/\//
@@ -313,12 +315,14 @@ module Elastic
       #
       # @api private
       #
-      def __auto_detect_adapter
+      def auto_detect_adapter
         if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new(2)
           return :patron if defined?(Faraday::Adapter::Patron)
           return :typhoeus if defined?(Faraday::Adapter::Typhoeus)
           return :httpclient if defined?(Faraday::Adapter::HTTPClient)
           return :net_http_persistent if defined?(Faraday::Adapter::NetHttpPersistent)
+          return :excon if defined?(Faraday::Adapter::Excon)
+          return :async_http if defined?(Async::HTTP::Faraday)
         else
           return :patron if defined?(::Patron)
           return :typhoeus if defined?(::Typhoeus)

data/lib/elastic/transport/opentelemetry.rb

@@ -21,70 +21,77 @@ module Elastic
     #
     # @api private
     class OpenTelemetry
-      OTEL_TRACER_NAME = 'elasticsearch-api'
+      OTEL_TRACER_NAME = 'elasticsearch-api'.freeze
       # Valid values for the enabled config are 'true' and 'false'. Default is 'true'.
-      ENV_VARIABLE_ENABLED = 'OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_ENABLED'
+      ENV_VARIABLE_ENABLED = 'OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_ENABLED'.freeze
       # Describes how to handle search queries in the request body when assigned to
       # a span attribute.
       # Valid values are 'raw', 'omit', 'sanitize'. Default is 'omit'.
-      ENV_VARIABLE_BODY_STRATEGY = 'OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY'
-      ENV_VARIABLE_DEPRECATED_BODY_STRATEGY = 'OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY'
-      DEFAULT_BODY_STRATEGY = 'omit'
+      ENV_VARIABLE_BODY_STRATEGY = 'OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY'.freeze
+      ENV_VARIABLE_DEPRECATED_BODY_STRATEGY = 'OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY'.freeze
+      DEFAULT_BODY_STRATEGY = 'omit'.freeze
       # A string list of keys whose values are redacted. This is only relevant if the body strategy is
       # 'sanitize'. For example, a config 'sensitive-key,other-key' will redact the values at
       # 'sensitive-key' and 'other-key' in addition to the default keys.
-      ENV_VARIABLE_BODY_SANITIZE_KEYS = 'OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_SEARCH_QUERY_SANITIZE_KEYS'
+      ENV_VARIABLE_BODY_SANITIZE_KEYS = 'OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_SEARCH_QUERY_SANITIZE_KEYS'.freeze
 
       # A list of the Elasticsearch endpoints that qualify as "search" endpoints. The search query in
       # the request body may be captured for these endpoints, depending on the body capture strategy.
       SEARCH_ENDPOINTS = Set[
-        "search",
-        "async_search.submit",
-        "msearch",
-        "eql.search",
-        "terms_enum",
-        "search_template",
-        "msearch_template",
-        "render_search_template",
+        'search',
+        'async_search.submit',
+        'msearch',
+        'eql.search',
+        'terms_enum',
+        'search_template',
+        'msearch_template',
+        'render_search_template',
       ]
 
       # Initialize the Open Telemetry wrapper object. Takes the options originally passed to
       # Client#initialize.
       def initialize(opts)
-        @tracer = (opts[:opentelemetry_tracer_provider] || ::OpenTelemetry.tracer_provider).tracer(
-          OTEL_TRACER_NAME, Elastic::Transport::VERSION
-        )
-        @body_strategy = ENV[ENV_VARIABLE_DEPRECATED_BODY_STRATEGY] || ENV[ENV_VARIABLE_BODY_STRATEGY] ||
-                           DEFAULT_BODY_STRATEGY
+        @tracer = tracer_provider(opts).tracer(OTEL_TRACER_NAME, Elastic::Transport::VERSION)
+        @body_strategy = ENV[ENV_VARIABLE_DEPRECATED_BODY_STRATEGY] ||
+                         ENV[ENV_VARIABLE_BODY_STRATEGY] ||
+                         DEFAULT_BODY_STRATEGY
         @sanitize_keys = ENV[ENV_VARIABLE_BODY_SANITIZE_KEYS]&.split(',')&.collect! do |pattern|
           Regexp.new(pattern.gsub('*', '.*'))
         end
       end
       attr_accessor :tracer
 
+      def tracer_provider(opts)
+        opts[:opentelemetry_tracer_provider] || ::OpenTelemetry.tracer_provider
+      end
+
       # Process the request body. Applies the body strategy, which can be one of the following:
-      # 'omit': return nil
+      # 'omit' (DEFAULT_BODY_STRATEGY): return nil
       # 'sanitize': redact values at the default list of keys + any additional keys provided in
       # the OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_SEARCH_QUERY_SANITIZE_KEYS env variable.
       # 'raw': return the original body, unchanged
       def process_body(body, endpoint)
-        unless @body_strategy == 'omit' || !SEARCH_ENDPOINTS.include?(endpoint)
-          if @body_strategy == 'sanitize'
-            Sanitizer.sanitize(body, @sanitize_keys).to_json
-          elsif @body_strategy == 'raw'
-            body&.is_a?(String) ? body : body.to_json
-          end
+        return if @body_strategy == DEFAULT_BODY_STRATEGY || !search_endpoint?(endpoint)
+
+        if @body_strategy == 'sanitize'
+          Sanitizer.sanitize(body, @sanitize_keys).to_json
+        elsif @body_strategy == 'raw'
+          body.is_a?(String) ? body : body.to_json
         end
       end
 
+      def search_endpoint?(endpoint)
+        SEARCH_ENDPOINTS.include?(endpoint)
+      end
+
       # Replaces values in a hash with 'REDACTED', given a set of keys to match on.
       class Sanitizer
         class << self
-          FILTERED = 'REDACTED'
+          FILTERED = 'REDACTED'.freeze
           DEFAULT_KEY_PATTERNS =
             %w[password passwd pwd secret *key *token* *session* *credit* *card* *auth* set-cookie].map! do |p|
-              Regexp.new(p.gsub('*', '.*'))
-            end
+            Regexp.new(p.gsub('*', '.*'))
+          end
 
           def sanitize(body, key_patterns = [])
             patterns = DEFAULT_KEY_PATTERNS

data/lib/elastic/transport/transport/base.rb

@@ -83,7 +83,7 @@ module Elastic
         # @return [Connections::Connection]
         # @see    Connections::Collection#get_connection
         #
-        def get_connection(options={})
+        def get_connection(options = {})
           resurrect_dead_connections! if Time.now > @last_request_at + @resurrect_after
 
           @counter_mtx.synchronize { @counter += 1 }
@@ -120,7 +120,7 @@ module Elastic
         # @return [Connections::Collection]
         # @api private
         #
-        def __rebuild_connections(arguments={})
+        def __rebuild_connections(arguments = {})
           @state_mutex.synchronize do
             @hosts       = arguments[:hosts]    || []
             @options     = arguments[:options]  || {}
@@ -195,7 +195,7 @@ module Elastic
         #
         def __log_response(method, path, params, body, url, response, json, took, duration)
           if logger
-            sanitized_url = sanitize_url(url.to_s)
+            sanitized_url = url.to_s.gsub(/\/\/(.+):(.+)@/, '//' + '\1:' + SANITIZED_PASSWORD + '@')
             log_info "#{method.to_s.upcase} #{sanitized_url} " +
                          "[status:#{response.status}, request:#{sprintf('%.3fs', duration)}, query:#{took}]"
             log_debug "> #{__convert_to_json(body)}" if body
@@ -232,7 +232,7 @@ module Elastic
         #
         # @api private
         #
-        def __convert_to_json(o=nil, options={})
+        def __convert_to_json(o = nil, options = {})
           o.is_a?(String) ? o : serializer.dump(o, options)
         end
 
@@ -472,13 +472,9 @@ module Elastic
           end
         end
 
-        def sanitize_url(url)
-          url.to_s.gsub(/\/\/(.+):(.+)@/, '//' + '\1:' + SANITIZED_PASSWORD + '@')
-        end
-
         def capture_otel_span_attributes(connection, url)
           if defined?(::OpenTelemetry)
-            ::OpenTelemetry::Trace.current_span&.set_attribute('url.full', sanitize_url(url))
+            ::OpenTelemetry::Trace.current_span&.set_attribute('url.full', url)
             ::OpenTelemetry::Trace.current_span&.set_attribute('server.address', connection.host[:host])
             ::OpenTelemetry::Trace.current_span&.set_attribute('server.port', connection.host[:port].to_i)
           end

data/lib/elastic/transport/transport/errors.rb

@@ -15,8 +15,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'timeout'
-
 module Elastic
   module Transport
     module Transport

data/lib/elastic/transport/transport/sniffer.rb

@@ -15,8 +15,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'timeout'
-
 module Elastic
   module Transport
     module Transport

data/lib/elastic/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elastic
   module Transport
-    VERSION = '8.3.6'.freeze
+    VERSION = '8.4.0'.freeze
   end
 end

data/lib/elastic/transport.rb

@@ -18,6 +18,7 @@
 require 'faraday'
 require 'multi_json'
 require 'time'
+require 'timeout'
 require 'uri'
 require 'zlib'
 

data/spec/elastic/transport/client_spec.rb

@@ -225,6 +225,38 @@ describe Elastic::Transport::Client do
       end
     end unless jruby?
 
+    context 'when the adapter is excon' do
+      let(:adapter) do
+        client.transport.connections.all.first.connection.builder.adapter
+      end
+
+      let(:client) do
+        require 'faraday/excon'
+
+        described_class.new(adapter: :excon, enable_meta_header: false)
+      end
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Excon
+      end
+    end if is_faraday_v2?
+
+    context 'when the adapter is async-http' do
+      let(:adapter) do
+        client.transport.connections.all.first.connection.builder.adapter
+      end
+
+      let(:client) do
+        require 'async/http/faraday'
+
+        described_class.new(adapter: :async_http, enable_meta_header: false)
+      end
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Async::HTTP::Faraday::Adapter
+      end
+    end unless jruby? || !is_faraday_v2?
+
     context 'when the adapter is specified as a string key' do
       let(:adapter) do
         client.transport.connections.all.first.connection.builder.adapter
@@ -1453,6 +1485,7 @@ describe Elastic::Transport::Client do
 
           context 'when using the HTTPClient adapter' do
             require 'faraday/httpclient'
+            require 'mutex_m' if RUBY_VERSION >= '3.4'
 
             let(:client) do
               described_class.new(hosts: ELASTICSEARCH_HOSTS, compression: true, adapter: :httpclient, enable_meta_header: false)

data/spec/elastic/transport/opentelemetry_spec.rb

@@ -320,22 +320,6 @@ if defined?(::OpenTelemetry)
           end
         end
       end
-
-      context 'sanitize in URL' do
-        let(:client) {
-          Elastic::Transport::Client.new(host: 'http://elastic:changeme@localhost:9250')
-        }
-
-        it 'sanitizes URL' do
-          client.perform_request(
-            'GET', '/', {}, nil, {}
-          )
-
-          span = exporter.finished_spans.find { |s| s.name == 'GET' }
-          expect(span.name).to eql('GET')
-          expect(span.attributes['url.full']).to match(/http:\/\/elastic:\*+@localhost:9250/)
-        end
-      end
     end
   end
 end

data/test/unit/adapters_test.rb

@@ -72,6 +72,22 @@ class Elastic::Transport::ClientAdaptersUnitTest < Minitest::Test
       end
     end
 
+    should 'use Excon Faraday adapter' do
+      fork do
+        require 'faraday/excon'
+        client = Elastic::Transport::Client.new
+        assert_equal(client.transport.connections.first.connection.adapter, Faraday::Adapter::Excon)
+      end
+    end if is_faraday_v2?
+
+    should 'use Async HTTP Faraday adapter' do
+      fork do
+        require 'async/http/faraday'
+        client = Elastic::Transport::Client.new
+        assert_equal(client.transport.connections.first.connection.adapter, Async::HTTP::Faraday::Adapter)
+      end
+    end if is_faraday_v2?
+
     should 'use HTTPClient Faraday adapter' do
       fork do
         if is_faraday_v2?
@@ -81,7 +97,7 @@ class Elastic::Transport::ClientAdaptersUnitTest < Minitest::Test
         end
 
         client = Elastic::Transport::Client.new
-        assert_equal(Faraday::Adapter::HTTPClient, client.transport.connections.first.connection.adapter)
+        assert_equal(client.transport.connections.first.connection.adapter, Faraday::Adapter::HTTPClient)
       end
     end
   end unless jruby?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: elastic-transport
 version: !ruby/object:Gem::Version
-  version: 8.3.6
+  version: 8.4.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -256,8 +256,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE
 - README.md
+- LICENSE
 files:
 - ".github/check_license_headers.rb"
 - ".github/license-header.txt"
@@ -338,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Low level Ruby client for Elastic services.
 test_files: