The elastic-transport library provides a low-level Ruby client for connecting to an Elasticsearch cluster. It currently powers the Elasticsearch Ruby and the Enterprise Search Ruby clients.

When available, 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 or Enterprise Search APIs.

This library uses Faraday by default as the HTTP transport implementation. We test it with Faraday versions 1.x and 2.x.

For optimal performance, use a HTTP library which supports persistent ("keep-alive") connections, such as patron or Typhoeus. Require the library (require 'patron') in your code for Faraday 1.x or the adapter (require 'faraday/patron') for Faraday 2.x, and it will be automatically used.

Currently these libraries are supported:

You can customize Faraday and implement your own HTTP transport. For detailed information, see the example configurations and more information below.

Features overview:

Refer to Advanced Configuration to read about more configuration options.

Installationedit

Install the package from Rubygems:

gem install elastic-transport

To use an unreleased version, either add it to your Gemfile for Bundler:

gem 'elastic-transport', git: 'git@github.com:elastic/elastic-transport-ruby.git'

or install it from a source code checkout:

git clone https://github.com/elastic/elastic-transport-ruby.git
cd elastic-transport
bundle install
rake install

Example usageedit

In the simplest form, connect to Elasticsearch running on http://localhost:9200 without any configuration:

require 'elastic/transport'

client = Elastic::Transport::Client.new
response = client.perform_request('GET', '_cluster/health')
# => #<Elastic::Transport::Transport::Response:0x007fc5d506ce38 @status=200, @body={ ... } >

Documentation is included as RDoc annotations in the source code and available online at RubyDoc.

Transport implementationsedit

By default, the client uses the Faraday HTTP library as a transport implementation.

The Client auto-detects and uses an adapter for Faraday based on gems loaded in your code, preferring HTTP clients with support for persistent connections. Faraday 2 changed the way adapters are used (read more here). If you’re using Faraday 1.x, you can require the HTTP library. To use the Patron HTTP, for example, require it:

To use the Patron HTTP, for example, require it:

require 'patron'

If you’re using Faraday 2.x, you need to add the corresponding adapter gem to your Gemfile and require it after you require faraday:

# Gemfile
gem 'faraday-patron'

# Code
require 'faraday'
require 'faraday/patron'

Then, create a new client, and the Patron gem will be used as the "driver":

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:

client = Elastic::Client.new(adapter: :net_http_persistent)

client.transport.connections.first.connection.builder.handlers
# => [Faraday::Adapter::NetHttpPersistent]

If you see this error:

Faraday::Error: :net_http_persistent is not registered on Faraday::Adapter

When you’re using Faraday 2, you need to require the adapter before instantiating the client:

> client = Elasticsearch::Client.new(adapter: :net_http_persistent)
Faraday::Error: :net_http_persistent is not registered on Faraday::Adapter
> require 'faraday/net_http_persistent'
=> true
> client = Elasticsearch::Client.new(adapter: :net_http_persistent)
=> #<Elasticsearch::Client:0x00007eff2e7728e0

When using the Elasticsearch or Enterprise Search clients, you can pass the adapter parameter when initializing the clients.

To pass options to the Faraday::Connection constructor, use the transport_options key:

client = Elastic::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:

require 'patron'

client = Elastic::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. The Elasticsearch and Enterprise Search clients accept :transport as parameter when initializing a client. So you can pass in a transport you’ve initialized with the following options:

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::Client.new(transport: transport)

Instead of passing the transport to the constructor, you can inject it at run time:

# 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::Client.new

# Inject the transport to the client
#
client.transport = faraday_client

You can also use a bundled Curb based transport implementation:

require 'curb'
require 'elastic/transport/transport/http/curb'

client = Elastic::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):

transport = Elastic::Transport::Transport::HTTP::Curb.new(
  hosts: [ { host: 'localhost', port: '9200' } ],
  & lambda { |c| c.verbose = true }
)

client = Elastic::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 by injecting it directly.

Transport architectureedit