elasticsearch 8.12.1 → 8.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c541958c6747c3eb05c4700476f842b7552e4dc4898207837674d05a1cbb9a4
-  data.tar.gz: d0a8a6805fbc1b16956aee0df9de13053512dcc61fea47947116d6c8f78a2811
+  metadata.gz: 81edddb9e4103d40bc3b06bb4fd1db49e8a62f17fab3fa914d737069d681d526
+  data.tar.gz: 29f8aa207a8e7e5a446a0fa0c6bc1bdb408f49020c53fbdaeba0066d4807306f
 SHA512:
-  metadata.gz: 1afa288859288d36059b065a9e31c87e4ba9cb3e37e22ac48d3bab072d790fd3a2f4919e8386b186316cc346a6cc9ee1ce9dcac5e0817d2e32806d3dbbbbd058
-  data.tar.gz: ea0ab1a02f2749023bc599e0713d9dd5ca6bc3dc6ef1dd9bc276a29d973db32d8b48fb624631402cbe4c235013c4cf59083038fc620bd9124383828a28b41f41
+  metadata.gz: 00e2fd8d54aa598c24e5b3e8f1452b117f65c951e30988b1927e8e504eda77027557d5963bdbec22d3e747c53f32eec3aae8a44e7a6b4f37edb336d894c01ce1
+  data.tar.gz: aa738720a203ddf228ce4835e2aaa3ad5b1bf2ed7380d7ba6f451630b831219cd7dfd17b016489350d12a7e62f2bad456a3a82368fbb53fa27720f92f79f4945

data/Gemfile

@@ -29,3 +29,7 @@ end
 if ENV['TRANSPORT_VERSION'] == 'main'
   gem 'elastic-transport', git: 'https://github.com/elastic/elastic-transport-ruby.git', branch: 'main'
 end
+
+if RUBY_VERSION >= '3.0'
+  gem 'opentelemetry-sdk', require: false
+end

data/elasticsearch.gemspec

@@ -46,12 +46,11 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.5'
 
   s.add_dependency 'elastic-transport', '~> 8.3'
-
-  s.add_dependency 'elasticsearch-api', '8.12.1'
-  s.add_dependency 'base64'
-
+  s.add_dependency 'elasticsearch-api', '8.13.0'
+  
+  s.add_development_dependency 'base64'
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'debug' unless defined?(JRUBY_VERSION)
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)

data/lib/elasticsearch/helpers/esql_helper.rb

@@ -0,0 +1,71 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module Helpers
+    # Elasticsearch Client Helper for the ES|QL API
+    #
+    # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html
+    #
+    module ESQLHelper
+      # Query helper for ES|QL
+      #
+      # By default, the `esql.query` API returns a Hash response with the following keys:
+      #
+      # * `columns` with the value being an Array of `{ name: type }` Hashes for each column.
+      #
+      # * `values` with the value being an Array of Arrays with the values for each row.
+      #
+      # This helper function returns an Array of hashes with the columns as keys and the respective
+      # values: `{ column['name'] => value }`.
+      #
+      # @param client [Elasticsearch::Client] an instance of the Client to use for the query.
+      # @param query [Hash, String] The query to be passed to the ES|QL query API.
+      # @param params [Hash] options to pass to the ES|QL query API.
+      # @param parser [Hash] Hash of column name keys and Proc values to transform the value of
+      #   a given column.
+      # @example Using the ES|QL helper
+      #   require 'elasticsearch/helpers/esql_helper'
+      #   query = <<~ESQL
+      #             FROM sample_data
+      #             | EVAL duration_ms = ROUND(event.duration / 1000000.0, 1)
+      #           ESQL
+      #   response = Elasticsearch::Helpers::ESQLHelper.query(client, query)
+      #
+      # @example Using the ES|QL helper with a parser
+      #     response = Elasticsearch::Helpers::ESQLHelper.query(
+      #                  client,
+      #                  query,
+      #                  parser: { '@timestamp' => Proc.new { |t| DateTime.parse(t) } }
+      #                )
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/Helpers.html#_esql_helper
+      #
+      def self.query(client, query, params = {}, parser: {})
+        response = client.esql.query({ body: { query: query }, format: 'json' }.merge(params))
+        columns = response['columns']
+        response['values'].map do |value|
+          (value.length - 1).downto(0).map do |index|
+            key = columns[index]['name']
+            value[index] = parser[key].call value[index] if parser[key]
+            { key => value[index] }
+          end.reduce({}, :merge)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/version.rb

