Package org.apache.skywalking.oap.server.library.client.elasticsearch

Class ElasticSearchClient

java.lang.Object

org.apache.skywalking.oap.server.library.client.elasticsearch.ElasticSearchClient

All Implemented Interfaces:

Client, HealthCheckable

public class ElasticSearchClient
extends Object
implements Client, HealthCheckable

ElasticSearchClient connects to the ES server by using ES client APIs.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE

Constructor Summary

Constructors

Constructor	Description
ElasticSearchClient(String clusterNodes, String protocol, String trustStorePath, String trustStorePass, String user, String password, Function<String,String> indexNameConverter, int connectTimeout, int socketTimeout, int responseTimeout, int numHttpClientThread)
ElasticSearchClient(String clusterNodes, String protocol, String trustStorePath, Function<String,String> indexNameConverter, int connectTimeout, int socketTimeout, int responseTimeout, int numHttpClientThread)

Method Summary

Modifier and Type	Method	Description
void	connect()
BulkProcessor	createBulkProcessor(int bulkActions, int flushInterval, int concurrentRequests, int batchOfBytes)
boolean	createIndex(String indexName)
boolean	createIndex(String indexName, Mappings mappings, Map<String,?> settings)
boolean	createOrUpdateTemplate(String indexName, Map<String,Object> settings, Mappings mapping, int order)
boolean	deleteByIndexName(String indexName)	If your indexName is retrieved from elasticsearch through retrievalIndexByAliases(String) or some other method and it already contains namespace.
boolean	deleteScrollContextQuietly(String scrollId)
boolean	deleteTemplate(String indexName)
boolean	existDoc(String indexName, String id)
void	forceInsert(String indexName, String id, Map<String,Object> source)
void	forceUpdate(String indexName, String id, Map<String,Object> source)
String	formatIndexName(String indexName)
Optional<Document>	get(String indexName, String id)
Optional<Index>	getIndex(String indexName)
Optional<IndexTemplate>	getTemplate(String name)
Optional<Documents>	ids(Map<String,List<String>> indexIds)	Provide to get documents from multi indices by IDs.
boolean	isExistsIndex(String indexName)
boolean	isExistsTemplate(String indexName)
IndexRequestWrapper	prepareInsert(String indexName, String id, Map<String,Object> source)
IndexRequestWrapper	prepareInsert(String indexName, String id, Optional<String> routingValue, Map<String,Object> source)
UpdateRequestWrapper	prepareUpdate(String indexName, String id, Map<String,Object> source)
void	registerChecker(HealthChecker healthChecker)	Register health checker.
Collection<String>	retrievalIndexByAliases(String alias)
SearchResponse	scroll(Duration contextRetention, String scrollId)
SearchResponse	search(String indexName, Search search)
SearchResponse	search(String indexName, Search search, SearchParams params)
SearchResponse	search(Supplier<String[]> indices, Search search)
SearchResponse	searchIDs(String indexName, Iterable<String> ids)	Search by ids with index alias, when can not locate the physical index.
void	setPassword(String password)
void	setTrustStorePass(String trustStorePass)
void	setUser(String user)
void	shutdown()
boolean	updateIndexMapping(String indexName, Mappings mapping)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

ElasticSearchClient

public ElasticSearchClient(String clusterNodes,
                           String protocol,
                           String trustStorePath,
                           String trustStorePass,
                           String user,
                           String password,
                           Function<String,String> indexNameConverter,
                           int connectTimeout,
                           int socketTimeout,
                           int responseTimeout,
                           int numHttpClientThread)

ElasticSearchClient

public ElasticSearchClient(String clusterNodes,
                           String protocol,
                           String trustStorePath,
                           Function<String,String> indexNameConverter,
                           int connectTimeout,
                           int socketTimeout,
                           int responseTimeout,
                           int numHttpClientThread)

Method Detail

connect

public void connect()

Specified by:

connect in interface Client

shutdown

public void shutdown()

Specified by:

shutdown in interface Client

registerChecker

public void registerChecker(HealthChecker healthChecker)

Description copied from interface: HealthCheckable

Register health checker.

Specified by:

registerChecker in interface HealthCheckable

Parameters:

healthChecker - HealthChecker to be registered.

createIndex

public boolean createIndex(String indexName)

createIndex

public boolean createIndex(String indexName,
                           Mappings mappings,
                           Map<String,?> settings)

updateIndexMapping

public boolean updateIndexMapping(String indexName,
                                  Mappings mapping)

getIndex

public Optional<Index> getIndex(String indexName)

retrievalIndexByAliases

public Collection<String> retrievalIndexByAliases(String alias)

deleteByIndexName

public boolean deleteByIndexName(String indexName)

If your indexName is retrieved from elasticsearch through retrievalIndexByAliases(String) or some other method and it already contains namespace. Then you should delete the index by this method, this method will no longer concatenate namespace. https://github.com/apache/skywalking/pull/3017

isExistsIndex

public boolean isExistsIndex(String indexName)

getTemplate

public Optional<IndexTemplate> getTemplate(String name)

isExistsTemplate

public boolean isExistsTemplate(String indexName)

createOrUpdateTemplate

public boolean createOrUpdateTemplate(String indexName,
                                      Map<String,Object> settings,
                                      Mappings mapping,
                                      int order)

deleteTemplate

public boolean deleteTemplate(String indexName)

search

public SearchResponse search(Supplier<String[]> indices,
                             Search search)

search

public SearchResponse search(String indexName,
                             Search search)

search

public SearchResponse search(String indexName,
                             Search search,
                             SearchParams params)

scroll

public SearchResponse scroll(Duration contextRetention,
                             String scrollId)

deleteScrollContextQuietly

public boolean deleteScrollContextQuietly(String scrollId)

get

public Optional<Document> get(String indexName,
                              String id)

existDoc

public boolean existDoc(String indexName,
                        String id)

ids

public Optional<Documents> ids(Map<String,List<String>> indexIds)

Provide to get documents from multi indices by IDs.

Parameters:

indexIds - key: indexName, value: ids list

Returns:

Documents

Since:

9.2.0

searchIDs

public SearchResponse searchIDs(String indexName,
                                Iterable<String> ids)

Search by ids with index alias, when can not locate the physical index. Otherwise, recommend use method ids(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

Parameters:

indexName - Index alias name or physical name

ids - ID list

Returns:

SearchResponse

Since:

9.2.0 this method was ids

forceInsert

public void forceInsert(String indexName,
                        String id,
                        Map<String,Object> source)

forceUpdate

public void forceUpdate(String indexName,
                        String id,
                        Map<String,Object> source)

prepareInsert

public IndexRequestWrapper prepareInsert(String indexName,
                                         String id,
                                         Map<String,Object> source)

prepareInsert

public IndexRequestWrapper prepareInsert(String indexName,
                                         String id,
                                         Optional<String> routingValue,
                                         Map<String,Object> source)

prepareUpdate

public UpdateRequestWrapper prepareUpdate(String indexName,
                                          String id,
                                          Map<String,Object> source)

createBulkProcessor

public BulkProcessor createBulkProcessor(int bulkActions,
                                         int flushInterval,
                                         int concurrentRequests,
                                         int batchOfBytes)

formatIndexName

public String formatIndexName(String indexName)

setTrustStorePass

public void setTrustStorePass(String trustStorePass)

setUser

public void setUser(String user)

setPassword

public void setPassword(String password)