Docs
  • Guides
  • APIs (opens in a new tab)
  • Products
    Elasticsearch Observability Security Elastic Cloud
  • Reference
  • Troubleshoot
  • Release notes
  1. Docs /
  2. Reference /
  3. Elasticsearch /
  4. Clients /
  5. Ruby

Configuration

This page contains information about how to configure the Ruby client tailored to your needs. Almost every aspect of the client is configurable. However, in most cases you only need to set a couple of parameters.

  • Basic configuration
  • Advanced configuration
Previous
Connecting
Next
Basic configuration
  • View as Markdown
  • Report a docs issue
  • Edit this page
  • Learn how to contribute
Get started free
  • 14-day free trial
  • All features included
  • No setup required
Section
Reference
Docs Guides APIs (opens in a new tab)
Products
Elasticsearch Observability Security Elastic Cloud
Reference Troubleshoot Release notes
Version
Reference Elasticsearch Clients
  • Ruby
    • Getting started
    • Installation
    • Connecting
    • Configuration
      • Basic configuration
      • Advanced configuration
    • Integrations
      • Transport
      • Elasticsearch API
      • Using OpenTelemetry
      • Elastic Common Schema (ECS)
      • ActiveModel / ActiveRecord
      • Ruby On Rails
      • Persistence
      • Elasticsearch DSL
    • Examples
    • Client helpers
      • Bulk and Scroll helpers
      • ES|QL
    • Troubleshoot
Elastic logo
  • Trademarks
  • Terms of Use
  • Privacy
  • Sitemap

© 2026 Elasticsearch B.V. All Rights Reserved.

This content is available in different formats for convenience only. All original licensing terms apply.

Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries. Apache, Apache Lucene, Apache Hadoop, Hadoop, HDFS and the yellow elephant logo are trademarks of the Apache Software Foundation in the United States and/or other countries.