elastic-transport 8.1.0.pre2 → 8.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '019bec0fce3232610f573b32a72456674018954609728aba574165f3e4b16393'
-  data.tar.gz: 9f5ef21b2823bccf5c6e22c47420bf543931b1b76cd3b7050272cababffe2929
+  metadata.gz: c45579654af5263b19d9ed8a814727d7d63fa3c4ecb3e1313adcffe6b5f9e185
+  data.tar.gz: 278b4e2bf242cf1acf9cea3f9bb297b45a5517c3f9f38921484913e337afa4c3
 SHA512:
-  metadata.gz: 623ad8af7121423ae67655c684293a14f41faffbf76368fc8b2b4b23ce0a48793d238b209d3f8867808a8567b496d6186c8e700be9371d59839154f460f52eb3
-  data.tar.gz: 7cdbcbcb8ab41e11a1a3acd5de8b25520b10823e2706cc8d432fb7057d06181cb0730272289614b34302182d925b82d31a422a0a664c461051db34ce81c3939d
+  metadata.gz: '078d4316c2ea7222c02905522389c47494c049a35b0b924d76afeeb340517d3f85fc6824294870dc7399884581233c1564424cae33f6381d21476a4f39758b91'
+  data.tar.gz: bd074dd0d1eeca808efe02e48bfc40232d12b7923e077352e1dc72749e030a85c9b16112d836506fce7cef076dfedd7d3d5f44659598b68ebb7fc00bf68f4a83

data/.github/workflows/tests.yml

@@ -1,22 +1,20 @@
-name: main tests
+name: 8.1 tests
 on:
   push:
     branches:
-      - main
+      - 8.1
   pull_request:
     branches:
-      - main
+      - 8.1
 jobs:
-  test:
-    name: 'Main tests'
+  test-ruby:
     env:
       TEST_ES_SERVER: http://localhost:9250
       PORT: 9250
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '3.0', '3.1', 'jruby-9.3' ]
-        es_version: ['8.2-SNAPSHOT', '8.3-SNAPSHOT', '8.4-SNAPSHOT']
+        ruby: [ '2.7', '3.0', '3.1', 'jruby-9.3', 'jruby-9.4' ]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -28,7 +26,7 @@ jobs:
         sudo sysctl -w vm.max_map_count=262144
     - uses: elastic/elastic-github-actions/elasticsearch@master
       with:
-        stack-version: ${{ matrix.es_version }}
+        stack-version: 8.9-SNAPSHOT
         security-enabled: false
     - uses: ruby/setup-ruby@v1
       with:
@@ -45,42 +43,4 @@ jobs:
       run: bundle exec rake test:spec
     - name: integration tests
       run: bundle exec rake test:integration
-  test-faraday1:
-    name: 'Test Faraday 1'
-    env:
-      TEST_ES_SERVER: http://localhost:9250
-      PORT: 9250
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.7', '3.0', '3.1', 'jruby-9.3' ]
-        es_version: ['8.3.0-SNAPSHOT']
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Increase system limits
-      run: |
-        sudo swapoff -a
-        sudo sysctl -w vm.swappiness=1
-        sudo sysctl -w fs.file-max=262144
-        sudo sysctl -w vm.max_map_count=262144
-    - uses: elastic/elastic-github-actions/elasticsearch@master
-      with:
-        stack-version: ${{ matrix.es_version }}
-        security-enabled: false
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Build and test with Rake
-      run: |
-        sudo apt-get update
-        sudo apt-get install libcurl4-openssl-dev
-        ruby -v
-        gem install bundler
-        BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle install
-    - name: faraday1 unit tests
-      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:unit
-    - name: specs
-      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:spec
-    - name: integration tests
-      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:integration
+

data/.gitignore

@@ -5,7 +5,7 @@
 .bundle
 .config
 .yardoc
-Gemfile*.lock
+Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,14 +1,18 @@
-## 8.1.0.pre2
+## 8.1.1
 
-Updates Faraday's adapter detection code.
+Backports the following updates from 8.2:
 
