Skip to content

Add support for Elasticsearch Sniffer #24340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Add support for Elasticsearch Sniffer #24340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7fd39a
Provide out-of-the-box support for Elasticsearch Sniffer #24174
somayaj Dec 5, 2020
5abf542
Fixes per review.
somayaj Dec 21, 2020
9ca5436
Fixes per review.
somayaj Dec 22, 2020
c7932c3
Fixes per review.
somayaj Dec 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spring-boot-project/spring-boot-autoconfigure/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ dependencies {
optional("org.eclipse.jetty.websocket:javax-websocket-server-impl")
optional("org.ehcache:ehcache")
optional("org.elasticsearch.client:elasticsearch-rest-client")
optional("org.elasticsearch.client:elasticsearch-rest-client-sniffer")
optional("org.elasticsearch.client:elasticsearch-rest-high-level-client")
optional("org.flywaydb:flyway-core")
optional("org.freemarker:freemarker")
Expand Down
15 changes: 15 additions & 0 deletions ...gframework/boot/autoconfigure/elasticsearch/ElasticsearchRestClientAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestClientBuilder;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.client.sniff.Sniffer;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
Expand Down Expand Up @@ -80,6 +81,20 @@ RestClientBuilder elasticsearchRestClientBuilder(ElasticsearchRestClientProperti
return builder;
}

@Bean
@ConditionalOnClass(name = "org.elasticsearch.client.sniff.Sniffer")
@ConditionalOnMissingBean(RestHighLevelClient.class)
Sniffer elasticsearchSniffer(ElasticsearchRestClientProperties properties) {
RestClient restClient = new RestHighLevelClient(this.elasticsearchRestClientBuilder(properties, null))
.getLowLevelClient();
return Sniffer.builder(restClient)
.setSniffIntervalMillis(
Math.toIntExact(ElasticsearchRestClientProperties.Sniffer.getSniffInterval().toMillis()))
.setSniffAfterFailureDelayMillis(
Math.toIntExact(ElasticsearchRestClientProperties.Sniffer.getSniffInterval().toMillis()))
.build();
}

private HttpHost createHttpHost(String uri) {
try {
return createHttpHost(URI.create(uri));
Expand Down
35 changes: 35 additions & 0 deletions ...g/springframework/boot/autoconfigure/elasticsearch/ElasticsearchRestClientProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,39 @@ public void setReadTimeout(Duration readTimeout) {
this.readTimeout = readTimeout;
}

/**
* Sniffer specific properties.
*/
public static class Sniffer {

private Duration readTimeout = Duration.ofSeconds(30);

/**
* Sniffer interval.
*/
private static Duration sniffInterval = Duration.ofMinutes(5L);

/**
* Sniffer failure delay.
*/
private static Duration sniffFailureDelay = Duration.ofMinutes(1L);

public static Duration getSniffInterval() {
return sniffInterval;
}

public void setSniffInterval(Duration sniffInterval) {
Sniffer.sniffInterval = sniffInterval;
}

public static Duration getSniffFailureDelay() {
return sniffFailureDelay;
}

public void setSniffFailureDelay(Duration sniffFailureDelay) {
Sniffer.sniffFailureDelay = sniffFailureDelay;
}

}

}
70 changes: 57 additions & 13 deletions ...ework/boot/autoconfigure/elasticsearch/ElasticsearchRestClientAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@

package org.springframework.boot.autoconfigure.elasticsearch;

import java.time.Duration;
import java.util.HashMap;
import java.util.Map;

import org.apache.http.HttpHost;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.Credentials;
Expand All @@ -29,21 +25,22 @@
import org.assertj.core.api.InstanceOfAssertFactories;
import org.elasticsearch.action.get.GetRequest;
import org.elasticsearch.action.index.IndexRequest;
import org.elasticsearch.client.Node;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestClientBuilder;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.client.*;
import org.elasticsearch.client.sniff.Sniffer;
import org.junit.Assert;
import org.junit.jupiter.api.Test;
import org.testcontainers.elasticsearch.ElasticsearchContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.boot.testsupport.testcontainers.DockerImageNames;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.testcontainers.elasticsearch.ElasticsearchContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import java.time.Duration;
import java.util.HashMap;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
Expand Down Expand Up @@ -220,6 +217,53 @@ void configureUriWithUsernameAndPasswordWhenUsernameAndPasswordPropertiesSet() {
});
}

@Test
void configureShouldOnlyCreateSnifferInstance() {
this.contextRunner.run((context) -> {
assertThat(context).hasSingleBean(Sniffer.class);
assertThat(context).doesNotHaveBean(RestClient.class).hasSingleBean(RestHighLevelClient.class);
});
}

@Test
void configureShouldHaveSnifferInstance() {
this.contextRunner.run((context) -> {
assertThat(context).hasSingleBean(Sniffer.class);
assertThat(context).doesNotHaveBean(RestClient.class).hasSingleBean(RestHighLevelClient.class);
Assert.assertNotNull(context.getBean(Sniffer.class));
});
}

@Test
void configureWithCustomSetIntervalProperties() {
this.contextRunner.withPropertyValues(
"spring.elasticsearch.rest.sniffInterval=1m, " + "spring.elasticsearch.rest.sniffFailureDelay=1m")
.run((context) -> {
Assert.assertNotNull(context.getBean(Sniffer.class));
assertThat(context).hasSingleBean(RestHighLevelClient.class);
RestHighLevelClient restClient = context.getBean(RestHighLevelClient.class);
assertThat(restClient.getLowLevelClient()).extracting("spring.elasticsearch.rest.sniffInterval")
.isEqualTo(Math.toIntExact(Duration.ofMinutes(1L).toMillis()));
assertThat(restClient.getLowLevelClient()).extracting("spring.elasticsearch.rest.sniffFailureDelay")
.isEqualTo(Math.toIntExact(Duration.ofMinutes(1L).toMillis()));
});
}

@Test
void configureWithNoAutoConfigurationPropertySet() {
this.contextRunner.run((context) -> {
assertThat(context).doesNotHaveBean(Sniffer.class);
Assert.assertNull(context.getBean(Sniffer.class));
});
}

@Test
void configureWhenCustomSnifferWhenPresent() {
this.contextRunner.withBean("customSniffer", Sniffer.class, () -> mock(Sniffer.class))
.run((context) -> assertThat(context).hasSingleBean(RestHighLevelClient.class)
.hasSingleBean(Sniffer.class).hasBean("customSniffer"));
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two tests are missing here.

One that assert what happens when the library is not on the classpath, as I've indicated in my previous review.

One that assert that a custom Sniffer instance is used rather creating one here. This custom instance should probably have a dependency on the high level client we auto-configure to make this a bit more realistic.

@Configuration(proxyBeanMethods = false)
static class BuilderCustomizerConfiguration {

Expand Down