-
Notifications
You must be signed in to change notification settings - Fork 602
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Gem] Adds ES|QL Helper - Backports #2328
- Loading branch information
1 parent
6e0d376
commit 6efbe8c
Showing
7 changed files
with
292 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
elasticsearch/spec/integration/helpers/esql_helper_spec.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
29 changes: 29 additions & 0 deletions
29
elasticsearch/spec/integration/helpers/helpers_spec_helper.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters