elastic-transport 8.4.0 → 8.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88698d9c25a84a6242bfb875623c2bca0bd9a0e5c40244272e88fe291b06a9e0
-  data.tar.gz: 90aff86e0a0f301908c888877d97a72ac926e9b5f7f48b23ad447813a729824d
+  metadata.gz: 5634ceac3d52fa6af5174e9aad5ecf2613018e4a9977114305a9f3a42ee25909
+  data.tar.gz: 92acaa8ac6c08475e3dc91aa1132e1a719060b0bab0c05c94b3feae92f9cb83f
 SHA512:
-  metadata.gz: 3a235c8813516864b3b661790c56c9eeb6c8ee8b44a208d70a3309faca0075e9b45f25890be47d56ed29b845a70c5d3f6cd45c617592543993a0c6d788eb7211
-  data.tar.gz: 9cd571ba906d3e841f63f8bf3ea018820d0d9e2eddb9171f01785b6787df5ed19fecbeb0b05e494428af8853d2040c78c32f25a370c612d55a4a69ed77798682
+  metadata.gz: 2cd0a8e98e8bf2cfa5964779042672f15ba4d968b0fadec444474dc2253584c9dc3cf5932ffb731415503a57719838e5aa05eec78e77e184fbc3eb762291c137
+  data.tar.gz: d7132ee663cd2984e5b34ea7827ff27010e69c66d6ad3dc2ca3571b6d4b516ab1004b7a45c7495e68e38a047defc66c947cd2c1a0a026086a3b718d6328dc1ed

data/.github/workflows/otel.yml

@@ -17,7 +17,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ['3.4', 'jruby-9.4']
-        es_version: ['8.17.0-SNAPSHOT']
+        es_version: ['9.2.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

data/.github/workflows/tests.yml

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

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 8.4.1
+
+- 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)
+
 ## 8.4.0
 
 - 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:
@@ -21,7 +26,7 @@ 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).
+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:

data/CONTRIBUTING.md

@@ -41,7 +41,9 @@ 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 also run Elasticsearch and Kibana locally with Docker with `start-local`:
+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
@@ -49,6 +51,15 @@ 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).
 
+## Faraday 1 tests
+
+You can run the tests for Faraday v1 with the following commands:
+
+```bash
+BUNDLE_GEMFILE=Gemfile-faraday1.gemfile bundle install
+BUNDLE_GEMFILE=Gemfile-faraday1.gemfile rake test:all
+```
+
 # Contributing
 
 The process for contributing is:

data/README.md

@@ -1,8 +1,7 @@
 # Elastic Transport
