elastic-transport 8.1.0 → 8.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/tests.yml +7 -47
- data/.gitignore +1 -1
- data/CHANGELOG.md +9 -1
- data/Gemfile +8 -4
- data/README.md +7 -518
- data/Rakefile +1 -39
- data/elastic-transport.gemspec +8 -5
- data/lib/elastic/transport/client.rb +10 -12
- data/lib/elastic/transport/meta_header.rb +8 -8
- data/lib/elastic/transport/transport/base.rb +5 -3
- data/lib/elastic/transport/transport/http/curb.rb +25 -28
- data/lib/elastic/transport/transport/http/manticore.rb +1 -1
- data/lib/elastic/transport/transport/response.rb +3 -2
- data/lib/elastic/transport/transport/sniffer.rb +3 -1
- data/lib/elastic/transport/version.rb +1 -1
- data/spec/elastic/transport/base_spec.rb +24 -27
- data/spec/elastic/transport/client_spec.rb +7 -14
- data/spec/elastic/transport/meta_header_spec.rb +2 -2
- data/spec/elastic/transport/sniffer_spec.rb +18 -0
- data/spec/spec_helper.rb +0 -4
- data/test/integration/jruby_test.rb +1 -1
- data/test/integration/transport_test.rb +40 -86
- data/test/test_helper.rb +5 -9
- data/test/unit/transport_base_test.rb +7 -8
- data/test/unit/transport_curb_test.rb +3 -2
- metadata +70 -17
- data/Gemfile-faraday1.gemfile +0 -39
- data/test/unit/adapters_test.rb +0 -88
data/README.md
CHANGED
@@ -3,63 +3,7 @@
|
|
3
3
|
|
4
4
|
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.
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
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.
|
9
|
-
|
10
|
-
## Installation
|
11
|
-
|
12
|
-
Install the package from [Rubygems](https://rubygems.org):
|
13
|
-
|
14
|
-
gem install elastic-transport
|
15
|
-
|
16
|
-
To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
|
17
|
-
|
18
|
-
gem 'elastic-transport', git: 'git://github.com/elastic/elastic-transport-ruby.git'
|
19
|
-
|
20
|
-
or install it from a source code checkout:
|
21
|
-
|
22
|
-
```bash
|
23
|
-
git clone https://github.com/elastic/elastic-transport-ruby.git
|
24
|
-
cd elastic-transport-ruby
|
25
|
-
bundle install
|
26
|
-
rake install
|
27
|
-
```
|
28
|
-
|
29
|
-
## Description
|
30
|
-
|
31
|
-
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
|
32
|
-
data serialization and transport.
|
33
|
-
|
34
|
-
It does not handle calling the Elasticsearch API; see the [`elasticsearch`](https://github.com/elasticsearch/elasticsearch-ruby) library for that.
|
35
|
-
|
36
|
-
Features overview:
|
37
|
-
|
38
|
-
* Pluggable logging and tracing
|
39
|
-
* Pluggable connection selection strategies (round-robin, random, custom)
|
40
|
-
* Pluggable transport implementation, customizable and extendable
|
41
|
-
* Pluggable serializer implementation
|
42
|
-
* Request retries and dead connections handling
|
43
|
-
* Node reloading (based on cluster state) on errors or on demand
|
44
|
-
|
45
|
-
This library uses [Faraday](https://github.com/lostisland/faraday) by default as the HTTP transport implementation. We test it it with Faraday versions 1.x and Faraday 2.x.
|
46
|
-
|
47
|
-
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).
|
48
|
-
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.
|
49
|
-
|
50
|
-
Currently these libraries are supported:
|
51
|
-
- [Patron](https://github.com/toland/patron)
|
52
|
-
- [Typhoeus](https://github.com/typhoeus/typhoeus)
|
53
|
-
- [HTTPClient](https://rubygems.org/gems/httpclient)
|
54
|
-
- [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent)
|
55
|
-
|
56
|
-
**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.
|
57
|
-
|
58
|
-
You can customize Faraday and implement your own HTTP transport. For detailed information, see the example configurations and more information [below](#transport-implementations).
|
59
|
-
|
60
|
-
## Example Usage
|
61
|
-
|
62
|
-
In the simplest form, connect to Elasticsearch running on <http://localhost:9200> without any configuration:
|
6
|
+
In the simplest form, connect to Elasticsearch running on `http://localhost:9200` without any configuration:
|
63
7
|
|
64
8
|
```ruby
|
65
9
|
require 'elastic/transport'
|
@@ -69,455 +13,13 @@ response = client.perform_request('GET', '_cluster/health')
|
|
69
13
|
# => #<Elastic::Transport::Transport::Response:0x007fc5d506ce38 @status=200, @body={ ... } >
|
70
14
|
```
|
71
15
|
|
72
|
-
|
73
|
-
|
74
|
-
## Configuration
|
75
|
-
|
76
|
-
* [Setting Hosts](#setting-hosts)
|
77
|
-
* [Default port](#default-port)
|
78
|
-
* [Authentication](#authentication)
|
79
|
-
* [Logging](#logging)
|
80
|
-
* [Custom HTTP Headers](#custom-http-headers)
|
81
|
-
* [Setting Timeouts](#setting-timeouts)
|
82
|
-
* [Randomizing Hosts](#randomizing-hosts)
|
83
|
-
* [Retrying on Failures](#retrying-on-failures)
|
84
|
-
* [Reloading Hosts](#reloading-hosts)
|
85
|
-
* [Connection Selector](#connection-selector)
|
86
|
-
* [Transport Implementations](#transport-implementations)
|
87
|
-
* [Serializer implementations](#serializer-implementations)
|
88
|
-
* [Exception Handling](#exception-handling)
|
89
|
-
* [Development and Community](#development-and-community)
|
90
|
-
|
91
|
-
The client supports many configurations options for setting up and managing connections,
|
92
|
-
configuring logging, customizing the transport library, etc.
|
93
|
-
|
94
|
-
### Setting Hosts
|
95
|
-
|
96
|
-
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:
|
97
|
-
|
98
|
-
```ruby
|
99
|
-
Elastic::Transport::Client.new(host: 'search.myserver.com')
|
100
|
-
```
|
101
|
-
|
102
|
-
To connect to a host with specific port:
|
103
|
-
|
104
|
-
```ruby
|
105
|
-
Elastic::Transport::Client.new(host: 'myhost:8080')
|
106
|
-
```
|
107
|
-
|
108
|
-
To connect to multiple hosts:
|
109
|
-
|
110
|
-
```ruby
|
111
|
-
Elastic::Transport::Client.new(hosts: ['myhost1', 'myhost2'])
|
112
|
-
```
|
113
|
-
|
114
|
-
Instead of Strings, you can pass host information as an array of Hashes:
|
115
|
-
|
116
|
-
```ruby
|
117
|
-
Elastic::Transport::Client.new(hosts: [{ host: 'myhost1', port: 8080 }, { host: 'myhost2', port: 8080 }])
|
118
|
-
```
|
119
|
-
|
120
|
-
**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).
|
121
|
-
|
122
|
-
Common URL parts -- scheme, HTTP authentication credentials, URL prefixes, etc -- are handled automatically:
|
123
|
-
```ruby
|
124
|
-
Elastic::Transport::Client.new(url: 'https://username:password@api.server.org:4430/search')
|
125
|
-
```
|
126
|
-
|
127
|
-
You can pass multiple URLs separated by a comma:
|
128
|
-
```ruby
|
129
|
-
Elastic::Transport::Client.new(urls: 'http://localhost:9200,http://localhost:9201')
|
130
|
-
```
|
131
|
-
|
132
|
-
Another way to configure the URL(s) is to export the `ELASTICSEARCH_URL` variable.
|
133
|
-
|
134
|
-
The client will automatically round-robin across the hosts (unless you select or implement a different [connection selector](#connection-selector)).
|
135
|
-
|
136
|
-
### Default port
|
137
|
-
|
138
|
-
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.
|
139
|
-
|
140
|
-
### Authentication
|
141
|
-
|
142
|
-
You can pass the authentication credentials, scheme and port in the host configuration hash:
|
143
|
-
|
144
|
-
```ruby
|
145
|
-
Elastic::Transport::Client.new(
|
146
|
-
hosts: [
|
147
|
-
{
|
148
|
-
host: 'my-protected-host',
|
149
|
-
port: '443',
|
150
|
-
user: 'USERNAME',
|
151
|
-
password: 'PASSWORD',
|
152
|
-
scheme: 'https'
|
153
|
-
}
|
154
|
-
]
|
155
|
-
)
|
156
|
-
```
|
157
|
-
Or use the common URL format:
|
158
|
-
|
159
|
-
```ruby
|
160
|
-
Elastic::Transport::Client.new(url: 'https://username:password@example.com:9200')
|
161
|
-
```
|
162
|
-
|
163
|
-
To pass a custom certificate for SSL peer verification to Faraday-based clients, use the `transport_options` option:
|
164
|
-
|
165
|
-
```ruby
|
166
|
-
Elastic::Transport::Client.new(
|
167
|
-
url: 'https://username:password@example.com:9200',
|
168
|
-
transport_options: { ssl: { ca_file: '/path/to/cacert.pem' } }
|
169
|
-
)
|
170
|
-
```
|
171
|
-
|
172
|
-
### Logging
|
173
|
-
|
174
|
-
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:
|
175
|
-
|
176
|
-
```ruby
|
177
|
-
Elastic::Transport::Client.new(log: true)
|
178
|
-
```
|
179
|
-
|
180
|
-
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):
|
181
|
-
|
182
|
-
```ruby
|
183
|
-
logger = EcsLogging::Logger.new($stdout)
|
184
|
-
Elastic::Transport::Client.new(logger: logger)
|
185
|
-
```
|
186
|
-
|
187
|
-
To trace requests and responses in the _Curl_ format, set the `trace` argument:
|
188
|
-
|
189
|
-
```ruby
|
190
|
-
Elastic::Transport::Client.new(trace: true)
|
191
|
-
```
|
192
|
-
|
193
|
-
You can customize the default logger or tracer:
|
194
|
-
|
195
|
-
```ruby
|
196
|
-
client.transport.logger.formatter = proc { |s, d, p, m| "#{s}: #{m}\n" }
|
197
|
-
client.transport.logger.level = Logger::INFO
|
198
|
-
```
|
199
|
-
|
200
|
-
Or, you can use a custom `::Logger` instance:
|
201
|
-
|
202
|
-
```ruby
|
203
|
-
Elastic::Transport::Client.new(logger: Logger.new(STDERR))
|
204
|
-
```
|
205
|
-
|
206
|
-
You can pass the client any conforming logger implementation:
|
207
|
-
|
208
|
-
```ruby
|
209
|
-
require 'logging' # https://github.com/TwP/logging/
|
210
|
-
|
211
|
-
log = Logging.logger['elasticsearch']
|
212
|
-
log.add_appenders Logging.appenders.stdout
|
213
|
-
log.level = :info
|
214
|
-
|
215
|
-
client = Elastic::Transport::Client.new(logger: log)
|
216
|
-
```
|
217
|
-
|
218
|
-
### Custom HTTP Headers
|
219
|
-
|
220
|
-
You can set a custom HTTP header on the client's initializer:
|
221
|
-
|
222
|
-
```ruby
|
223
|
-
client = Elastic::Transport::Client.new(
|
224
|
-
transport_options: {
|
225
|
-
headers:
|
226
|
-
{user_agent: "My App"}
|
227
|
-
}
|
228
|
-
)
|
229
|
-
```
|
230
|
-
|
231
|
-
You can also pass in `headers` as a parameter to any of the API Endpoints to set custom headers for the request:
|
232
|
-
|
233
|
-
```ruby
|
234
|
-
client.search(index: 'myindex', q: 'title:test', headers: { user_agent: "My App" })
|
235
|
-
```
|
236
|
-
|
237
|
-
### Setting Timeouts
|
238
|
-
|
239
|
-
For many operations in Elasticsearch, the default timeouts of HTTP libraries are too low.
|
240
|
-
To increase the timeout, you can use the `request_timeout` parameter:
|
241
|
-
|
242
|
-
```ruby
|
243
|
-
Elastic::Transport::Client.new(request_timeout: 5 * 60)
|
244
|
-
```
|
245
|
-
|
246
|
-
You can also use the `transport_options` argument documented below.
|
247
|
-
|
248
|
-
### Randomizing Hosts
|
249
|
-
|
250
|
-
If you pass multiple hosts to the client, it rotates across them in a round-robin fashion, by default.
|
251
|
-
When the same client would be running in multiple processes (eg. in a Ruby web server such as Thin),
|
252
|
-
it might keep connecting to the same nodes "at once". To prevent this, you can randomize the hosts
|
253
|
-
collection on initialization and reloading:
|
254
|
-
|
255
|
-
```ruby
|
256
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], randomize_hosts: true)
|
257
|
-
```
|
258
|
-
|
259
|
-
### Retrying on Failures
|
260
|
-
|
261
|
-
When the client is initialized with multiple hosts, it makes sense to retry a failed request
|
262
|
-
on a different host:
|
263
|
-
|
264
|
-
```ruby
|
265
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_failure: true)
|
266
|
-
```
|
16
|
+
**Refer to [the official documentation on Elastic Transport](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html).**
|
267
17
|
|
268
|
-
|
18
|
+
**Refer to [Advanced Configuration](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html) to read about more configuration options.**
|
269
19
|
|
270
|
-
|
271
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_failure: 5)
|
272
|
-
```
|
273
|
-
|
274
|
-
You can also use `retry_on_status` to retry when specific status codes are returned:
|
275
|
-
|
276
|
-
```ruby
|
277
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_status: [502, 503])
|
278
|
-
```
|
279
|
-
|
280
|
-
These two parameters can also be used together:
|
281
|
-
|
282
|
-
```ruby
|
283
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_status: [502, 503], retry_on_failure: 10)
|
284
|
-
```
|
285
|
-
|
286
|
-
### Reloading Hosts
|
287
|
-
|
288
|
-
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.
|
289
|
-
|
290
|
-
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:
|
291
|
-
|
292
|
-
```ruby
|
293
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_connections: true)
|
294
|
-
```
|
295
|
-
|
296
|
-
You can pass a specific number of requests after which the reloading should be performed:
|
297
|
-
|
298
|
-
```ruby
|
299
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_connections: 1_000)
|
300
|
-
```
|
301
|
-
|
302
|
-
To reload connections on failures, use:
|
303
|
-
|
304
|
-
```ruby
|
305
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_on_failure: true)
|
306
|
-
```
|
307
|
-
|
308
|
-
The reloading will timeout if not finished under 1 second by default. To change the setting:
|
309
|
-
|
310
|
-
```ruby
|
311
|
-
Elastic::Transport::Client.new(hosts: ['localhost:9200', 'localhost:9201'], sniffer_timeout: 3)
|
312
|
-
```
|
313
|
-
|
314
|
-
**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:
|
315
|
-
|
316
|
-
```ruby
|
317
|
-
Elastic::Transport::Client.new(
|
318
|
-
host: 'localhost:9200',
|
319
|
-
http: { scheme: 'https', user: 'U', password: 'P' },
|
320
|
-
reload_connections: true,
|
321
|
-
reload_on_failure: true
|
322
|
-
)
|
323
|
-
```
|
324
|
-
|
325
|
-
### Connection Selector
|
326
|
-
|
327
|
-
By default, the client will rotate the connections in a round-robin fashion, using the {Elastic::Transport::Transport::Connections::Selector::RoundRobin} strategy.
|
328
|
-
|
329
|
-
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:
|
330
|
-
|
331
|
-
```ruby
|
332
|
-
class RackIdSelector
|
333
|
-
include Elastic::Transport::Transport::Connections::Selector::Base
|
334
|
-
|
335
|
-
def select(options={})
|
336
|
-
connections.select do |c|
|
337
|
-
# Try selecting the nodes with a `rack_id:x1` attribute first
|
338
|
-
c.host[:attributes] && c.host[:attributes][:rack_id] == 'x1'
|
339
|
-
end.sample || connections.to_a.sample
|
340
|
-
end
|
341
|
-
end
|
342
|
-
|
343
|
-
Elastic::Transport::Client.new hosts: ['x1.search.org', 'x2.search.org'], selector_class: RackIdSelector
|
344
|
-
```
|
345
|
-
|
346
|
-
### Transport Implementations
|
347
|
-
|
348
|
-
By default, the client will use the [_Faraday_](https://rubygems.org/gems/faraday) HTTP library as a transport implementation.
|
349
|
-
|
350
|
-
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. Faraday 2 changed the way adapters are used ([read more here](https://github.com/lostisland/faraday/blob/main/UPGRADING.md#adapters-have-moved)). If you're using Faraday 1.x, you can require the HTTP library. To use the [_Patron_](https://github.com/toland/patron) HTTP, for example, require it:
|
351
|
-
|
352
|
-
```ruby
|
353
|
-
require 'patron'
|
354
|
-
```
|
355
|
-
|
356
|
-
If you're using Faraday 2.x, you need to add the corresponding adapter gem to your Gemfile and require them after you require `faraday`:
|
357
|
-
|
358
|
-
```ruby
|
359
|
-
# Gemfile
|
360
|
-
gem 'faraday-patron'
|
361
|
-
|
362
|
-
# Code
|
363
|
-
require 'faraday'
|
364
|
-
require 'faraday/patron'
|
365
|
-
```
|
366
|
-
|
367
|
-
Then, create a new client, and the _Patron_ gem will be used as the "driver":
|
368
|
-
|
369
|
-
```ruby
|
370
|
-
client = Elastic::Transport::Client.new
|
371
|
-
|
372
|
-
client.transport.connections.first.connection.builder.adapter
|
373
|
-
# => Faraday::Adapter::Patron
|
374
|
-
|
375
|
-
10.times do
|
376
|
-
client.nodes.stats(metric: 'http')['nodes'].values.each do |n|
|
377
|
-
puts "#{n['name']} : #{n['http']['total_opened']}"
|
378
|
-
end
|
379
|
-
end
|
380
|
-
|
381
|
-
# => Stiletoo : 24
|
382
|
-
# => Stiletoo : 24
|
383
|
-
# => Stiletoo : 24
|
384
|
-
# => ...
|
385
|
-
```
|
386
|
-
|
387
|
-
To use a specific adapter for _Faraday_, pass it as the `adapter` argument:
|
388
|
-
|
389
|
-
```ruby
|
390
|
-
# Gemfile
|
391
|
-
gem 'faraday-net_http_persistent'
|
392
|
-
|
393
|
-
# Code
|
394
|
-
client = Elastic::Transport::Client.new(adapter: :net_http_persistent)
|
395
|
-
|
396
|
-
client.transport.connections.first.connection.builder.handlers
|
397
|
-
# => [Faraday::Adapter::NetHttpPersistent]
|
398
|
-
```
|
399
|
-
|
400
|
-
To pass options to the
|
401
|
-
[`Faraday::Connection`](https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb)
|
402
|
-
constructor, use the `transport_options` key:
|
403
|
-
|
404
|
-
```ruby
|
405
|
-
client = Elastic::Transport::Client.new(
|
406
|
-
transport_options: {
|
407
|
-
request: { open_timeout: 1 },
|
408
|
-
headers: { user_agent: 'MyApp' },
|
409
|
-
params: { :format => 'yaml' },
|
410
|
-
ssl: { verify: false }
|
411
|
-
}
|
412
|
-
)
|
413
|
-
```
|
414
|
-
|
415
|
-
To configure the _Faraday_ instance directly, use a block:
|
416
|
-
|
417
|
-
```ruby
|
418
|
-
require 'patron'
|
419
|
-
|
420
|
-
client = Elastic::Transport::Client.new(host: 'localhost', port: '9200') do |f|
|
421
|
-
f.response :logger
|
422
|
-
f.adapter :patron
|
423
|
-
end
|
424
|
-
```
|
425
|
-
|
426
|
-
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:
|
427
|
-
|
428
|
-
```ruby
|
429
|
-
require 'patron'
|
430
|
-
|
431
|
-
transport_configuration = lambda do |f|
|
432
|
-
f.response :logger
|
433
|
-
f.adapter :patron
|
434
|
-
end
|
435
|
-
|
436
|
-
transport = Elastic::Transport::Transport::HTTP::Faraday.new(
|
437
|
-
hosts: [ { host: 'localhost', port: '9200' } ],
|
438
|
-
&transport_configuration
|
439
|
-
)
|
440
|
-
|
441
|
-
# Pass the transport to the client
|
442
|
-
#
|
443
|
-
client = Elastic::Transport::Client.new(transport: transport)
|
444
|
-
```
|
445
|
-
|
446
|
-
Instead of passing the transport to the constructor, you can inject it at run time:
|
447
|
-
|
448
|
-
```ruby
|
449
|
-
# Set up the transport
|
450
|
-
#
|
451
|
-
faraday_configuration = lambda do |f|
|
452
|
-
f.instance_variable_set :@ssl, { verify: false }
|
453
|
-
f.adapter :excon
|
454
|
-
end
|
455
|
-
|
456
|
-
faraday_client = Elastic::Transport::Transport::HTTP::Faraday.new(
|
457
|
-
hosts: [
|
458
|
-
{
|
459
|
-
host: 'my-protected-host',
|
460
|
-
port: '443',
|
461
|
-
user: 'USERNAME',
|
462
|
-
password: 'PASSWORD',
|
463
|
-
scheme: 'https'
|
464
|
-
}
|
465
|
-
],
|
466
|
-
&faraday_configuration
|
467
|
-
)
|
468
|
-
|
469
|
-
# Create a default client
|
470
|
-
#
|
471
|
-
client = Elastic::Transport::Client.new
|
472
|
-
|
473
|
-
# Inject the transport to the client
|
474
|
-
#
|
475
|
-
client.transport = faraday_client
|
476
|
-
```
|
477
|
-
|
478
|
-
You can also use a bundled [_Curb_](https://rubygems.org/gems/curb) based transport implementation:
|
479
|
-
|
480
|
-
```ruby
|
481
|
-
require 'curb'
|
482
|
-
require 'elastic/transport/transport/http/curb'
|
483
|
-
|
484
|
-
client = Elastic::Transport::Client.new(transport_class: Elastic::Transport::Transport::HTTP::Curb)
|
485
|
-
|
486
|
-
client.transport.connections.first.connection
|
487
|
-
# => #<Curl::Easy http://localhost:9200/>
|
488
|
-
```
|
489
|
-
|
490
|
-
It's possible to customize the _Curb_ instance by passing a block to the constructor as well (in this case, as an inline block):
|
491
|
-
|
492
|
-
```ruby
|
493
|
-
transport = Elastic::Transport::Transport::HTTP::Curb.new(
|
494
|
-
hosts: [ { host: 'localhost', port: '9200' } ],
|
495
|
-
& lambda { |c| c.verbose = true }
|
496
|
-
)
|
497
|
-
|
498
|
-
client = Elastic::Transport::Client.new(transport: transport)
|
499
|
-
```
|
500
|
-
|
501
|
-
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.
|
502
|
-
|
503
|
-
### Serializer Implementations
|
504
|
-
|
505
|
-
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.
|
506
|
-
|
507
|
-
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.
|
508
|
-
|
509
|
-
### Exception Handling
|
510
|
-
|
511
|
-
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,
|
512
|
-
making it possible to `rescue` specific exceptions with desired granularity.
|
513
|
-
|
514
|
-
The highest-level exception is `Elastic::Transport::Transport::Error` and will be raised for any generic client *or* server errors.
|
515
|
-
|
516
|
-
`Elastic::Transport::Transport::ServerError` will be raised for server errors only.
|
517
|
-
|
518
|
-
As an example for response-specific errors, a `404` response status will raise an `Elastic::Transport::Transport::Errors::NotFound` exception.
|
20
|
+
## Compatibility
|
519
21
|
|
520
|
-
|
22
|
+
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.
|
521
23
|
|
522
24
|
## Development and Community
|
523
25
|
|
@@ -525,21 +27,6 @@ For local development, clone the repository and run `bundle install`. See `rake
|
|
525
27
|
|
526
28
|
Bug fixes and features must be covered by unit tests.
|
527
29
|
|
528
|
-
Github's pull requests and issues are used to communicate, send bug reports and code contributions.
|
529
|
-
|
530
|
-
## The Architecture
|
531
|
-
|
532
|
-
* `Elastic::Transport::Client` is composed of `Elastic::Transport::Transport`.
|
533
|
-
* `Elastic::Transport::Transport` is composed of `Elastic::Transport::Transport::Connections`, and an instance of logger, tracer, serializer and sniffer.
|
534
|
-
* 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.
|
535
|
-
* The `Elastic::Transport::Transport::Serializer::Base` implementations handles converting data for Elasticsearch (eg. to JSON). You can implement your own serializer.
|
536
|
-
* `Elastic::Transport::Transport::Sniffer` allows discovering nodes in the cluster and use them as connections.
|
537
|
-
* `Elastic::Transport::Transport::Connections::Collection` is composed of `Elastic::Transport::Transport::Connections::Connection` instances and a selector instance.
|
538
|
-
* `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.
|
539
|
-
* 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.
|
540
|
-
|
541
|
-
## Development
|
542
|
-
|
543
30
|
A rake task is included to launch an Elasticsearch cluster with Docker. You need to install docker on your system and then run:
|
544
31
|
```bash
|
545
32
|
$ rake docker:start[VERSION]
|
@@ -561,6 +48,8 @@ time rake test:integration
|
|
561
48
|
|
562
49
|
Use `COVERAGE=true` before running a test task to check coverage with Simplecov.
|
563
50
|
|
51
|
+
Github's pull requests and issues are used to communicate, send bug reports and code contributions.
|
52
|
+
|
564
53
|
## License
|
565
54
|
|
566
55
|
This software is licensed under the [Apache 2 license](./LICENSE).
|
data/Rakefile
CHANGED
@@ -18,22 +18,13 @@
|
|
18
18
|
require 'bundler/gem_tasks'
|
19
19
|
require 'mkmf'
|
20
20
|
|
21
|
-
desc
|
21
|
+
desc "Run unit tests"
|
22
22
|
task default: 'test:unit'
|
23
23
|
task test: 'test:unit'
|
24
24
|
|
25
25
|
# ----- Test tasks ------------------------------------------------------------
|
26
26
|
require 'rake/testtask'
|
27
27
|
require 'rspec/core/rake_task'
|
28
|
-
FARADAY1_GEMFILE = 'Gemfile-faraday1.gemfile'.freeze
|
29
|
-
GEMFILES = ['Gemfile', FARADAY1_GEMFILE].freeze
|
30
|
-
|
31
|
-
task :install do
|
32
|
-
GEMFILES.each do |gemfile|
|
33
|
-
gemfile = File.expand_path("../#{gemfile}", __FILE__)
|
34
|
-
sh "bundle install --gemfile #{gemfile}"
|
35
|
-
end
|
36
|
-
end
|
37
28
|
|
38
29
|
namespace :test do
|
39
30
|
RSpec::Core::RakeTask.new(:spec)
|
@@ -55,7 +46,6 @@ namespace :test do
|
|
55
46
|
desc 'Run all tests'
|
56
47
|
task :all do
|
57
48
|
Rake::Task['test:unit'].invoke
|
58
|
-
Rake::Task['test:spec'].invoke
|
59
49
|
Rake::Task['test:integration'].invoke
|
60
50
|
end
|
61
51
|
|
@@ -63,34 +53,6 @@ namespace :test do
|
|
63
53
|
test.libs << 'lib' << 'test'
|
64
54
|
test.test_files = FileList['test/profile/**/*_test.rb']
|
65
55
|
end
|
66
|
-
|
67
|
-
namespace :faraday1 do
|
68
|
-
desc 'Faraday 1: Run RSpec with dependency on Faraday 1'
|
69
|
-
task :spec do
|
70
|
-
sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} bundle exec rspec"
|
71
|
-
end
|
72
|
-
|
73
|
-
desc 'Faraday 1: Run unit tests with dependency on Faraday 1'
|
74
|
-
task :unit do
|
75
|
-
Dir.glob('./test/unit/**/**.rb').each do |test|
|
76
|
-
sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} ruby -Ilib:test #{test}"
|
77
|
-
end
|
78
|
-
end
|
79
|
-
|
80
|
-
desc 'Faraday 1: Run integration tests with dependency on Faraday 1'
|
81
|
-
task :integration do
|
82
|
-
Dir.glob('./test/integration/**/**.rb').each do |test|
|
83
|
-
sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} ruby -Ilib:test #{test}"
|
84
|
-
end
|
85
|
-
end
|
86
|
-
|
87
|
-
desc 'Faraday 1: Run all tests'
|
88
|
-
task :all do
|
89
|
-
Rake::Task['test:faraday1:unit'].invoke
|
90
|
-
Rake::Task['test:faraday1:spec'].invoke
|
91
|
-
Rake::Task['test:faraday1:integration'].invoke
|
92
|
-
end
|
93
|
-
end
|
94
56
|
end
|
95
57
|
|
96
58
|
namespace :docker do
|
data/elastic-transport.gemspec
CHANGED
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
|
|
24
24
|
s.name = "elastic-transport"
|
25
25
|
s.version = Elastic::Transport::VERSION
|
26
26
|
s.authors = ['Karel Minarik', 'Emily Stolfo', 'Fernando Briano']
|
27
|
-
s.email = ['
|
27
|
+
s.email = ['clients-team@elastic.co']
|
28
28
|
s.summary = 'Low level Ruby client for Elastic services.'
|
29
29
|
s.homepage = 'https://github.com/elastic/elastic-transport-ruby'
|
30
30
|
s.license = 'Apache-2.0'
|
@@ -44,18 +44,20 @@ Gem::Specification.new do |s|
|
|
44
44
|
|
45
45
|
s.required_ruby_version = '>= 2.5'
|
46
46
|
|
47
|
-
s.add_dependency 'faraday', '< 3'
|
48
47
|
s.add_dependency 'multi_json'
|
48
|
+
s.add_dependency 'faraday', '~> 1'
|
49
49
|
|
50
|
-
# Faraday Adapters
|
51
|
-
s.add_development_dependency 'manticore' if defined? JRUBY_VERSION
|
52
|
-
s.add_development_dependency 'curb' unless defined? JRUBY_VERSION
|
53
50
|
s.add_development_dependency 'bundler'
|
54
51
|
s.add_development_dependency 'cane'
|
52
|
+
s.add_development_dependency 'curb' unless defined? JRUBY_VERSION
|
55
53
|
s.add_development_dependency 'hashie'
|
54
|
+
s.add_development_dependency 'httpclient'
|
55
|
+
s.add_development_dependency 'manticore' if defined? JRUBY_VERSION
|
56
56
|
s.add_development_dependency 'minitest'
|
57
57
|
s.add_development_dependency 'minitest-reporters'
|
58
58
|
s.add_development_dependency 'mocha'
|
59
|
+
s.add_development_dependency 'net-http-persistent'
|
60
|
+
s.add_development_dependency 'patron' unless defined? JRUBY_VERSION
|
59
61
|
s.add_development_dependency 'pry'
|
60
62
|
s.add_development_dependency 'rake', '~> 13'
|
61
63
|
s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
|
@@ -63,6 +65,7 @@ Gem::Specification.new do |s|
|
|
63
65
|
s.add_development_dependency 'shoulda-context'
|
64
66
|
s.add_development_dependency 'simplecov'
|
65
67
|
s.add_development_dependency 'test-unit', '~> 2'
|
68
|
+
s.add_development_dependency 'typhoeus', '~> 1.4'
|
66
69
|
s.add_development_dependency 'yard'
|
67
70
|
|
68
71
|
s.description = <<-DESC.gsub(/^ /, '')
|