Ruby integrations for Elasticsearch
This version provides a new experimental Helper for the ES|QL query API. The helper returns an array of hashes with the columns as keys and the respective values instead of the default JSON value. Additionally, you can iterate through the response values and transform the data in by passing in a Hash of column => Proc values. You could use this for example to convert a @timestamp column value into a DateTime object. Please check out the documentation and open an issue if you encounter any problems or have any feedback.
API Changes:
async_search.status - adds Time :keep_alive parameter: Specify the time interval in which the results (partial or final) for this search will be available.bulk - adds boolean :require_data_stream parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false.connector.list - Adds the following parameters:
:index_name (List): A comma-separated list of connector index names to fetch connector documents for.:connector_name (List): A comma-separated list of connector names to fetch connector documents for.:service_type (List): A comma-separated list of connector service types to fetch connector documents for.:query (String): A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names.esql.query - adds boolean :drop_null_columns parameter: Should entirely null columns be removed from the results? Their name and type will be returning in a new all_columns section.field_caps - Adds :include_empty_fields boolean parameter: Include empty fields in result.index - adds boolean :require_data_stream parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false.indices.rollover - adds boolean :lazy parameter: If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.:job_type parameter: A comma-separated list of job types.inference.delete_model, inference.get_model, inference.inference, inference.put_model: renames :model_id parameter to :inference_id.termvector will show a warning since it's been deprecated. Please use the plural version, termvectors.New APIs:
indices.resolve_cluster - Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.profiling.flamegraph - Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.profiling.stacktraces - Extracts raw stacktrace information from Universal Profiling.security.query_user - Retrieves information for Users using a subset of query DSLtext_structure.test_grok_pattern - Tests a Grok pattern on some text.APIs Migrated from experimental to stable:
synonyms.delete_synonym
synonyms.delete_synonym_rule
synonyms.get_synonym
synonyms.get_synonym_rule
synonyms.get_synonyms_sets
synonyms.put_synonym
synonyms.put_synonym_rule
New Experimental APIs:
connector.update_api_key_id - Updates the API key id and/or API key secret id fields in the connector document.connector.update_index_name - Updates the index name of the connector.connector.update_native - Updates the is_native flag of the connector.connector.update_service_type - Updates the service type of the connector.connector.update_status - Updates the status of the connector.esql.async_query - Executes an ESQL request asynchronouslyesql.async_query_get - Retrieves the results of a previously submitted async query request given its ID.New Experimental namespace connector_secret:
connector_secret.delete - Deletes a connector secret.connector_secret.get - Retrieves a secret stored by Connectors.connector_secret.post - Creates a secret for a Connector.connector_secret.put - Creates or updates a secret for a Connector.byebug to debug.Adds base64 dependency: base64 was added to the gemspec, since starting in Ruby 3.4.0, base64 will no longer be part of the default gems and will no longer be in the standard library.
Base64 is used for API key and Cloud ID. The dependency used to be declared in transport, but it's not needed there since the implementation using it is in this codebase. It was removed from transport in the latest patch releases: 8.1.3, 8.2.5 and 8.3.1.
Adds base64 dependency: base64 was added to the gemspec, since starting in Ruby 3.4.0, base64 will no longer be part of the default gems and will no longer be in the standard library.
Base64 is used for API key and Cloud ID. The dependency used to be declared in transport, but it's not needed there since the implementation using it is in this codebase. It was removed from transport in the latest patch releases: 8.1.3, 8.2.5 and 8.3.1.
bulk - Adds boolean :list_executed_pipelines parameter: Sets list_executed_pipelines for all incoming documents. Defaults to unset (false).indices.put_settings - Adds boolean :reopen parameter: Whether to close and reopen the index to apply non-dynamic settings. If set to true the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is false.open_point_in_time - Adds Hash :body parameter: an index_filter specified with the Query DSL.security.get_api_key - Adds boolean :active_only parameter: flag to limit response to only active (not invalidated or expired) API keys.New API for Universal profiling:
profiling.status - Returns basic information about the status of Universal Profiling.New experimental API:
simulate.ingest - Simulates running ingest with example documents. See: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/simulate-ingest-api.html
Version 8.12 introduces the experimental Connectors API. Use the following APIs to manage connectors:
connector.post - Creates a connector. See documentation
connector.put - Creates or updates a connector. See documentation
connector.delete - Deletes a connector. See documentation
connector.get - Returns the details about a connector. See documentation
connector.list - Lists all connectors. See documentation
connector.check_in - Updates the last_seen timestamp in the connector document. See documentation
connector.update_configuration - Updates the connector configuration. See documentation
connector.update_error - Updates the error field in the connector document. See documentation
connector.update_filtering - Updates the filtering field in the connector document. See documentation
connector.last_sync - Updates the stats of last sync in the connector document. See documentation
connector.update_name - Updates the name and/or description fields in the connector document. See documentation
connector.update_pipeline - Updates the pipeline field in the connector document. See documentation
connector.update_scheduling - Updates the scheduling field in the connector document. See documentation
Use the following APIs to manage sync jobs:
connector_sync_job.cancel - Cancels a connector sync job. See documentation
connector_sync_job.check_in - Checks in a connector sync job (refreshes 'last_seen'). See documentation
connector_sync_job.delete - Deletes a connector sync job. See documentation
connector_sync_job.error - Sets an error for a connector sync job. See documentation
connector_sync_job.get - Returns the details about a connector sync job. See documentation
connector_sync_job.list - Lists all connector sync jobs. See documentation
connector_sync_job.post - Creates a connector sync job. See documentation
connector_sync_job.update_stats - Updates the stats fields in the connector sync job document. See documentation
New Experimental APIs:
esql.query - Executes an ESQL request.inference.delete_model - Delete model in the Inference API.inference.get_model - Get a model in the Inference API.inference.inference - Perform inference on a model.inference.put_model - Configure a model for use in the Inference API.Backports support for Faraday 2 from elastic-transport. ¡Gracias santiagorodriguez96!
This version of the gem now supports Faraday v2. If you don't have a locked version of Faraday in your project, when you upgrade your gems, Faraday v2 will be installed. The main change on dependencies when using Faraday v2 is all adapters, except for the default net_http one, have been moved out of Faraday into separate gems. This means if you're not using the default adapter and you migrate to Faraday v2, you'll need to add the adapter gems to your Gemfile.
These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based:
# HTTPCLient
gem 'faraday-httpclient'
# NetHTTPPersistent
gem 'faraday-net_http_persistent'
# Patron
gem 'faraday-patron'
# Typhoeus
gem 'faraday-typhoeus'
Things should work fine if you migrate to Faraday 2 as long as you include the adapter (unless you're using the default one net-http), but worst case scenario, you can always lock the version of Faraday in your project to 1.x:
gem 'faraday', '~> 1'
Be aware if migrating to Faraday v2 that it requires at least Ruby 2.6, unlike Faraday v1 which requires 2.4.
Troubleshooting
If you see a message like:
:adapter is not registered on Faraday::Adapter (Faraday::Error)
Then you probably need to include the adapter library in your gemfile and require it.
Please submit an issue if you encounter any problems.
elastic-transport: #66 - Manticore transport unable to send custom headers with perform_request Pull Request.fleet.delete_secret
fleet.get_secret
fleet.post_secret
security.get_settings - Retrieve settings for the security system indicessecurity.update_settings - Update settings for the security system indicesquery_ruleset.list List query rulesets.indices.reload_search_analyzers - Adds parameter resource changed resource to reload analyzers from if applicablePromoted from Experimental to Beta:
security.create_cross_cluster_api_key
security.update_cross_cluster_api_key
All synonym related APIs have been moved to the synonyms namespace and some of the endpoints have been renamed, as well as their parameters:
synonyms.delete => synonyms.delete_synonym - requires id, the id of the synonyms set to be deleted.synonyms.get => synonyms.get_synonym - requires id, the name of the synonyms set to be retrieved.synonyms_set.get_synonyms_sets => synonyms.get_synonyms_sets
synonyms.put => synonyms.put_synonym - requires id of the synonyms set to be created or updated.synonym_rule.put => synonyms.put_synonym_rule - Parameters changed to set_id (the id of the synonym set to be updated with the synonym rule) and rule_id (the id of the synonym rule to be updated or created).synonyms.delete_synonym_rule - Deletes a synonym rule in a synonym setsynonyms.get_synonym_rule - Retrieves a synonym rule from a synonym set