https://github.com/elastic/elastic-transport-ruby

Transport classes and utilities shared among Ruby Elastic client libraries
https://github.com/elastic/elastic-transport-ruby

elastic http http-client ruby

Last synced: 10 months ago
JSON representation

Transport classes and utilities shared among Ruby Elastic client libraries

• Host: GitHub
• URL: https://github.com/elastic/elastic-transport-ruby
• Owner: elastic
• License: apache-2.0
• Created: 2021-06-07T10:33:09.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-02-18T15:50:12.000Z (12 months ago)
• Last Synced: 2025-03-28T13:11:08.806Z (10 months ago)
• Topics: elastic, http, http-client, ruby
• Language: Ruby
• Homepage:
• Size: 746 KB
• Stars: 5
• Watchers: 190
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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.

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

```ruby

require 'elastic/transport'

client = Elastic::Transport::Client.new

response = client.perform_request('GET', '_cluster/health')

# => #

```

**Refer to [the official documentation on Elastic Transport](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html).**

**Refer to [Advanced Configuration](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html) to read about more configuration options.**

## 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.

## Development and Community

See [CONTRIBUTING](./CONTRIBUTING.md).

## License

This software is licensed under the [Apache 2 license](./LICENSE).