-[![8.1 tests](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml/badge.svg?branch=8.1)](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml)
 [![Run tests](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml)
 
-This gem provides a low-level Ruby client for connecting to an [Elastic](http://elastic.co) cluster. It powers both the [Elasticsearch client](https://github.com/elasticsearch/elasticsearch-ruby/) and the [Elastic Enterprise Search](https://github.com/elastic/enterprise-search-ruby/) client.
+This gem provides a low-level Ruby client for connecting to an [Elastic](http://elastic.co) cluster. It powers the [Elasticsearch client](https://github.com/elasticsearch/elasticsearch-ruby/) and other Elastic projects.
 
 In the simplest form, connect to Elasticsearch running on `http://localhost:9200` without any configuration:
 
@@ -14,9 +13,9 @@ response = client.perform_request('GET', '_cluster/health')
 # => #<Elastic::Transport::Transport::Response:0x007fc5d506ce38 @status=200, @body={ ... } >
 ```
 
-**Refer to [the official documentation on Elastic Transport](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html).**
+**Refer to [the official documentation on Elastic Transport](https://www.elastic.co/docs/reference/elasticsearch/clients/ruby/transport).**
 
-**Refer to [Advanced Configuration](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html) to read about more configuration options.**
+**Refer to [Advanced Configuration](https://www.elastic.co/docs/reference/elasticsearch/clients/ruby/advanced-config) to read about more configuration options.**
 
 ## Compatibility
 

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

@@ -195,7 +195,7 @@ module Elastic
         #
         def __log_response(method, path, params, body, url, response, json, took, duration)
           if logger
-            sanitized_url = url.to_s.gsub(/\/\/(.+):(.+)@/, '//' + '\1:' + SANITIZED_PASSWORD + '@')
+            sanitized_url = sanitize_url(url.to_s)
             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
@@ -379,11 +379,11 @@ module Elastic
         private
 
         USER_AGENT_STR = 'User-Agent'.freeze
-        USER_AGENT_REGEX = /user-?_?agent/
+        USER_AGENT_REGEX = /user-?_?agent/.freeze
         ACCEPT_ENCODING = 'Accept-Encoding'.freeze
         CONTENT_ENCODING = 'Content-Encoding'.freeze
         CONTENT_TYPE_STR = 'Content-Type'.freeze
-        CONTENT_TYPE_REGEX = /content-?_?type/
+        CONTENT_TYPE_REGEX = /content-?_?type/.freeze
         DEFAULT_CONTENT_TYPE = 'application/json'.freeze
         GZIP = 'gzip'.freeze
         GZIP_FIRST_TWO_BYTES = '1f8b'.freeze
@@ -472,9 +472,13 @@ 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', url)
+            ::OpenTelemetry::Trace.current_span&.set_attribute('url.full', sanitize_url(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/connections/connection.rb

@@ -155,7 +155,6 @@ module Elastic
             "<#{self.class.name} host: #{host} (#{dead? ? 'dead since ' + dead_since.to_s : 'alive'})>"
           end
         end
-
       end
     end
   end

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

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

data/lib/elastic/transport/transport/http/curb.rb

@@ -30,7 +30,7 @@ module Elastic
           # @return [Response]
           # @see    Transport::Base#perform_request
           #
-          def perform_request(method, path, params={}, body=nil, headers=nil, opts={})
+          def perform_request(method, path, params = {}, body = nil, headers = nil, opts = {})
             super do |connection, url|
               capture_otel_span_attributes(connection, url)
               connection.connection.url = connection.full_url(path, params)
@@ -51,7 +51,6 @@ module Elastic
                     connection.connection.headers = headers
                   end
                 end
-
               else raise ArgumentError, "Unsupported HTTP method: #{method}"
               end
 
@@ -73,7 +72,7 @@ module Elastic
           #
           # @return [Connections::Connection]
           #
-          def __build_connection(host, options={}, block=nil)
+          def __build_connection(host, options = {}, block = nil)
             client = ::Curl::Easy.new
 
             apply_headers(client, options)
@@ -87,7 +86,7 @@ module Elastic
 
             client.instance_eval(&block) if block
 
-            Connections::Connection.new :host => host, :connection => client
+            Connections::Connection.new(host: host, connection: client)
           end
 
           # Returns an array of implementation specific connection errors.

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

@@ -15,6 +15,8 @@
 # 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.4.0'.freeze
+    VERSION = '8.4.1'.freeze
   end
 end

data/lib/elastic/transport.rb

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

data/spec/elastic/transport/opentelemetry_spec.rb

@@ -25,8 +25,8 @@ if defined?(::OpenTelemetry)
     let(:span) { exporter.finished_spans[0] }
 
     let(:client) do
-      Elastic::Transport::Client.new(hosts: ELASTICSEARCH_HOSTS).tap do |_client|
-        allow(_client).to receive(:__build_connections)
+      Elastic::Transport::Client.new(hosts: ELASTICSEARCH_HOSTS).tap do |client|
+        allow(client).to receive(:__build_connections)
       end
     end
 
@@ -36,7 +36,8 @@ if defined?(::OpenTelemetry)
       let(:tracer_provider) do
         double('tracer_provider').tap do |tp|
           expect(tp).to receive(:tracer).with(
-            Elastic::Transport::OpenTelemetry::OTEL_TRACER_NAME, Elastic::Transport::VERSION
+            Elastic::Transport::OpenTelemetry::OTEL_TRACER_NAME,
+            Elastic::Transport::VERSION
           )
         end
       end
@@ -59,7 +60,7 @@ if defined?(::OpenTelemetry)
       it 'creates a span with path parameters' do
         client.perform_request(
           'POST', '/users/_create/abc', nil, { name: 'otel-test' }, nil,
-          defined_params: {'index' => 'users', 'id' => 'abc'}, endpoint: 'create'
+          defined_params: { 'index' => 'users', 'id' => 'abc' }, endpoint: 'create'
         )
 
         span = exporter.finished_spans.find { |s| s.name == 'create' }
@@ -96,7 +97,7 @@ if defined?(::OpenTelemetry)
 
     context 'when a request is instrumented' do
       let(:body) do
-        { query: { match: { password: { query: 'secret'} } } }
+        { query: { match: { password: { query: 'secret' } } } }
       end
 
       it 'creates a span and omits db.statement' do
@@ -214,9 +215,9 @@ if defined?(::OpenTelemetry)
 
         around(:example) do |ex|
           body_strategy = ENV[described_class::ENV_VARIABLE_BODY_STRATEGY]
-          ENV[described_class::ENV_VARIABLE_BODY_STRATEGY]  = 'omit'
+          ENV[described_class::ENV_VARIABLE_BODY_STRATEGY] = 'omit'
           ex.run
-          ENV[described_class::ENV_VARIABLE_BODY_STRATEGY] = body_strategy
+          ENV[described_class::ENV_VARIABLE_BODY_STRATEGY]= body_strategy
         end
 
         it 'does not include anything' do
@@ -308,11 +309,11 @@ if defined?(::OpenTelemetry)
           let(:key_patterns) { [/something/] }
 
           let(:body) do
-            { query: { match: { something: "test" } } }
+            { query: { match: { something: 'test' } } }
           end
 
           let(:expected_body) do
-            { query: { match: { something: "REDACTED" } } }
+            { query: { match: { something: 'REDACTED' } } }
           end
 
           it 'redacts sensitive values' do
@@ -320,6 +321,22 @@ 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: elastic-transport
 version: !ruby/object:Gem::Version
-  version: 8.4.0
+  version: 8.4.1
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 bindir: bin
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -256,8 +256,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 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.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Low level Ruby client for Elastic services.
 test_files: