Class: OpenSearch::Transport::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/opensearch/transport/client.rb

Overview

Handles communication with an OpenSearch cluster.

See README for usage and code examples.

Constant Summary collapse

DEFAULT_TRANSPORT_CLASS = 
Transport::HTTP::Faraday
DEFAULT_LOGGER = 
lambda do
  require 'logger'
  logger = Logger.new(STDERR)
  logger.progname = 'opensearch'
  logger.formatter = proc { |severity, datetime, progname, msg| "#{datetime}: #{msg}\n" }
  logger
end
DEFAULT_TRACER = 
lambda do
  require 'logger'
  logger = Logger.new(STDERR)
  logger.progname = 'opensearch.tracer'
  logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
  logger
end
DEFAULT_HOST =

The default host and port to use if not otherwise specified.

Since:

  • 7.0.0

'localhost:9200'.freeze
DEFAULT_CLOUD_PORT =

The default port to use if connecting using a Cloud ID. Updated from 9243 to 443 in client version 7.10.1

Since:

  • 7.2.0

443
DEFAULT_PORT =

The default port to use if not otherwise specified.

Since:

  • 7.2.0

9200

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments = {}) {|faraday| ... } ⇒ Client

Create a client connected to an OpenSearch cluster.

Specify the URL via arguments or set the ‘OPENSEARCH_URL` environment variable.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

  • api_key (Hash) —

    a customizable set of options

  • opaque_id_prefix (Hash) —

    a customizable set of options

Options Hash (arguments):

  • :hosts (String, Array) —

    Single host passed as a String or Hash, or multiple hosts passed as an Array; ‘host` or `url` keys are also valid

  • :log (Boolean) —

    Use the default logger (disabled by default)

  • :trace (Boolean) —

    Use the default tracer (disabled by default)

  • :logger (Object) —

    An instance of a Logger-compatible object

  • :tracer (Object) —

    An instance of a Logger-compatible object

  • :resurrect_after (Number) —

    After how many seconds a dead connection should be tried again

  • :reload_connections (Boolean, Number) —

    Reload connections after X requests (false by default)

  • :randomize_hosts (Boolean) —

    Shuffle connections on initialization and reload (false by default)

  • :sniffer_timeout (Integer) —

    Timeout for reloading connections in seconds (1 by default)

  • :retry_on_failure (Boolean, Number) —

    Retry X times when request fails before raising and exception (false by default)

  • Array (Number) —

    :retry_on_status Retry when specific status codes are returned

  • :reload_on_failure (Boolean) —

    Reload connections after failure (false by default)

  • :request_timeout (Integer) —

    The request timeout to be passed to transport in options

  • :adapter (Symbol) —

    A specific adapter for Faraday (e.g. ‘:patron`)

  • :transport_options (Hash) —

    Options to be passed to the ‘Faraday::Connection` constructor

  • :transport_class (Constant) —

    A specific transport class to use, will be initialized by the client and passed hosts and all arguments

  • :transport (Object) —

    A specific transport instance

  • :serializer_class (Constant) —

    A specific serializer class to use, will be initialized by the transport and passed the transport instance

  • :selector (Constant) —

    An instance of selector strategy implemented with Transport::Connections::Selector::Base.

  • :send_get_body_as (String) —

    Specify the HTTP method to use for GET requests with a body. (Default: GET)

  • :compression (true, false) —

    Whether to compress requests. Gzip compression will be used. The default is false. Responses will automatically be inflated if they are compressed. If a custom transport object is used, it must handle the request compression and response inflation.

Yields:

  • (faraday) —

    Access and configure the ‘Faraday::Connection` instance directly with a block



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/opensearch/transport/client.rb', line 137

def initialize(arguments={}, &block)
  @options = arguments.each_with_object({}){ |(k,v), args| args[k.to_sym] = v }
  @arguments = @options
  @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call() : nil
  @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call() : nil
  @arguments[:reload_connections] ||= false
  @arguments[:retry_on_failure]   ||= false
  @arguments[:reload_on_failure]  ||= false
  @arguments[:randomize_hosts]    ||= false
  @arguments[:transport_options]  ||= {}
  @arguments[:http]               ||= {}
  @options[:http]                 ||= {}

  set_api_key if (@api_key = @arguments[:api_key])
  set_compatibility_header if ENV['ELASTIC_CLIENT_APIVERSIONING']

  @seeds = extract_cloud_creds(@arguments)
  @seeds ||= __extract_hosts(@arguments[:hosts] ||
                             @arguments[:host] ||
                             @arguments[:url] ||
                             @arguments[:urls] ||
                             ENV['OPENSEARCH_URL'] ||
                             DEFAULT_HOST)

  @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
  @opaque_id_prefix = @arguments[:opaque_id_prefix] || nil

  if @arguments[:request_timeout]
    @arguments[:transport_options][:request] = { timeout: @arguments[:request_timeout] }
  end

  if @arguments[:transport]
    @transport = @arguments[:transport]
  else
    @transport_class = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
    @transport = if @transport_class == Transport::HTTP::Faraday
                   @arguments[:adapter] ||= __auto_detect_adapter
                   @transport_class.new(hosts: @seeds, options: @arguments) do |faraday|
                     faraday.adapter(@arguments[:adapter])
                     block&.call faraday
                   end
                 else
                   @transport_class.new(hosts: @seeds, options: @arguments)
                 end
  end
end

Instance Attribute Details

#transport ⇒ Object

Returns the transport object.

See Also:



75
76
77
 
# File 'lib/opensearch/transport/client.rb', line 75

def transport
  @transport
end

Instance Method Details

#perform_request(method, path, params = {}, body = nil, headers = nil) ⇒ Object

Performs a request through delegation to #transport.



186
187
188
189
190
191
192
193
194
 
# File 'lib/opensearch/transport/client.rb', line 186

def perform_request(method, path, params = {}, body = nil, headers = nil)
  method = @send_get_body_as if 'GET' == method && body
  if (opaque_id = params.delete(:opaque_id))
    headers = {} if headers.nil?
    opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
    headers.merge!('X-Opaque-Id' => opaque_id)
  end
  transport.perform_request(method, path, params, body, headers)
end