@@ -16,5 +16,5 @@
 # under the License.
 
 module Elasticsearch
-  VERSION = '8.12.1'.freeze
+  VERSION = '8.13.0'.freeze
 end

data/lib/elasticsearch.rb

@@ -18,7 +18,6 @@
 require 'elasticsearch/version'
 require 'elastic/transport'
 require 'elasticsearch/api'
-require 'base64'
 
 module Elasticsearch
   NOT_ELASTICSEARCH_WARNING = 'The client noticed that the server is not Elasticsearch and we do not support this unknown product.'.freeze
@@ -61,10 +60,6 @@ module Elasticsearch
       elsif name == :perform_request
         # The signature for perform_request is:
         # method, path, params, body, headers, opts
-        # The last arg is opts, which shouldn't be sent when `perform_request` is called
-        # directly. Check if :endpoint is a key, which means it's the extra identifier
-        # used for OpenTelemetry.
-        args.pop if args[-1].is_a?(Hash) && args[-1][:endpoint]
         if (opaque_id = args[2]&.delete(:opaque_id))
           headers = args[4] || {}
           opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
@@ -112,7 +107,8 @@ module Elasticsearch
 
     def setup_cloud_host(cloud_id, user, password, port)
       name = cloud_id.split(':')[0]
-      cloud_url, elasticsearch_instance = Base64.decode64(cloud_id.gsub("#{name}:", '')).split('$')
+      base64_decoded = cloud_id.gsub("#{name}:", '').unpack1('m')
+      cloud_url, elasticsearch_instance = base64_decoded.split('$')
 
       if cloud_url.include?(':')
         url, port = cloud_url.split(':')
@@ -154,7 +150,8 @@ module Elasticsearch
     # Credentials is the base64 encoding of id and api_key joined by a colon
     # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
     def encode(api_key)
-      Base64.strict_encode64([api_key[:id], api_key[:api_key]].join(':'))
+      credentials = [api_key[:id], api_key[:api_key]].join(':')
+      [credentials].pack('m0')
     end
 
     def elasticsearch_validation_request

data/spec/integration/client_integration_spec.rb

@@ -54,7 +54,7 @@ context 'Elasticsearch client' do
   end
 
   context 'Reports the right meta header' do
-    it 'Reports es service name and gem versio' do
+    it 'Reports es service name and gem version' do
       headers = client.transport.connections.first.connection.headers
       version = Class.new.extend(Elastic::Transport::MetaHeader).send(:client_meta_version, Elasticsearch::VERSION)
       expect(headers['x-elastic-client-meta']).to match /^es=#{version}/

data/spec/integration/helpers/bulk_helper_spec.rb

@@ -14,22 +14,12 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
-raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
-
+require_relative 'helpers_spec_helper'
 require 'elasticsearch/helpers/bulk_helper'
-require 'spec_helper'
 require 'tempfile'
 
 context 'Elasticsearch client helpers' do
   context 'Bulk helper' do
-    let(:client) do
-      Elasticsearch::Client.new(
-        host: ELASTICSEARCH_URL,
-        user: 'elastic',
-        password: 'changeme'
-      )
-    end
     let(:index) { 'bulk_animals' }
     let(:params) { { refresh: 'wait_for' } }
     let(:bulk_helper) { Elasticsearch::Helpers::BulkHelper.new(client, index, params) }

data/spec/integration/helpers/esql_helper_spec.rb