-## 8.1.0.pre1
+- Refactors `apply_headers` in base and manticore implementation: When passing in an object to the initializer, `apply_headers` would mutate this object and in certain conditions, this would raise `RuntimeError` in JRuby 9.3 and `ConcurrencyError` in JRuby 9.4. This update clones the options object instead.
+- Fixes [issue #44](https://github.com/elastic/elastic-transport-ruby/issues/44), raising `Elastic::Transport::Transport::Error` instead of `Faraday::ConnectionFailed` (or any other Faraday error class) when a host is unreachable.
+- Fixes parsing ipv4 addresses like `inet[/127.0.0.1:9200]` in sniffer, [issue #48](https://github.com/elastic/elastic-transport-ruby/issues/48). [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/49) by [@robbat2](https://github.com/robbat2), thank you!
+
+## 8.1.0
 
 Adds support for Faraday version 2. From [Faraday's Upgrading guide](https://github.com/lostisland/faraday/blob/main/UPGRADING.md#faraday-20), the main change is the adapters have moved:
 
 > With this release, we've officially moved all adapters, except for the net_http one, out of Faraday. What that means, is that they won't be available out-of-the-box anymore, and you'll instead need to add them to your Gemfile.
 > If you just use the default net_http adapter, then you don't need to do anything!
-> Otherwise, add the corresponding adapter gem to your Gemfile (e.g. faraday-net_http_persistent). Then, simply require them after you require faraday. 
+> Otherwise, add the corresponding adapter gem to your Gemfile (e.g. faraday-net_http_persistent). Then, simply require them after you require faraday.
 
 We're now supporting Faraday v2 and Faraday v1. The adapters were removed as development dependency in the gemspec and added to the Gemfile. A new file `Gemfile-faraday1.gemfile` was added to run tests with version `1.x` of Faraday too.
 

data/Gemfile

@@ -20,11 +20,15 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch-transport.gemspec
 gemspec
 
+if File.exist? File.expand_path('../elasticsearch-api/elasticsearch-api.gemspec', __dir__)
+  gem 'elasticsearch-api', path: File.expand_path('../elasticsearch-api', __dir__), require: false
+end
+
+if File.exist? File.expand_path('../elasticsearch/elasticsearch.gemspec', __dir__)
+  gem 'elasticsearch', path: File.expand_path('../elasticsearch', __dir__), require: false
+end
+
 group :development, :test do
-  gem 'faraday-httpclient'
-  gem 'faraday-net_http_persistent'
-  gem 'faraday-patron' unless defined? JRUBY_VERSION
-  gem 'faraday-typhoeus'
   gem 'rspec'
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'

data/README.md

@@ -3,62 +3,7 @@
 
 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.
 
-## Compatibility
-
-This gem is compatible with maintained Ruby versions. See [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). We don't provide support to versions which have reached their end of life.
-
-## Installation
-
-Install the package from [Rubygems](https://rubygems.org):
-
-    gem install elastic-transport
-
-To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
-
-    gem 'elastic-transport', git: 'git://github.com/elastic/elastic-transport-ruby.git'
-
-or install it from a source code checkout:
-
-```bash
-git clone https://github.com/elastic/elastic-transport-ruby.git
-cd elastic-transport-ruby
-bundle install
-rake install
-```
-
-## Description
-
-It handles connecting to multiple nodes in the cluster, rotating across connections, logging and tracing requests and responses, maintaining failed connections, discovering nodes in the cluster, and provides an abstraction for
-data serialization and transport.
-
-It does not handle calling the Elasticsearch API; see the [`elasticsearch`](https://github.com/elasticsearch/elasticsearch-ruby) library for that.
-
-Features overview:
-
-* Pluggable logging and tracing
-* Pluggable connection selection strategies (round-robin, random, custom)
-* Pluggable transport implementation, customizable and extendable
-* Pluggable serializer implementation
-* Request retries and dead connections handling
-* Node reloading (based on cluster state) on errors or on demand
-
-For optimal performance, use a HTTP library which supports persistent ("keep-alive") connections, such as [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus).
-Just require the library (`require 'patron'`) in your code, and it will be automatically used.
-
-Currently these libraries will be automatically detected and used:
-- [Patron](https://github.com/toland/patron)
-- [Typhoeus](https://github.com/typhoeus/typhoeus)
-- [HTTPClient](https://rubygems.org/gems/httpclient)
-- [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent)
-
-**Note on [Typhoeus](https://github.com/typhoeus/typhoeus)**: You need to use v1.4.0 or up since older versions are not compatible with Faraday 1.0.
-
-For detailed information, see example configurations [below](#transport-implementations).
-
-## Example Usage
-
-In the simplest form, connect to Elasticsearch running on <http://localhost:9200>
-without any configuration:
+In the simplest form, connect to Elasticsearch running on `http://localhost:9200` without any configuration:
 
 ```ruby
 require 'elastic/transport'
@@ -68,442 +13,13 @@ response = client.perform_request('GET', '_cluster/health')
 # => #<Elastic::Transport::Transport::Response:0x007fc5d506ce38 @status=200, @body={ ... } >
 ```
 
-Full documentation is available at <http://rubydoc.info/gems/elastic-transport>.
-
-## Configuration
-
-* [Setting Hosts](#setting-hosts)
-* [Default port](#default-port)
-* [Authentication](#authentication)
-* [Logging](#logging)
-* [Custom HTTP Headers](#custom-http-headers)
-* [Setting Timeouts](#setting-timeouts)
-* [Randomizing Hosts](#randomizing-hosts)
-* [Retrying on Failures](#retrying-on-failures)
-* [Reloading Hosts](#reloading-hosts)
-* [Connection Selector](#connection-selector)
-* [Transport Implementations](#transport-implementations)
-* [Serializer implementations](#serializer-implementations)
-* [Exception Handling](#exception-handling)
-* [Development and Community](#development-and-community)
-
-The client supports many configurations options for setting up and managing connections,
-configuring logging, customizing the transport library, etc.
-
-### Setting Hosts
-
-This behaviour is going to be simplified, see [#5](https://github.com/elastic/elastic-transport-ruby/issues/5). To connect to a specific Elasticsearch host:
-
-```ruby
-Elastic::Transport::Client.new(host: 'search.myserver.com')
-```
-
-To connect to a host with specific port:
-
-```ruby
-Elastic::Transport::Client.new(host: 'myhost:8080')
-```
-
-To connect to multiple hosts:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['myhost1', 'myhost2'])
-```
-
-Instead of Strings, you can pass host information as an array of Hashes:
-
-```ruby
-Elastic::Transport::Client.new(hosts: [{ host: 'myhost1', port: 8080 }, { host: 'myhost2', port: 8080 }])
-```
-
-**NOTE:** When specifying multiple hosts, you probably want to enable the `retry_on_failure` or `retry_on_status` options to perform a failed request on another node (see the _Retrying on Failures_ chapter).
-
-Common URL parts -- scheme, HTTP authentication credentials, URL prefixes, etc -- are handled automatically:
-```ruby
-Elastic::Transport::Client.new(url: 'https://username:password@api.server.org:4430/search')
-```
-
-You can pass multiple URLs separated by a comma:
-```ruby
-Elastic::Transport::Client.new(urls: 'http://localhost:9200,http://localhost:9201')
-```
-
-Another way to configure the URL(s) is to export the `ELASTICSEARCH_URL` variable.
-
-The client will automatically round-robin across the hosts (unless you select or implement a different [connection selector](#connection-selector)).
-
-### Default port
-
-The default port is `9200`. Please specify a port for your host(s) if they differ from this default. Please see below for an exception to this when connecting using an Elastic Cloud ID.
-
-### Authentication
-
-You can pass the authentication credentials, scheme and port in the host configuration hash:
-
-```ruby
-Elastic::Transport::Client.new(
-  hosts: [
-    {
-      host: 'my-protected-host',
-      port: '443',
-      user: 'USERNAME',
-      password: 'PASSWORD',
-      scheme: 'https'
-    }
-  ]
-)
-```
-Or use the common URL format:
-
-```ruby
-Elastic::Transport::Client.new(url: 'https://username:password@example.com:9200')
-```
-
-To pass a custom certificate for SSL peer verification to Faraday-based clients, use the `transport_options` option:
-
-```ruby
-Elastic::Transport::Client.new(
-  url: 'https://username:password@example.com:9200',
-  transport_options: { ssl: { ca_file: '/path/to/cacert.pem' } }
-)
-```
-
-### Logging
-
-To log requests and responses to standard output with the default logger (an instance of Ruby's {::Logger} class), set the `log` argument to true:
-
-```ruby
-Elastic::Transport::Client.new(log: true)
-```
-
-You can also use [ecs-logging](https://github.com/elastic/ecs-logging-ruby). `ecs-logging` is a set of libraries that allows you to transform your application logs to structured logs that comply with the [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/current/ecs-reference.html):
-
-```ruby
-logger = EcsLogging::Logger.new($stdout)
-Elastic::Transport::Client.new(logger: logger)
-```
-
-To trace requests and responses in the _Curl_ format, set the `trace` argument:
-
-```ruby
-Elastic::Transport::Client.new(trace: true)
-```
-
-You can customize the default logger or tracer:
-
-```ruby
-client.transport.logger.formatter = proc { |s, d, p, m| "#{s}: #{m}\n" }
-client.transport.logger.level = Logger::INFO
-```
-
-Or, you can use a custom `::Logger` instance:
-
-```ruby
-Elastic::Transport::Client.new(logger: Logger.new(STDERR))
-```
-
-You can pass the client any conforming logger implementation:
-
-```ruby
-require 'logging' # https://github.com/TwP/logging/
-
-log = Logging.logger['elasticsearch']
-log.add_appenders Logging.appenders.stdout
-log.level = :info
-
-client = Elastic::Transport::Client.new(logger: log)
-```
-
-### Custom HTTP Headers
-
-You can set a custom HTTP header on the client's initializer:
-
-```ruby
-client = Elastic::Transport::Client.new(
-  transport_options: {
-    headers:
-      {user_agent: "My App"}
-  }
-)
-```
-
-You can also pass in `headers` as a parameter to any of the API Endpoints to set custom headers for the request:
-
-```ruby
-client.search(index: 'myindex', q: 'title:test', headers: { user_agent: "My App" })
-```
+**Refer to [the official documentation on Elastic Transport](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html).**
 
-### Setting Timeouts
+**Refer to [Advanced Configuration](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html) to read about more configuration options.**
 
-For many operations in Elasticsearch, the default timeouts of HTTP libraries are too low.
-To increase the timeout, you can use the `request_timeout` parameter:
-
-```ruby
-Elastic::Transport::Client.new(request_timeout: 5 * 60)
-```
-
-You can also use the `transport_options` argument documented below.
-
-### Randomizing Hosts
-
-If you pass multiple hosts to the client, it rotates across them in a round-robin fashion, by default.
-When the same client would be running in multiple processes (eg. in a Ruby web server such as Thin),
-it might keep connecting to the same nodes "at once". To prevent this, you can randomize the hosts
-collection on initialization and reloading:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], randomize_hosts: true)
-```
-
-### Retrying on Failures
-
-When the client is initialized with multiple hosts, it makes sense to retry a failed request
-on a different host:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_failure: true)
-```
-
-By default, the client will retry the request 3 times. You can specify how many times to retry before it raises an exception by passing a number to `retry_on_failure`:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_failure: 5)
-```
-
-You can also use `retry_on_status` to retry when specific status codes are returned:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_status: [502, 503])
-```
-
-These two parameters can also be used together:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_status: [502, 503], retry_on_failure: 10)
-```
-
-### Reloading Hosts
-
-Elasticsearch by default dynamically discovers new nodes in the cluster. You can leverage this in the client, and periodically check for new nodes to spread the load.
-
-To retrieve and use the information from the [_Nodes Info API_](http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html) on every 10,000th request:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_connections: true)
-```
-
-You can pass a specific number of requests after which the reloading should be performed:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_connections: 1_000)
-```
-
-To reload connections on failures, use:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_on_failure: true)
-```
-
-The reloading will timeout if not finished under 1 second by default. To change the setting:
-
-```ruby
-Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], sniffer_timeout: 3)
-```
-
-**NOTE:** When using reloading hosts ("sniffing") together with authentication, just pass the scheme, user and password with the host info -- or, for more clarity, in the `http` options:
-
-```ruby
-Elastic::Transport::Client.new(
-  host: 'localhost:9200',
-  http: { scheme: 'https', user: 'U', password: 'P' },
-  reload_connections: true,
-  reload_on_failure: true
-)
-```
-
-### Connection Selector
-
-By default, the client will rotate the connections in a round-robin fashion, using the {Elastic::Transport::Transport::Connections::Selector::RoundRobin} strategy.
-
-You can implement your own strategy to customize the behaviour. For example, let's have a "rack aware" strategy, which will prefer the nodes with a specific [attribute](https://github.com/elasticsearch/elasticsearch/blob/1.0/config/elasticsearch.yml#L81-L85). Only when these would be unavailable, the strategy will use the other nodes:
-
-```ruby
-class RackIdSelector
-  include Elastic::Transport::Transport::Connections::Selector::Base
-
-  def select(options={})
-    connections.select do |c|
-      # Try selecting the nodes with a `rack_id:x1` attribute first
-      c.host[:attributes] && c.host[:attributes][:rack_id] == 'x1'
-    end.sample || connections.to_a.sample
-  end
-end
-
-Elastic::Transport::Client.new hosts: ['x1.search.org', 'x2.search.org'], selector_class: RackIdSelector
-```
-
-### Transport Implementations
-
-By default, the client will use the [_Faraday_](https://rubygems.org/gems/faraday) HTTP library as a transport implementation.
-
-It will auto-detect and use an _adapter_ for _Faraday_ based on gems loaded in your code, preferring HTTP clients with support for persistent connections.
-
-To use the [_Patron_](https://github.com/toland/patron) HTTP, for example, just require it:
-
-```ruby
-require 'patron'
-```
-
-Then, create a new client, and the _Patron_  gem will be used as the "driver":
-
-```ruby
-client = Elastic::Transport::Client.new
-
-client.transport.connections.first.connection.builder.adapter
-# => Faraday::Adapter::Patron
-
-10.times do
-  client.nodes.stats(metric: 'http')['nodes'].values.each do |n|
-    puts "#{n['name']} : #{n['http']['total_opened']}"
-  end
-end
-
-# => Stiletoo : 24
-# => Stiletoo : 24
-# => Stiletoo : 24
-# => ...
-```
-
-To use a specific adapter for _Faraday_, pass it as the `adapter` argument:
-
-```ruby
-client = Elastic::Transport::Client.new(adapter: :net_http_persistent)
-
-client.transport.connections.first.connection.builder.handlers
-# => [Faraday::Adapter::NetHttpPersistent]
-```
-
-To pass options to the
-[`Faraday::Connection`](https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb)
-constructor, use the `transport_options` key:
-
-```ruby
-client = Elastic::Transport::Client.new(
-  transport_options: {
-    request: { open_timeout: 1 },
-    headers: { user_agent:   'MyApp' },
-    params:  { :format => 'yaml' },
-    ssl:     { verify: false }
-  }
-)
-```
-
-To configure the _Faraday_ instance directly, use a block:
-
-```ruby
-require 'patron'
-
-client = Elastic::Transport::Client.new(host: 'localhost', port: '9200') do |f|
-  f.response :logger
-  f.adapter  :patron
-end
-```
-
-You can use any standard Faraday middleware and plugins in the configuration block. You can also initialize the transport class yourself, and pass it to the client constructor as the `transport` argument:
-
-```ruby
-require 'patron'
-
-transport_configuration = lambda do |f|
-  f.response :logger
-  f.adapter  :patron
-end
-
-transport = Elastic::Transport::Transport::HTTP::Faraday.new(
-  hosts: [ { host: 'localhost', port: '9200' } ],
-  &transport_configuration
-)
-
-# Pass the transport to the client
-#
-client = Elastic::Transport::Client.new(transport: transport)
-```
-
-Instead of passing the transport to the constructor, you can inject it at run time:
-
-```ruby
-# Set up the transport
-#
-faraday_configuration = lambda do |f|
-  f.instance_variable_set :@ssl, { verify: false }
-  f.adapter :excon
-end
-
-faraday_client = Elastic::Transport::Transport::HTTP::Faraday.new(
-  hosts: [
-    {
-      host: 'my-protected-host',
-      port: '443',
-      user: 'USERNAME',
-      password: 'PASSWORD',
-      scheme: 'https'
-    }
-  ],
-  &faraday_configuration
-)
-
-# Create a default client
-#
-client = Elastic::Transport::Client.new
-
-# Inject the transport to the client
-#
-client.transport = faraday_client
-```
-
-You can also use a bundled [_Curb_](https://rubygems.org/gems/curb) based transport implementation:
-
-```ruby
-require 'curb'
-require 'elastic/transport/transport/http/curb'
-
-client = Elastic::Transport::Client.new(transport_class: Elastic::Transport::Transport::HTTP::Curb)
-
-client.transport.connections.first.connection
-# => #<Curl::Easy http://localhost:9200/>
-```
-
-It's possible to customize the _Curb_ instance by passing a block to the constructor as well (in this case, as an inline block):
-
-```ruby
-transport = Elastic::Transport::Transport::HTTP::Curb.new(
-  hosts: [ { host: 'localhost', port: '9200' } ],
-  & lambda { |c| c.verbose = true }
-)
-
-client = Elastic::Transport::Client.new(transport: transport)
-```
-
-You can write your own transport implementation by including the `Elastic::Transport::Transport::Base` module, implementing the required contract, and passing it to the client as the `transport_class` parameter -- or injecting it directly.
-
-### Serializer Implementations
-
-By default, the [MultiJSON](http://rubygems.org/gems/multi_json) library is used as the serializer implementation, and it will pick up the "right" adapter based on gems available.
-
-The serialization component is pluggable, though, so you can write your own by including the `Elastic::Transport::Transport::Serializer::Base` module, implementing the required contract, and passing it to the client as the `serializer_class` or `serializer` parameter.
-
-### Exception Handling
-
-The library defines a [number of exception classes](https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb) for various client and server errors, as well as unsuccessful HTTP responses,
-making it possible to `rescue` specific exceptions with desired granularity.
-
-The highest-level exception is `Elastic::Transport::Transport::Error` and will be raised for any generic client *or* server errors.
-
-`Elastic::Transport::Transport::ServerError` will be raised for server errors only.
-
-As an example for response-specific errors, a `404` response status will raise an `Elastic::Transport::Transport::Errors::NotFound` exception.
+## Compatibility
 
-Finally, `Elastic::Transport::Transport::SnifferTimeoutError` will be raised when connection reloading ("sniffing") times out.
+This gem is compatible with maintained Ruby versions. See [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). We don't provide support to versions which have reached their end of life.
 
 ## Development and Community
 
@@ -511,21 +27,6 @@ For local development, clone the repository and run `bundle install`. See `rake
 
 Bug fixes and features must be covered by unit tests.
 
-Github's pull requests and issues are used to communicate, send bug reports and code contributions.
-
-## The Architecture
-
-* `Elastic::Transport::Client` is composed of `Elastic::Transport::Transport`.
-* `Elastic::Transport::Transport` is composed of `Elastic::Transport::Transport::Connections`, and an instance of logger, tracer, serializer and sniffer.
-* Logger and tracer can be any object conforming to the Ruby logging interface, ie. an instance of [`Logger`](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html), [_log4r_](https://rubygems.org/gems/log4r), [_logging_](https://github.com/TwP/logging/), etc.
-* The `Elastic::Transport::Transport::Serializer::Base` implementations handles converting data for Elasticsearch (eg. to JSON). You can implement your own serializer.
-* `Elastic::Transport::Transport::Sniffer` allows discovering nodes in the cluster and use them as connections.
-* `Elastic::Transport::Transport::Connections::Collection` is composed of `Elastic::Transport::Transport::Connections::Connection` instances and a selector instance.
-* `Elastic::Transport::Transport::Connections::Connection` contains the connection attributes such as hostname and port, as well as the concrete persistent "session" connected to a specific node.
-* The `Elastic::Transport::Transport::Connections::Selector::Base` implementations allows you to choose connections from the pool, eg. in a round-robin or random fashion. You can implement your own selector strategy.
-
-## Development
-
 A rake task is included to launch an Elasticsearch cluster with Docker. You need to install docker on your system and then run:
 ```bash
 $ rake docker:start[VERSION]
@@ -547,6 +48,8 @@ time rake test:integration
 
 Use `COVERAGE=true` before running a test task to check coverage with Simplecov.
 
+Github's pull requests and issues are used to communicate, send bug reports and code contributions.
+
 ## License
 
 This software is licensed under the [Apache 2 license](./LICENSE).