Troubleshooting

The client provides several options for logging that can help when things go wrong. Check out the extensive documentation on Logging.

If you are having trouble sending a request to Elasticsearch with the client, we suggest enabling tracing on the client and testing the cURL command that appears in your terminal:

client = Elasticsearch::Client.new(trace: true)
client.info
curl -X GET -H 'x-elastic-client-meta: es=8.9.0,rb=3.2.2,t=8.2.1,fd=2.7.4,nh=0.3.2, User-Agent: elastic-t
ransport-ruby/8.2.1 (RUBY_VERSION: 3.2.2; linux x86_64; Faraday v2.7.4), Content-Type: application/json' 'http://localhost:9200//?pretty'

Testing the cURL command can help find out if there’s a connection issue or if the issue is in the client code.

When working with multiple hosts, you might want to enable the retry_on_failure or retry_on_status options to perform a failed request on another node (refer to Retrying on Failures).

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.

If you see a message like:

:adapter is not registered on Faraday::Adapter (Faraday::Error)

Then you probably need to include the adapter library in your Gemfile and require it. You might get this error when migrating from Faraday v1 to Faraday v2. The main change when using Faraday v2 is all adapters, except for the default net_http one, have been moved out into separate gems. This means if you’re not using the default adapter and you migrate to Faraday v2, you’ll need to add the adapter gems to your Gemfile.

These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based:

# HTTPCLient
gem 'faraday-httpclient'

# NetHTTPPersistent
gem 'faraday-net_http_persistent'

# Patron
gem 'faraday-patron'

# Typhoeus
gem 'faraday-typhoeus'

Things should work fine if you migrate to Faraday 2 as long as you include the adapter (unless you’re using the default one net-http), but worst case scenario, you can always lock the version of Faraday in your project to 1.x: gem 'faraday', '~> 1'

Be aware if migrating to Faraday v2 that it requires at least Ruby 2.6, unlike Faraday v1 which requires 2.4.

If you need more help, you can hop on our Elastic community forums and get answers from the experts in the community, including people from Elastic.

If you find a bug, have feedback, or find any other issue using the client, please submit an issue on GitHub.