@@ -0,0 +1,94 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+require_relative 'helpers_spec_helper'
+require 'elasticsearch/helpers/esql_helper'
+
+context 'Elasticsearch client helpers' do
+  let(:index) { 'esql_helper_test' }
+  let(:body) { { size: 12, query: { match_all: {} } } }
+  let(:esql_helper) { Elasticsearch::Helpers::ESQLHelper }
+  let(:query) do
+    <<~ESQL
+        FROM #{index}
+        | EVAL duration_ms = ROUND(event.duration / 1000000.0, 1)
+    ESQL
+  end
+
+  before do
+    client.indices.create(
+      index: index,
+      body: {
+        mappings: {
+          properties: { 'client.ip' => { type: 'ip' }, message: { type: 'keyword' } }
+        }
+      }
+    )
+    client.bulk(
+      index: index,
+      body: [
+        {'index': {}},
+        {'@timestamp' => '2023-10-23T12:15:03.360Z', 'client.ip' => '172.21.2.162', message: 'Connected to 10.1.0.3', 'event.duration' => 3450233},
+        {'index': {}},
+        {'@timestamp' => '2023-10-23T12:27:28.948Z', 'client.ip' => '172.21.2.113', message: 'Connected to 10.1.0.2', 'event.duration' => 2764889},
+        {'index': {}},
+        {'@timestamp' => '2023-10-23T13:33:34.937Z', 'client.ip' => '172.21.0.5', message: 'Disconnected', 'event.duration' => 1232382},
+        {'index': {}},
+        {'@timestamp' => '2023-10-23T13:51:54.732Z', 'client.ip' => '172.21.3.15', message: 'Connection error', 'event.duration' => 725448},
+        {'index': {}},
+        {'@timestamp' => '2023-10-23T13:52:55.015Z', 'client.ip' => '172.21.3.15', message: 'Connection error', 'event.duration' => 8268153},
+        {'index': {}},
+        {'@timestamp' => '2023-10-23T13:53:55.832Z', 'client.ip' => '172.21.3.15', message: 'Connection error', 'event.duration' => 5033755},
+        {'index': {}},
+        {'@timestamp' => '2023-10-23T13:55:01.543Z', 'client.ip' => '172.21.3.15', message: 'Connected to 10.1.0.1', 'event.duration' => 1756467}
+      ],
+      refresh: true
+    )
+  end
+
+  after do
+    client.indices.delete(index: index)
+  end
+
+  it 'returns an ESQL response as a relational key/value object' do
+    response = esql_helper.query(client, query)
+    expect(response.count).to eq 7
+    expect(response.first.keys).to eq ['duration_ms', 'message', 'event.duration', 'client.ip', '@timestamp']
+    response.each do |r|
+      expect(r['@timestamp']).to be_a String
+      expect(r['client.ip']).to be_a String
+      expect(r['message']).to be_a String
+      expect(r['event.duration']).to be_a Integer
+    end
+  end
+
+  it 'parses iterated objects when procs are passed in' do
+    require 'ipaddr'
+
+    parser = {
+      '@timestamp' => Proc.new { |t| DateTime.parse(t) },
+      'client.ip' => Proc.new { |i| IPAddr.new(i) },
+      'event.duration' => Proc.new { |d| d.to_s }
+    }
+    response = esql_helper.query(client, query, parser: parser)
+    response.each do |r|
+      expect(r['@timestamp']).to be_a DateTime
+      expect(r['client.ip']).to be_a IPAddr
+      expect(r['message']).to be_a String
+      expect(r['event.duration']).to be_a String
+    end
+  end
+end

data/spec/integration/helpers/helpers_spec_helper.rb

@@ -0,0 +1,29 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
+raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+
+def client
+  @client ||= Elasticsearch::Client.new(
+    host: ELASTICSEARCH_URL,
+    user: 'elastic',
+    password: 'changeme'
+  )
+end

data/spec/integration/helpers/scroll_helper_spec.rb

@@ -14,20 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
-raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
-
-require 'spec_helper'
+require_relative 'helpers_spec_helper'
 require 'elasticsearch/helpers/scroll_helper'
 
 context 'Elasticsearch client helpers' do
-  let(:client) do
-    Elasticsearch::Client.new(
-      host: ELASTICSEARCH_URL,
-      user: 'elastic',
-      password: 'changeme'
-    )
-  end
   let(:index) { 'books' }
   let(:body) { { size: 12, query: { match_all: {} } } }
   let(:scroll_helper) { Elasticsearch::Helpers::ScrollHelper.new(client, index, body) }

data/spec/integration/opentelemetry_spec.rb

