Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Auto-configure Elasticsearch REST clients

Browse Source 
This commit adds auto-configuration support for both `RestClient` and
`RestHighLevelClient` which are provided by `elasticsearch-rest-client`
and `elasticsearch-rest-high-level-client` dependencies respectively.

`RestClient` is associated with configuration properties in the
`spring.elasticsearch.rest.*` namespace, since this is the component
taking care of HTTP communication with the actual Elasticsearch node.

`RestHighLevelClient` wraps the first one and naturally inherits that
configuration.

Closes gh-12600
This commit is contained in:
Brian Clozel
2018-05-07 17:57:09 +02:00
parent 43ef5ba205
commit 84c9a65e9d
12 changed files with 429 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
View File

@@ -717,6 +717,11 @@ content into your application. Rather, pick only the properties that you need.
spring.elasticsearch.jest.uris=http://localhost:9200 # Comma-separated list of the Elasticsearch instances to use.
spring.elasticsearch.jest.username= # Login username.
# Elasticsearch REST clients ({sc-spring-boot-autoconfigure}/elasticsearch/rest/RestClientProperties.{sc-ext}[RestClientProperties])
spring.elasticsearch.rest.password= # Credentials username.
spring.elasticsearch.rest.uris=http://localhost:9200 # Comma-separated list of the Elasticsearch instances to use.
spring.elasticsearch.rest.username= # Credentials password.
# H2 Web Console ({sc-spring-boot-autoconfigure}/h2/H2ConsoleProperties.{sc-ext}[H2ConsoleProperties])
spring.h2.console.enabled=false # Whether to enable the console.
spring.h2.console.path=/h2-console # Path at which the console is available.

45
spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
View File

@@ -4221,14 +4221,45 @@ https://projects.spring.io/spring-data-solr/[reference documentation].
[[boot-features-elasticsearch]]
=== Elasticsearch
http://www.elasticsearch.org/[Elasticsearch] is an open source, distributed, real-time
search and analytics engine. Spring Boot offers basic auto-configuration for
Elasticsearch and the abstractions on top of it provided by
https://github.com/spring-projects/spring-data-elasticsearch[Spring Data Elasticsearch].
There is a `spring-boot-starter-data-elasticsearch` "`Starter`" for collecting the
dependencies in a convenient way. Spring Boot also supports
https://github.com/searchbox-io/Jest[Jest].
https://www.elastic.co/products/elasticsearch[Elasticsearch] is an open source,
distributed, RESTful search and analytics engine. Spring Boot offers basic
auto-configuration for Elasticsearch.
Spring Boot supports several HTTP clients:
* The official Java "Low Level" and "High Level" REST clients
* https://github.com/searchbox-io/Jest[Jest]
The transport client is still being used by
https://github.com/spring-projects/spring-data-elasticsearch[Spring Data Elasticsearch],
which you can start using with the `spring-boot-starter-data-elasticsearch` "`Starter`".
[[boot-features-connecting-to-elasticsearch-rest]]
==== Connecting to Elasticsearch by REST clients
Elasticsearch ships
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/index.html[two different REST clients]
that you can use to query a cluster: the "Low Level" client and the "High Level" client.
If you have the `org.elasticsearch.client:elasticsearch-rest-client` dependency on the
classpath, Spring Boot will auto-configure and register a `RestClient` bean that
by default targets `http://localhost:9200`.
You can further tune how `RestClient` is configured, as shown in the following example:
[source,properties,indent=0]
----
spring.elasticsearch.rest.uris=http://search.example.com:9200
spring.elasticsearch.rest.username=user
spring.elasticsearch.rest.password=secret
----
You can also register an arbitrary number of beans that implement
`RestClientBuilderCustomizer` for more advanced customizations.
To take full control over the registration, define a `RestClient` bean.
If you have the `org.elasticsearch.client:elasticsearch-rest-high-level-client` dependency
on the classpath, Spring Boot will auto-configure a `RestHighLevelClient`, which wraps
any existing `RestClient` bean, reusing its HTTP configuration.
[[boot-features-connecting-to-elasticsearch-jest]]