@@ -0,0 +1,55 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+if ENV['TEST_WITH_OTEL'] == 'true'
+  ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
+  raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+
+  require 'spec_helper'
+
+  context 'OpenTelemetry' do
+    let(:exporter) { EXPORTER }
+    before { exporter.reset }
+    after { exporter.reset }
+    let(:span) { exporter.finished_spans[0] }
+
+    let(:client) do
+      Elasticsearch::Client.new(
+        host: ELASTICSEARCH_URL,
+        user: 'elastic',
+        password: 'changeme'
+      )
+    end
+
+    after do
+     client.delete(index: 'myindex', id: 1); rescue
+    end
+
+    context 'when a request is instrumented' do
+      it 'sets the span name to the endpoint id' do
+        client.search(body: { query: { match: {a: 1} } })
+        expect(span.name).to eq 'search'
+      end
+
+      it 'sets the path parts' do
+        client.index(index: 'myindex', id: 1, body: { title: 'Test' })
+        expect(span.attributes['db.elasticsearch.path_parts.index']).to eq 'myindex'
+        expect(span.attributes['db.elasticsearch.path_parts.id']).to eq 1
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -29,3 +29,15 @@ end
 def jruby?
   defined?(JRUBY_VERSION)
 end
+
+if ENV['TEST_WITH_OTEL'] == 'true'
+  require 'opentelemetry-sdk'
+  EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
+  span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER)
+
+  OpenTelemetry::SDK.configure do |c|
+    c.error_handler = ->(exception:, message:) { raise(exception || message) }
+    c.logger = Logger.new($stderr, level: ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym)
+    c.add_span_processor span_processor
+  end
+end

data/spec/unit/api_key_spec.rb

@@ -16,6 +16,7 @@
 # under the License.
 
 require 'spec_helper'
+require 'base64'
 
 describe Elasticsearch::Client do
   context 'when using API Key' do

data/spec/unit/opaque_id_spec.rb

@@ -29,7 +29,7 @@ describe Elasticsearch::Client do
     it 'uses x-opaque-id on a request' do
       client.search(opaque_id: '12345')
       expect(transport).to have_received(:perform_request)
-        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => '12345' })
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => '12345' }, {:endpoint=>"search"})
     end
   end
 
@@ -42,7 +42,7 @@ describe Elasticsearch::Client do
     it 'uses x-opaque-id on a request' do
       expect { client.search(opaque_id: '12345') }.not_to raise_error
       expect(transport).to have_received(:perform_request)
-        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => 'elastic_cloud12345' })
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => 'elastic_cloud12345' }, {:endpoint=>"search"})
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch
 version: !ruby/object:Gem::Version
-  version: 8.12.1
+  version: 8.13.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.12.1
+        version: 8.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.12.1
+        version: 8.13.0
 - !ruby/object:Gem::Dependency
   name: base64
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +45,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -214,12 +214,16 @@ files:
 - lib/elasticsearch-ruby.rb
 - lib/elasticsearch.rb
 - lib/elasticsearch/helpers/bulk_helper.rb
+- lib/elasticsearch/helpers/esql_helper.rb
 - lib/elasticsearch/helpers/scroll_helper.rb
 - lib/elasticsearch/version.rb
 - spec/integration/characters_escaping_spec.rb
 - spec/integration/client_integration_spec.rb
 - spec/integration/helpers/bulk_helper_spec.rb
+- spec/integration/helpers/esql_helper_spec.rb
+- spec/integration/helpers/helpers_spec_helper.rb
 - spec/integration/helpers/scroll_helper_spec.rb
+- spec/integration/opentelemetry_spec.rb
 - spec/spec_helper.rb
 - spec/unit/api_key_spec.rb
 - spec/unit/cloud_credentials_spec.rb
@@ -261,7 +265,10 @@ test_files:
 - spec/integration/characters_escaping_spec.rb
 - spec/integration/client_integration_spec.rb
 - spec/integration/helpers/bulk_helper_spec.rb
+- spec/integration/helpers/esql_helper_spec.rb
+- spec/integration/helpers/helpers_spec_helper.rb
 - spec/integration/helpers/scroll_helper_spec.rb
+- spec/integration/opentelemetry_spec.rb
 - spec/spec_helper.rb
 - spec/unit/api_key_spec.rb
 - spec/unit/cloud_credentials_spec.rb